BingAdsAccountSelector
Enthält die Methoden zum Filtern und Sortieren der Liste der Konten, auf die der Benutzer Zugriff hat. Informationen zu Selektoren finden Sie unter Selektoren.
Anwendungsbeispiel:
var accounts = AccountsApp.accounts()
.withCondition("Name CONTAINS_IGNORE_CASE 'PARTIAL ACCOUNT NAME GOES HERE'")
.get();
while (accounts.hasNext()) {
var account = accounts.next();
}
Methoden
Methodenname | Rückgabetyp | Beschreibung |
---|---|---|
executeInParallel(string functionName, string optionalCallbackFunctionName) | void | Führt die Funktion für jedes Konto aus, das der Selektor zurückgibt. |
executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput) | void | Führt die Funktion für jedes Konto aus, das der Selektor zurückgibt. |
forDateRange(Object dateFrom, Object dateTo) | BingAdsAccountSelector | Wendet das Start- und Enddatum für die Auswahl von Leistungsmetriken an. |
forDateRange(string dateRange) | BingAdsAccountSelector | Wendet den vordefinierten Datumsbereich für die Auswahl von Leistungsmetriken an. |
get | BingAdsAccountIterator | Ruft einen Iterator ab, der zum Durchlaufen der Liste der Konten verwendet wird. |
orderBy(string orderBy) | BingAdsAccountSelector | Wendet die angegebene Reihenfolge auf die ausgewählten Konten an. |
withAccountNumbers(string[] accountNumbers) | BingAdsAccountSelector | Ruft Konten mit den angegebenen Kontonummern ab. |
withCondition(string condition) | BingAdsAccountSelector | Wendet Filterkriterien auf die Konten an. |
withIds(string[] ids) | BingAdsAccountSelector | Ruft Konten mit den angegebenen IDs ab. |
withLimit(int limit) | BingAdsAccountSelector | Ruft die obersten n Konten ab, die den Auswahlkriterien entsprechen. |
executeInParallel(string functionName, string optionalCallbackFunctionName)
Führt die Funktion für jedes Konto aus, das der Selektor zurückgibt. Nachdem die Funktion für alle ausgewählten Konten ausgeführt wurde, ruft Scripts die optionale Rückruffunktion auf.
Hinweis
Das Skript kann bei jeder Ausführung des Skripts maximal 50 Konten parallel ausführen. Sie können diese Methode einmal oder mehrmals aufrufen, aber die Gesamtzahl der Konten, die alle Aufrufe verarbeiten, darf 50 nicht überschreiten. Wenn ein Aufruf die maximale Anzahl von 50 Konten für das Skript überschreitet, wird keines der Konten im Aufruf ausgeführt. Um die Anzahl von Konten zu begrenzen, die der Selektor zurückgibt, sollten Sie die -Methode oder withIds
die withLimit
-Methode verwenden.
Die functionName-Funktion gibt möglicherweise einen Wert als Zeichenfolge zurück. Um ein komplexes Objekt zurückzugeben, verwenden Sie die JSON.stringify-Methode, um das Objekt in eine Zeichenfolge zu konvertieren. Anschließend können Sie die JSON.parse-Methode verwenden, um die Zeichenfolge wieder in ein Objekt zu konvertieren. Wenn Ihre Funktion einen Wert zurückgibt, müssen Sie eine Rückruffunktion angeben, um die Rückgabewerte zu erfassen. Im Folgenden wird die Signatur der Rückruffunktion veranschaulicht. Die zurückgegebenen Werte werden als Array von ExecutionResult-Objekten übergeben.
function myCallback(ExecutionResult[] results)
Das folgende Beispiel zeigt, wie die zurückgegebenen Werte in der Rückruffunktion verarbeitet werden.
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
Da diese Methode kein BingAdsAccountSelector-Objekt zurückgibt, stellen Sie sicher, dass diese Methode die letzte Selektormethode in der Aufrufkette ist.
Ein Beispiel finden Sie unter Entdecken von abgelehnten Anzeigen.
Argumente
Name | Typ | Beschreibung |
---|---|---|
Functionname | string | Der Name der Funktion, die für jedes Konto ausgeführt werden soll, das vom Selektor zurückgegeben wird. Die currentAccount-Methode identifiziert das Konto, das von der Funktion verarbeitet wird. |
optionalCallbackFunctionName | string | Optional. Der Name der Funktion, die ausgeführt werden soll, nachdem alle Konten die Funktion functionName ausgeführt haben. Diese Funktion wird nur einmal ausgeführt. |
Rückgabewerte
Typ | Beschreibung |
---|---|
void | Gibt Nothing zurück. |
executeInParallel(string functionName, string optionalCallbackFunctionName, string optionalInput)
Führt die Funktion für jedes Konto aus, das der Selektor zurückgibt. Nachdem die Funktion für alle ausgewählten Konten ausgeführt wurde, ruft Scripts die optionale Rückruffunktion auf.
Hinweis
Das Skript kann bei jeder Ausführung des Skripts maximal 50 Konten parallel ausführen. Sie können diese Methode einmal oder mehrmals aufrufen, aber die Gesamtzahl der Konten, die alle Aufrufe verarbeiten, darf 50 nicht überschreiten. Wenn ein Aufruf die maximale Anzahl von 50 Konten für das Skript überschreitet, wird keines der Konten im Aufruf ausgeführt. Um die Anzahl von Konten zu begrenzen, die der Selektor zurückgibt, sollten Sie die -Methode oder withIds
die withLimit
-Methode verwenden.
Die functionName-Funktion gibt möglicherweise einen Wert als Zeichenfolge zurück. Um ein komplexes Objekt zurückzugeben, verwenden Sie die JSON.stringify-Methode, um das Objekt in eine Zeichenfolge zu konvertieren. Anschließend können Sie die JSON.parse-Methode verwenden, um die Zeichenfolge wieder in ein Objekt zu konvertieren. Wenn Ihre Funktion einen Wert zurückgibt, müssen Sie eine Rückruffunktion angeben, um die Rückgabewerte zu erfassen. Im Folgenden wird die Signatur der Rückruffunktion veranschaulicht. Die zurückgegebenen Werte werden als Array von ExecutionResult-Objekten übergeben.
function myCallback(ExecutionResult[] results)
Das folgende Beispiel zeigt, wie die zurückgegebenen Werte in der Rückruffunktion verarbeitet werden.
function myCallback(results) {
for (var result of results) {
var object = JSON.parse(result.getReturnValue());
}
}
Wenn Sie den optionalen Eingabeparameter übergeben, wird im Folgenden die Signatur der functionName-Funktion angezeigt.
function myFunction(string optionalInput)
Da diese Methode kein BingAdsAccountSelector-Objekt zurückgibt, stellen Sie sicher, dass diese Methode die letzte Selektormethode in der Aufrufkette ist.
Ein Beispiel finden Sie unter Entdecken von abgelehnten Anzeigen.
Argumente
Name | Typ | Beschreibung |
---|---|---|
Functionname | string | Der Name der Funktion, die für jedes Konto ausgeführt werden soll, das vom Selektor zurückgegeben wird. Die currentAccount-Methode identifiziert das Konto, das von der Funktion verarbeitet wird. |
optionalCallbackFunctionName | string | Optional. Der Name der Funktion, die ausgeführt werden soll, nachdem alle Konten die Funktion functionName ausgeführt haben. Diese Funktion wird nur einmal ausgeführt. |
optionalInput | string | Optional. Eingabe, die an die functionName-Funktion übergeben werden soll. |
Rückgabewerte
Typ | Beschreibung |
---|---|
void | Gibt Nothing zurück. |
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 |
---|---|
BingAdsAccountSelector | Selektor mit angewendetem Datumsbereich. |
forDateRange(String dateRange)
Wendet den vordefinierten Datumsbereich für die Auswahl von Leistungsmetriken an.
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
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.
Argumente
Name | Typ | Beschreibung |
---|---|---|
dateRange | Zeichenfolge | Die vordefinierte Datumsbereichszeichenfolge, die die Leistungsdaten angibt, die in die Auswahl eingeschlossen werden sollen. Bei der vordefinierten Datumsbereichszeichenfolge wird die Groß-/Kleinschreibung beachtet. |
Rückgabewerte
Typ | Beschreibung |
---|---|
BingAdsAccountSelector | Selektor mit angewendetem Datumsbereich. |
Erhalten
Ruft einen Iterator ab, der zum Durchlaufen der Liste der Konten verwendet wird.
Rückgabewerte
Typ | Beschreibung |
---|---|
BingAdsAccount | Ein Iterator, der zum Durchlaufen der ausgewählten Konten verwendet wird. |
orderBy(string orderBy)
Wendet die angegebene Reihenfolge auf die ausgewählten Konten 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 z. B. Ergebnisse in aufsteigender Reihenfolge nach Klicks zurück.
selector = selector.orderBy("Clicks");
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 |
---|---|
BingAdsAccountSelector | Selektor mit angewendeter Reihenfolge. |
withAccountNumbers(string[] accountNumbers)
Ruft Konten mit den angegebenen Kontonummern ab.
Argumente
Name | Typ | Beschreibung |
---|---|---|
accountNumbers | string[] | Ein Array von Kontonummern. Informationen zu Grenzwerten finden Sie unter Skriptausführungslimits. |
Rückgabewerte
Typ | Beschreibung |
---|---|
BingAdsAccountSelector | Selektor mit den angewendeten Kontonummern. |
withCondition(String condition)
Wendet Filterkriterien auf die Konten 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 für die Kontofilterung. Bei Spaltennamen wird die Groß-/Kleinschreibung beachtet.
Im Folgenden sind die Leistungsmetrikspalten aufgeführt, die Sie angeben können.
Spalte | Typ | Beispiel | Microsoft Advertising-Web-UI-Filter |
---|---|---|---|
ClickConversionRate | double | withCondition("ClickConversionRate > 0.25") |
Konv. Rate |
Klicks | long | withCondition("Clicks >= 33") |
Klicks |
ConvertedClicks | long | withCondition("ConvertedClicks >= 10") |
Conv. |
Kosten | double | withCondition("Cost > 3.25") Die Kosten werden in der Währung des Kontos angegeben. |
Verbringen |
Ctr | double | withCondition("Ctr > 0.05") Die CTR liegt im Bereich 0,.1. Verwenden Sie daher 0,05 für eine CtR von 5 %. |
CTR |
Eindrücke | long | withCondition("Impressions > 10") |
Impr. |
Im Folgenden sind die Kontoeigenschaften aufgeführt, die Sie angeben können.
Spalte | Typ | Beispiel | Microsoft Advertising-Web-UI-Filter |
---|---|---|---|
CurrencyCode | string | Der Währungscode der Währung, die vom Konto verwendet wird. Beispielsweise USD für USA Dollar.withCondition("CurrencyCode = USD") |
|
ManagerCustomerId | string | Die Kunden-ID des Benutzers, der die Konten verwaltet.withCondition("ManagerCustomerId = '123456789'") |
|
Name | string | Der Name eines verwalteten Kontos.withCondition("Name CONTAINS_IGNORE_CASE 'foo'") |
Argumente
Name | Typ | Beschreibung |
---|---|---|
Zustand | string | Die Bedingung, die dem Selektor hinzugefügt werden soll. |
Rückgabewerte
Typ | Beschreibung |
---|---|
BingAdsAccountSelector | Selektor mit angewendeter Bedingung. |
withIds(string[] ids)
Ruft Konten 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 Konto 33333 aus.
AccountsApp.accounts()
.withIds(['11111', '22222', '33333'])
.withIds(['33333', '44444', '55555']);
.get();
Argumente
Name | Typ | Beschreibung |
---|---|---|
ids | string[] | Ein Array von Konto-IDs. Informationen zu Grenzwerten finden Sie unter Skriptausführungslimits. |
Rückgabewerte
Typ | Beschreibung |
---|---|
BingAdsAccountSelector | Selektor mit den angewendeten IDs. |
withLimit(int limit)
Ruft die obersten n Konten ab, die den Auswahlkriterien entsprechen.
Argumente
Name | Typ | Beschreibung |
---|---|---|
Begrenzung | int | Die Anzahl der zurückzugebenden Konten. Die tatsächliche Zahl kann kleiner sein. |
Rückgabewerte
Typ | Beschreibung |
---|---|
BingAdsAccountSelector | Selektor mit angewendetem Limit. |