CampaignAudienceSelector

Artikel
11/13/2024

Enthält die Methoden zum Filtern und Sortieren einer Liste von Kampagnenzielgruppen. 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 audiences
        // in the campaign audience.
        var audienceIterator = campaign.targeting().audiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign audiences in the campaign audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

Methoden

Methodenname	Rückgabetyp	Beschreibung
forDateRange(Object dateFrom, Object dateTo)	CampaignAudienceSelector	Wendet das Start- und Enddatum für die Auswahl von Leistungsmetriken an.
forDateRange(string dateRange)	CampaignAudienceSelector	Wendet den vordefinierten Datumsbereich für die Auswahl von Leistungsmetriken an.
get	CampaignAudienceIterator	Ruft einen Iterator ab, der zum Durchlaufen der Liste der Kampagnengruppen verwendet wird.
orderBy(string orderBy)	CampaignAudienceSelector	Wendet die angegebene Reihenfolge auf die ausgewählten Kampagnengruppen an.
withCondition(string condition)	CampaignAudienceSelector	Wendet Filterkriterien auf die Kampagnenzielgruppen an.
withIds(string[] ids)	CampaignAudienceSelector	Ruft Kampagnengruppen mit den angegebenen IDs ab.
withLimit(int limit)	CampaignAudienceSelector	Ruft die obersten n Kampagnengruppen ab, die den Auswahlkriterien entsprechen.

forDateRange(Object dateFrom, Object dateTo)

Wendet das Start- und Enddatum für die Auswahl von Leistungsmetriken an.

Geben Sie einen Datumsbereich nur an, wenn:

Sie wenden Bedingungen oder Reihenfolgen an, die auf Leistungsmetrikfelder verweisen.
Sie möchten Leistungsdaten für die objekte abrufen, die Sie auswählen. Beispielsweise, wenn Sie planen, die getStats() -Methode aufzurufen.

Sie können die Datumsparameter mithilfe von Zeichenfolgen oder Objekten angeben. Um Zeichenfolgen zu verwenden, geben Sie das Datum im Formular YYYYMMDD an. Wenn Sie -Objekte verwenden, erstellen Sie ein -Objekt mit den folgenden Feldern:

Jahr
Monat
Tag

Zum Beispiel:

var date = {year: 2018, month: 5, day: 13};

Der Monat ist einsbasiert, wobei 1 für Januar und 12 für Dezember steht.

Der Datumsbereich ist inklusiv. Wenn Sie mehrere Datumsbereiche angeben, wird nur der letzte Datumsbereich verwendet.

Argumente

Name	Typ	Beschreibung
dateFrom	Objekt	Das Startdatum des Datumsbereichs, der die Leistungsdaten angibt, die in die Auswahl eingeschlossen werden sollen. Geben Sie das Datum mithilfe einer Zeichenfolge im Formular JJJJMMDD oder einem Objekt im Formular {year: 2020, month: 12, day: 31} an.
dateTo	Objekt	Das Enddatum des Datumsbereichs, der die Leistungsdaten angibt, die in die Auswahl eingeschlossen werden sollen. Geben Sie das Datum mithilfe einer Zeichenfolge im Formular JJJJMMDD oder einem Objekt im Formular {year: 2020, month: 12, day: 1} an.

Rückgabewerte

Typ	Beschreibung
CampaignAudienceSelector	Selektor mit angewendetem Datumsbereich.

forDateRange(String dateRange)

Wendet den vordefinierten Datumsbereich für die Auswahl von Leistungsmetriken an.

Geben Sie einen Datumsbereich nur an, wenn:

Sie wenden Bedingungen oder Reihenfolgen an, die auf Leistungsmetrikfelder verweisen.
Sie möchten Leistungsdaten für die objekte abrufen, die Sie auswählen. Beispielsweise, wenn Sie planen, die getStats() -Methode aufzurufen.

Wenn Sie mehrere Datumsbereiche angeben, wird nur der letzte Datumsbereich verwendet.

Unterstützte Datumsbereichswerte:

HEUTE
GESTERN
LAST_WEEK
LAST_BUSINESS_WEEK
LAST_7_DAYS
THIS_WEEK_SUN_TODAY
LAST_14_DAYS
LAST_30_DAYS
LAST_WEEK_SUN_SAT
THIS_MONTH
LAST_MONTH
ALL_TIME

Argumente

Name	Typ	Beschreibung
dateRange	Zeichenfolge	Die vordefinierte Datumsbereichszeichenfolge, die die Leistungsdaten angibt, die in die Auswahl eingeschlossen werden sollen. Bei der vordefinierten Datums-/Bereichszeichenfolge wird die Groß-/Kleinschreibung beachtet. Mögliche Werte, bei denen die Groß-/Kleinschreibung beachtet wird, sind: TODAY, YESTERDAY, LAST_WEEK, LAST_BUSINESS_WEEK, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_14_DAYS, LAST_30_DAYS, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME.

Rückgabewerte

Typ	Beschreibung
CampaignAudienceSelector	Selektor mit angewendetem Datumsbereich.

Erhalten

Ruft einen Iterator ab, der zum Durchlaufen der Liste der Kampagnengruppen verwendet wird.

Rückgabewerte

Typ	Beschreibung
CampaignAudienceIterator	Ein Iterator, der verwendet wird, um die ausgewählten Kampagnengruppen zu durchlaufen.

orderBy(String orderBy)

Wendet die angegebene Reihenfolge auf die ausgewählten Kampagnengruppen 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 Kampagnengruppen 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
CampaignAudienceSelector	Selektor mit angewendeter Reihenfolge.

withCondition(String condition)

Wendet Filterkriterien auf die Kampagnenzielgruppen an.

Geben Sie den Bedingungsparameter im Format "columnName-Operatorwert" an, wobei:

columnName ist eine der unterstützten Spalten. Wenn columName auf einen Namen der Leistungsmetrikspalte festgelegt ist, müssen Sie einen Datumsbereich mithilfe von forDateRange(String dateRange) oder forDateRange(Object dateFrom, Object dateTo) angeben.
operator ist einer der unterstützten Operatoren.

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 der Kampagnenzielgruppe. Bei den Namen wird die Groß-/Kleinschreibung beachtet.

Im Folgenden sind die Leistungsmetrikspalten aufgeführt, die Sie angeben können.

Spalte	Typ	Beispiel
AbsoluteTopImpressionRate	double	`withCondition("AbsoluteTopImpressionRate > 0.25")`
AverageCpc	double	`withCondition("AverageCpc < 2.75")`
AverageCpm	double	`withCondition("AverageCpm > 0.65")`
ClickConversionRate	double	`withCondition("ClickConversionRate > 0.25")`
Klicks	long	`withCondition("Clicks >= 33")`
ConvertedClicks	long	`withCondition("ConvertedClicks >= 10")`
Kosten	double	`withCondition("Cost > 3.25")` Die Kosten werden in der Währung des Kontos angegeben.
Ctr	double	`withCondition("Ctr > 0.05")` Die CTR liegt im Bereich 0,.1. Verwenden Sie daher 0,05 für eine CtR von 5 %.
Eindrücke	long	`withCondition("Impressions > 10")`
TopImpressionRate	double	`withCondition("TopImpressionRate > 0.25")`

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 Kampagnengruppen 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 Kampagnengruppen 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
CampaignAudienceSelector	Selektor mit angewendeter Bedingung.

withIds(string[] ids)

Ruft Kampagnengruppen 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 Kampagnenzielgruppe 33333 aus.

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

Argumente

Name	Typ	Beschreibung
ids	string[]	Eine Reihe von Kampagnenzielgruppen-IDs. Informationen zu Grenzwerten finden Sie unter Skriptausführungslimits.

Rückgabewerte

Typ	Beschreibung
CampaignAudienceSelector	Selektor mit den angewendeten IDs.

withLimit(int limit)

Ruft die obersten n Kampagnengruppen ab, die den Auswahlkriterien entsprechen.

Argumente

Name	Typ	Beschreibung
Begrenzung	int	Die Anzahl der zurückzugebenden Kampagnengruppen. Die tatsächliche Zahl kann kleiner sein.

Rückgabewerte

Typ	Beschreibung
CampaignAudienceSelector	Selektor mit angewendetem Limit.

Freigeben über

CampaignAudienceSelector

Methoden

forDateRange(Object dateFrom, Object dateTo)

Argumente

Rückgabewerte

forDateRange(String dateRange)

Argumente

Rückgabewerte

Erhalten

Rückgabewerte

orderBy(String orderBy)

Argumente

Rückgabewerte

withCondition(String condition)

Operatoren

Unterstützte Spalten

Argumente

Rückgabewerte

withIds(string[] ids)

Argumente

Rückgabewerte

withLimit(int limit)

Argumente

Rückgabewerte

Feedback

Zusätzliche Ressourcen