CampaignSelector

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

Anwendungsbeispiel:

    var iterator = AdsApp.campaigns()
        .withCondition("ClickConversionRate > 0.3")
        .forDateRange("LAST_WEEK")
        .orderBy("Clicks DESC")
        .get();

    while (iterator.hasNext()) {
        var campaign = iterator.next();
        var metrics = campaign.getStats();
    }

Methoden

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

forDateRange(Object dateFrom, Object dateTo)

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

Geben Sie nur einen Datumsbereich an, wenn:

  • Sie wenden Bedingungen oder Reihenfolgen an, die auf Felder für Performance-Kennzahlen verweisen.
  • Sie möchten Leistungsdaten für die Objekte abrufen, die Sie auswählen. Beispielsweise, wenn Sie die getStats() Methode aufrufen möchten.

Sie können die Datumsparameter mithilfe von Zeichenfolgen oder Objekten angeben. Um Zeichenfolgen zu verwenden, geben Sie das Datum im Formular JJJJMMTT 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};

Es handelt sich um einen Monat, wobei 1 für Januar und 12 für Dezember steht.

Der Datumsbereich ist einschließlich Datum. 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 den Selektor aufgenommen werden sollen.
dateTo Objekt Das Enddatum des Datumsbereichs, der die Leistungsdaten angibt, die in den Selektor aufgenommen werden sollen.

Rückgabewerte

Typ Beschreibung
CampaignSelector Selektor mit angewendetem Datumsbereich.

forDateRange(string dateRange)

Wendet den vordefinierten Datumsbereich für die Auswahl von Performance-Kennzahlen an.

Unterstützte Datumsbereichswerte:

  • TODAY
  • 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

Geben Sie nur einen Datumsbereich an, wenn:

  • Sie wenden Bedingungen oder Reihenfolgen an, die auf Felder für Performance-Kennzahlen verweisen.
  • Sie möchten Leistungsdaten für die Objekte abrufen, die Sie auswählen. Beispielsweise, wenn Sie die getStats() Methode aufrufen möchten.

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

Argumente

Name Typ Beschreibung
dateRange Zeichenfolge Die vordefinierte Zeichenfolge für den Datumsbereich, die die Leistungsdaten angibt, die in den Selektor aufgenommen werden sollen. Bei der vordefinierten Datumsbereichszeichenfolge wird zwischen Groß- und Kleinschreibung unterschieden.

Rückgabewerte

Typ Beschreibung
CampaignSelector Selektor mit angewendetem Datumsbereich.

Abrufen

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

Rückgabewerte

Typ Beschreibung
CampaignIterator Ein Iterator, der zum Durchlaufen der ausgewählten Kampagnen verwendet wird.

orderBy(string orderBy)

Wendet die angegebene Reihenfolge auf die ausgewählten Kampagnen 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 z. B. Kampagnen 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
CampaignSelector Selektor mit angewendeter Reihenfolge.

withCondition(string condition)

Wendet den Filter auf die Liste der Kampagnenkampagnen 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 für die Kampagnenfilterung. Bei Spaltennamen wird die Groß-/Kleinschreibung beachtet.

Im Folgenden finden Sie die Spalten für Performance-Kennzahlen, 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.
STR double withCondition("Ctr > 0.05")

Die CTR liegt im Bereich von 0..1. Verwenden Sie also 0,05 für eine CTR von 5 %.
Eindrücke long withCondition("Impressions > 10")
TopImpressionRate double withCondition("TopImpressionRate > 0.25")

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

Spalte Typ Beispiel
Status Aufzählung Der Status der Kampagne. Mögliche Werte für die Groß- und Kleinschreibung sind:
  • AKTIVIERT
  • ANGEHALTEN
  • ENTFERNT
  • BUDGET_PAUSED
  • BUDGET_AND_USER_PAUSED
Dieses Beispiel gibt nur enabled enabled zurück.

withCondition("Status = ENABLED")
Name string Der Name der Kampagne.

withCondition("Name CONTAINS_IGNORE_CASE 'clearance'")
Budget double Das Budget der Kampagne.

withCondition("Budget > 500.0")
BudgetType Aufzählung Der Budgettyp der Kampagne. Mögliche Werte für die Groß- und Kleinschreibung sind:
  • STANDARD
  • BESCHLEUNIGT
withCondition("BudgetType = 'STANDARD'")
DeliveryStatus Aufzählung Der Status der Kampagne bei der Auslieferung. Mögliche Werte für die Groß- und Kleinschreibung sind:
  • BERECHTIGT
  • LIMITED_BY_BUDGET
  • HALTE
  • CAMPAIGN_OUT_OF_BUDGET
  • CAMPAIGN_SUSPENDED
  • CAMPAIGN_PAUSED
withCondition("DeliveryStatus NOT_IN ['LIMITED_BY_BUDGET', 'HOLD', 'CAMPAIGN_OUT_OF_BUDGET']")
LabelNames Zeichenfolgensatz Eine Liste mit einem oder mehreren Bezeichnungsnamen unter Berücksichtigung der Groß-/Kleinschreibung. Wird verwendet, um Kampagnen abzurufen, die den benannten Bezeichnungen zugeordnet sind.

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
Typ Aufzählung Der Kampagnentyp. Mögliche Werte für die Groß- und Kleinschreibung sind:
  • SEARCH_AND_CONTENT
  • EINKAUFEN
  • DYNAMIC_SEARCH_ADS
In diesem Beispiel werden nur Kampagnen zurückgegeben, deren Typ "Shopping" ist.

withCondition("CampaignType = SHOPPING")

Argumente

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

Rückgabewerte

Typ Beschreibung
CampaignSelector Selector mit der angewendeten Bedingung.

withIds(string[] ids)

Ruft Kampagnen 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. Im folgenden Aufruf wird beispielsweise nur die Kampagne 33333 ausgewählt.

AdsApp.campaigns()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Argumente

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

Rückgabewerte

Typ Beschreibung
CampaignSelector Selector mit den angewendeten IDs.

withLimit(int limit)

Ruft die Top-n-Kampagnen ab, die den Auswahlkriterien entsprechen.

Argumente

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

Rückgabewerte

Typ Beschreibung
CampaignSelector Selektor mit angewendetem Grenzwert.

Siehe auch

  • Last updated on