Skriptbeispiele für die Verwaltung von Kampagnen
Die folgenden Abschnitte zeigen Beispiele für Skripts, die verschiedene Aktionen für Kampagnen ausführen.
Abrufen aller Kampagnen
Um alle Kampagnen in einem Konto abzurufen, rufen Sie zuerst die Methode des campaigns
AdsApp-Objekts auf, um die Auswahl abzurufen. Rufen Sie dann die -Methode des Selektors get
auf, um einen Iterator abzurufen, den Sie zum Durchlaufen der Liste der Kampagnen verwenden. Da im Beispiel keine Filter angegeben sind, gibt der Selektor alle Kampagnen im Konto zurück. Um die Anzahl der Kampagnen im Iterator zu bestimmen, rufen Sie die -Methode des totalNumEntities
Iterators auf.
function main() {
// Gets all campaigns in the account.
var iterator = AdsApp.campaigns().get();
// Iterates through the list of campaigns and logs
// each campaign's name.
while (iterator.hasNext()) {
var campaign = iterator.next();
}
}
Abrufen einer Kampagne anhand des Namens
Um eine Kampagne anhand des Namens abzurufen, rufen Sie zuerst die Methode des campaigns
AdsApp-Objekts auf, um den Selektor abzurufen. Die Auswahl enthält eine Reihe von Filtermethoden, mit denen Sie die Liste der Kampagnen filtern. Verwenden Sie die withCondition
-Methode, um die Kampagnen nach einem bestimmten Kampagnennamen zu filtern. Beachten Sie, dass bei den Operanden und Operatoren die Groß-/Kleinschreibung beachtet wird.
Rufen Sie als Nächstes die -Methode des Selektors get
auf, um den Iterator abzurufen. Kampagnennamen sind eindeutig, sodass Sie nur einen erhalten, sofern vorhanden.
function main() {
var campaignName = 'CAMPAIGN NAME GOES HERE';
var iterator = AdsApp.campaigns()
.withCondition(`Name = '${campaignName}'`)
.get();
while (iterator.hasNext()) {
var campaign = iterator.next();
}
}
Kampagne nach ID abrufen
Wenn Sie Zugriff auf die ID der Kampagne haben, verwenden Sie sie stattdessen. Die Verwendung von IDs zum Abrufen von Entitäten bietet eine bessere Leistung. Verwenden Sie anstelle der withCondition
Filtermethode die withIds
-Methode. Beispiel: withIds(['12345'])
.
function main() {
var campaignId = '12345';
var iterator = AdsApp.campaigns()
.withIds([campaignId])
.get();
while (iterator.hasNext()) {
var campaign = iterator.next();
}
}
Abrufen der Leistungsdaten einer Kampagne
Rufen Sie die getStats-Methode der Kampagne auf, um die Leistungsmetriken einer Kampagne abzurufen. Wenn Sie die Kampagne erhalten, müssen Sie den Datumsbereich der gewünschten Metrikdaten angeben. Sie können den Datumsbereich mithilfe eines vordefinierten Literals angeben, z. B. LAST_MONTH oder HEUTE, oder mit einem Start- und Enddatum. Um den Datumsbereich anzugeben, verwenden Sie eine der forDateRange
Methoden, wenn Sie die Kampagne auswählen (siehe CampaignSelector).
Eine Liste der Metriken, auf die Sie zugreifen können, finden Sie im Stats-Objekt .
function main() {
var campaignId = '12345';
// Get the campaign. You need to specify the date range of the
// performance data you want to get.
var iterator = AdsApp.campaigns()
.withIds([campaignId])
.forDateRange('LAST_WEEK')
.get();
// If the campaign is found, log some metrics.
while (iterator.hasNext()) {
var campaign = iterator.next();
var metrics = campaign.getStats(); // Gets the performance metrics.
}
}
Anhalten einer Kampagne
Um eine Kampagne anzuhalten, rufen Sie die -Methode der pause
Kampagne auf. Um sie erneut zu aktivieren, rufen Sie die -Methode der Kampagne auf enable
. Um die status der Kampagne zu bestimmen, rufen Sie die Methoden , isPaused
und isRemoved
der Kampagne isEnabled
auf.
function main() {
var campaignId = '12345';
var iterator = AdsApp.campaigns()
.withIds([campaignId])
.get();
// If the campaign is found, pause it.
while (iterator.hasNext()) {
var campaign = iterator.next();
campaign.pause();
}
}