CampaignExcludedAudienceSelector

Enthält die Methoden zum Filtern und Sortieren einer Liste von Zielgruppen, die von Kampagnen ausgeschlossen wurden. Informationen zu Selektoren finden Sie unter Selektoren.

Anwendungsbeispiel:

    // Gets the iterator that iterates all campaigns
    // in the account.
    var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get();

    // Loops through all campaigns in the account.
    while (iterator.hasNext()) {
        var campaign = iterator.next();

        // Gets the iterator that iterates all campaign excluded audiences
        // in the campaign excluded audience.
        var audienceIterator = campaign.targeting().excludedAudiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign excluded audiences in the campaign excluded audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

Methoden

Methodenname Rückgabetyp Beschreibung
get CampaignExcludedAudienceIterator Ruft einen Iterator ab, der zum Durchlaufen der Liste der von der Kampagne ausgeschlossenen Zielgruppen verwendet wird.
orderBy(string orderBy) CampaignExcludedAudienceSelector Wendet die angegebene Reihenfolge auf die ausgewählten von der Kampagne ausgeschlossenen Zielgruppen an.
withCondition(string condition) CampaignExcludedAudienceSelector Wendet Filterkriterien auf die von der Kampagne ausgeschlossenen Zielgruppen an.
withIds(string[] ids) CampaignExcludedAudienceSelector Ruft von der Kampagne ausgeschlossene Zielgruppen mit den angegebenen IDs ab.
withLimit(int limit) CampaignExcludedAudienceSelector Ruft die Top N von der Kampagne ausgeschlossenen Zielgruppen ab, die den Auswahlkriterien entsprechen.

Abrufen

Ruft einen Iterator ab, der zum Durchlaufen der Liste der von der Kampagne ausgeschlossenen Zielgruppen verwendet wird.

Rückgabewerte

Typ Beschreibung
CampaignExcludedAudienceIterator Ein Iterator, der zum Durchlaufen der ausgewählten von der Kampagne ausgeschlossenen Zielgruppen verwendet wird.

orderBy(String orderBy)

Wendet die angegebene Reihenfolge auf die ausgewählten von der Kampagne ausgeschlossenen Zielgruppen an.

Geben Sie den Parameter orderBy im Format "columnName orderDirection" an, wobei:

  • columnName ist eine der unterstützten Spalten.
  • orderDirection ist die Reihenfolge, in der die Ergebnisse sortiert werden sollen. Legen Sie die Option auf ASC fest, um die Ergebnisse in aufsteigender Reihenfolge zu sortieren, oder auf DESC, um sie in absteigender Reihenfolge zu sortieren. Der Standardwert ist ASC.

Der folgende Aufruf gibt beispielsweise von Kampagnen ausgeschlossene Zielgruppen in aufsteigender Reihenfolge nach AverageCpc zurück.

selector = selector.orderBy("AverageCpc");

Selektoren unterstützen die Sortierung von Entitäten nach nur einem Feld. Sie dürfen die Liste der Entitäten nicht nach dem Feld x und innerhalb von x nach dem Feld y usw. ordnen. Wenn Sie mehr als einen orderBy() Aufruf in einer Kette oder in separaten Selektoraufrufen angeben, sortiert Scripts die Liste der Entitäten mithilfe des im letzten orderBy() Aufruf angegebenen Felds. 

Argumente

Name Typ Beschreibung
orderBy string Die anzuwendende Reihenfolge.

Rückgabewerte

Typ Beschreibung
CampaignExcludedAudienceSelector Selektor mit angewendeter Reihenfolge.

withCondition(String condition)

Wendet Filterkriterien auf die von der Kampagne ausgeschlossenen Zielgruppen an.

Geben Sie den Bedingungsparameter im Format "Wert des Operators columnName" an, wobei:

Operatoren

Der Operator, den Sie verwenden, hängt vom Typ der Spalte ab. Bei Operatoren wird die Groß-/Kleinschreibung beachtet. Verwenden Sie beispielsweise STARTS_WITH anstelle von starts_with.

Operatoren für Spalten, die ganze Zahlen und lange Werte enthalten:

<
<=
>
>=
=
!=

Operatoren für Spalten, die doppelte Werte enthalten:

<
>

Operatoren für Spalten, die Zeichenfolgenwerte enthalten:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Operatoren für Spalten, die Enumerationswerte enthalten:

=
!=
IN []
NOT_IN []

Operatoren für Spalten, die ein Array von Zeichenfolgen enthalten:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Unterstützte Spalten

Unterstützte Spalten für die Filterung ausgeschlossener Zielgruppen von Kampagnen. Bei den Namen wird zwischen Groß- und Kleinschreibung unterschieden.

Im Folgenden finden Sie die Entitätseigenschaften, die Sie angeben können.

Spalte Typ Beispiel
Zielgruppen-ID long Die ID der zugehörigen Zielgruppe.

withCondition("AudienceId = 123456789")
CampaignName string Der Name der Kampagne der Vereinigung.

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus Aufzählung Der Status der Kampagne der Vereinigung. Mögliche Werte für die Groß- und Kleinschreibung sind:
  • AKTIVIERT
  • ANGEHALTEN
  • ENTFERNT
In diesem Beispiel werden nur von Kampagnen ausgeschlossene Zielgruppen zurückgegeben, deren übergeordnete Kampagne pausiert ist.

withCondition("CampaignStatus = PAUSED")
Status Aufzählung Der Status der Vereinigung. Mögliche Werte für die Groß- und Kleinschreibung sind:
  • AKTIVIERT
  • ANGEHALTEN
  • ENTFERNT
In diesem Beispiel werden nur aktivierte, von der Kampagne ausgeschlossene Zielgruppen zurückgegeben.

withCondition("Status = ENABLED")
UserListName string Der Name der zugeordneten Zielgruppe.

withCondition("UserListName = 'foo'")

Argumente

Name Typ Beschreibung
Bedingung string Die Bedingung, die auf den Selektor angewendet werden soll.

Rückgabewerte

Typ Beschreibung
CampaignExcludedAudienceSelector Selector mit der angewendeten Bedingung.

withIds(string[] ids)

Ruft von der Kampagne ausgeschlossene Zielgruppen mit den angegebenen IDs ab.

Sie können eine oder mehrere Bedingungen auf einen Selektor anwenden. Eine Kette von Bedingungen wird als UND-Vorgang betrachtet. Beispielsweise wird das Objekt nur ausgewählt, wenn Bedingung A wahr UND Bedingung B wahr ist. Der folgende Aufruf wählt beispielsweise nur die von der Kampagne ausgeschlossene Zielgruppe 33333 aus.

var selector = AdsApp.adGroups()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Argumente

Name Typ Beschreibung
ids string[] Ein Array mit von der Kampagne ausgeschlossenen Zielgruppen-IDs. Informationen zu Grenzwerten finden Sie unter Skriptausführungslimits.

Rückgabewerte

Typ Beschreibung
CampaignExcludedAudienceSelector Selector mit den angewendeten IDs.

withLimit(int limit)

Ruft die Top N von der Kampagne ausgeschlossenen Zielgruppen ab, die den Auswahlkriterien entsprechen.

Argumente

Name Typ Beschreibung
Begrenzung int Die Anzahl der von der Kampagne ausgeschlossenen Zielgruppen, die zurückgegeben werden sollen. Die tatsächliche Anzahl kann geringer sein.

Rückgabewerte

Typ Beschreibung
CampaignExcludedAudienceSelector Selektor mit angewendetem Grenzwert.