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 zunächst die Methode des AdsApp-Objektscampaigns auf, um den Selektor abzurufen. Rufen Sie dann die Selektormethode get auf, um einen Iterator abzurufen, mit dem Sie die Liste der Kampagnen durchlaufen können. Da in diesem Beispiel keine Filter angegeben werden, gibt der Selektor alle Kampagnen im Konto zurück. Um die Anzahl der Kampagnen im Iterator zu bestimmen, rufen Sie die Methode des Iterators auf totalNumEntities .

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 nach Name

Um eine Kampagne nach Name zu erhalten, rufen Sie zuerst die Methode des AdsApp-Objektscampaigns auf, um den Selektor abzurufen. Die Auswahl enthält eine Reihe von Filtermethoden, mit denen Sie die Liste der Kampagnen filtern können. Verwenden Sie die withCondition Methode, um die Kampagnen nach einem bestimmten Kampagnennamen zu filtern. Beachten Sie, dass bei Operanden und Operatoren die Groß-/Kleinschreibung beachtet wird.

Rufen Sie als Nächstes die Selektormethode auf get , um den Iterator abzurufen. Kampagnennamen sind eindeutig, daher erhalten Sie nur einen zurück, 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 Kampagnen-ID haben, verwenden Sie stattdessen diese. Die Verwendung von IDs zum Abrufen von Entitäten bietet eine bessere Leistung. Anstatt die withCondition Filtermethode zu verwenden, verwenden Sie 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 Performance-Daten einer Kampagne

Um die Performance-Kennzahlen einer Kampagne abzurufen, rufen Sie die getStats-Methode der Kampagne auf. Wenn Sie die Kampagne erhalten, müssen Sie den Datumsbereich der gewünschten Metrikdaten angeben. Sie können den Datumsbereich mithilfe eines vordefinierten Literals, z. B. LAST_MONTH oder HEUTE, oder eines Start- und Enddatums angeben. Um den Datumsbereich anzugeben, verwenden Sie eine der Methoden forDateRange , wenn Sie die Kampagne auswählen (siehe CampaignSelector).

Eine Liste der Metriken, auf die Sie zugreifen können, finden Sie im Objekt "Statistiken ".

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.
    }
}

Pausieren einer Kampagne

Um eine Kampagne zu pausieren, rufen Sie die Methode der Kampagne auf pause . Rufen Sie die Methode der enable Kampagne auf, um sie wieder zu aktivieren. Um den Status der Kampagne zu ermitteln, rufen Sie die , und isRemoved Methoden der isPausedisEnabledKampagne 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();
    }
}