Freigeben über

CampaignExcludedAudienceSelector

  • Artikel

Enthält die Methoden zum Filtern und Sortieren einer Liste der durch die Kampagne ausgeschlossenen Zielgruppen. 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 durch die Kampagne ausgeschlossenen Zielgruppen verwendet wird.
orderBy(string orderBy) CampaignExcludedAudienceSelector Wendet die angegebene Reihenfolge auf die ausgeschlossenen Zielgruppen der ausgewählten Kampagne an.
withCondition(string condition) CampaignExcludedAudienceSelector Wendet Filterkriterien auf die ausgeschlossenen Zielgruppen der Kampagne an.
withIds(string[] ids) CampaignExcludedAudienceSelector Ruft die ausgeschlossenen Zielgruppen der Kampagne mit den angegebenen IDs ab.
withLimit(int limit) CampaignExcludedAudienceSelector Ruft die höchsten n ausgeschlossenen Zielgruppen der Kampagne ab, die den Auswahlkriterien entsprechen.

Erhalten

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

Rückgabewerte

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

orderBy(String orderBy)

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

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

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

Der folgende Aufruf gibt beispielsweise durch die Kampagne ausgeschlossene Zielgruppen in aufsteigender Reihenfolge nach AverageCpc zurück.

selector = selector.orderBy("AverageCpc");

Selektoren unterstützen das Sortieren von Entitäten nur nach einem Feld. Sie dürfen die Liste der Entitäten nicht nach Feld x und innerhalb von x nach Feld y usw. sortieren. 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 ausgeschlossenen Zielgruppen der Kampagne an.

Geben Sie den Bedingungsparameter im Format "columnName-Operatorwert" 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 in der Kampagne. Bei den Namen wird die Groß-/Kleinschreibung beachtet.

Im Folgenden sind die Entitätseigenschaften aufgeführt, die Sie angeben können.

Spalte Typ Beispiel
AudienceId long Die ID der zugeordneten Zielgruppe.

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

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus Enumeration Die status der Kampagne des Vereins. Mögliche Werte, bei denen die Groß-/Kleinschreibung beachtet wird, sind:
  • AKTIVIERT
  • ANGEHALTEN
  • ENTFERNT
In diesem Beispiel werden nur kampagnen-ausgeschlossene Zielgruppen zurückgegeben, deren übergeordnete Kampagne angehalten ist.

withCondition("CampaignStatus = PAUSED")
Status Enumeration Die status der Zuordnung. Mögliche Werte, bei denen die Groß-/Kleinschreibung beachtet wird, sind:
  • AKTIVIERT
  • ANGEHALTEN
  • ENTFERNT
In diesem Beispiel werden nur aktivierte Kampagnen ausgeschlossene Zielgruppen zurückgegeben.

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

withCondition("UserListName = 'foo'")

Argumente

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

Rückgabewerte

Typ Beschreibung
CampaignExcludedAudienceSelector Selektor mit angewendeter Bedingung.

withIds(string[] ids)

Ruft die ausgeschlossenen Zielgruppen der Kampagne mit den angegebenen IDs ab.

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

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

Argumente

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

Rückgabewerte

Typ Beschreibung
CampaignExcludedAudienceSelector Selektor mit den angewendeten IDs.

withLimit(int limit)

Ruft die höchsten n ausgeschlossenen Zielgruppen der Kampagne ab, die den Auswahlkriterien entsprechen.

Argumente

Name Typ Beschreibung
Begrenzung int Die Anzahl der zurückzugebenden Zielgruppen, die für die Kampagne ausgeschlossen sind. Die tatsächliche Zahl kann kleiner sein.

Rückgabewerte

Typ Beschreibung
CampaignExcludedAudienceSelector Selektor mit angewendetem Limit.