BudgetSelector
Enthält die Methoden zum Filtern und Sortieren der Liste der freigegebenen Budgets. Informationen zu Selektoren finden Sie unter Selektoren.
Anwendungsbeispiel:
var iterator = AdsApp.budgets()
.withCondition("ClickConversionRate > 0.3")
.forDateRange("LAST_WEEK")
.orderBy("Clicks DESC")
.get();
while (iterator.hasNext()) {
var budget = iterator.next();
var metrics = budget.getStats();
}
Methoden
| Methodenname | Rückgabetyp | Beschreibung |
|---|---|---|
| forDateRange(Object dateFrom, Object dateTo) | BudgetSelector | Wendet das Start- und Enddatum für die Auswahl von Leistungsmetriken an. |
| forDateRange(string dateRange) | BudgetSelector | Wendet den vordefinierten Datumsbereich für die Auswahl von Leistungsmetriken an. |
| get | AdGroupIterator | Ruft einen Iterator ab, der zum Durchlaufen der Liste der freigegebenen Budgets verwendet wird. |
| orderBy(string orderBy) | BudgetSelector | Wendet die angegebene Reihenfolge auf die ausgewählten freigegebenen Budgets an. |
| withCondition(string condition) | BudgetSelector | Wendet Filterkriterien auf die freigegebenen Budgets an. |
| withIds(string[] ids) | BudgetSelector | Ruft freigegebene Budgets mit den angegebenen IDs ab. |
| withLimit(int limit) | BudgetSelector | Ruft die obersten n freigegebenen Budgets 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. |
| dateTo | Objekt | Das Enddatum des Datumsbereichs, der die Leistungsdaten angibt, die in die Auswahl eingeschlossen werden sollen. |
Rückgabewerte
| Typ | Beschreibung |
|---|---|
| BudgetSelector | 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. |
Rückgabewerte
| Typ | Beschreibung |
|---|---|
| BudgetSelector | Selektor mit angewendetem Datumsbereich. |
Erhalten
Ruft einen Iterator ab, der zum Durchlaufen der Liste der freigegebenen Budgets verwendet wird.
Rückgabewerte
| Typ | Beschreibung |
|---|---|
| AdGroupIterator | Ein Iterator, der verwendet wird, um die ausgewählten gemeinsamen Budgets zu durchlaufen. |
orderBy(String orderBy)
Wendet die angegebene Reihenfolge auf die ausgewählten freigegebenen Budgets 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 freigegebene Budgets 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 |
|---|---|
| BudgetSelector | Selektor mit angewendeter Reihenfolge. |
withCondition(String condition)
Wendet Filterkriterien auf die freigegebenen Budgets 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 von freigegebenen Budgets. 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 |
|---|---|---|
| Betrag | double | Der Betrag des gemeinsamen Budgets.withCondition("Amount >= 130") |
| BudgetName | string | Der Name des freigegebenen Budgets.withCondition("BudgetName CONTAINS_IGNORE_CASE 'sport'") |
| BudgetReferenceCount | ganze Zahl | Die Anzahl der Kampagnen, die dem gemeinsamen Budget zugeordnet sind.withCondition("BudgetReferenceCount > 5") |
Argumente
| Name | Typ | Beschreibung |
|---|---|---|
| Zustand | string | Die Bedingung, die auf den Selektor angewendet werden soll. |
Rückgabewerte
| Typ | Beschreibung |
|---|---|
| BudgetSelector | Selektor mit angewendeter Bedingung. |
withIds(string[] ids)
Ruft freigegebene Budgets 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 das freigegebene Budget 33333 aus.
var selector = AdsApp.budgets()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
Argumente
| Name | Typ | Beschreibung |
|---|---|---|
| ids | string[] | Ein Array von freigegebenen Budget-IDs. Informationen zu Grenzwerten finden Sie unter Skriptausführungslimits. |
Rückgabewerte
| Typ | Beschreibung |
|---|---|
| BudgetSelector | Selektor mit den angewendeten IDs. |
withLimit(int limit)
Ruft die obersten n freigegebenen Budgets ab, die den Auswahlkriterien entsprechen.
Argumente
| Name | Typ | Beschreibung |
|---|---|---|
| Begrenzung | int | Die Anzahl der freigegebenen Budgets, die zurückgegeben werden sollen. Die tatsächliche Zahl kann kleiner sein. |
Rückgabewerte
| Typ | Beschreibung |
|---|---|
| BudgetSelector | Selektor mit angewendetem Limit. |