Esempi di script per la gestione delle campagne

Le sezioni seguenti mostrano esempi di script che eseguono varie azioni sulle campagne.

Nota

La gestione delle campagne Performance Max con gli script non è supportata.

Ottenere tutte le campagne

Per ottenere tutte le campagne in un account, chiamare prima il metodo dell'oggetto campaignsAdsApp per ottenere il selettore. Quindi, chiama il metodo del get selettore ottenendo un iteratore che usi per scorrere l'elenco delle campagne. Poiché l'esempio non specifica alcun filtro, il selettore restituisce tutte le campagne nell'account. Per determinare il numero di campagne nell'iteratore, chiamare il metodo dell'iteratore 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();
    }
}

Ottenere una campagna per nome

Per ottenere una campagna in base al nome, chiamare prima il metodo dell'oggetto campaignsAdsApp per ottenere il selettore. Il selettore contiene diversi metodi di filtro che consentono di filtrare l'elenco delle campagne. Utilizzare il withCondition metodo per filtrare le campagne in base a un nome di campagna specifico. Si noti che gli operandi e gli operatori fanno distinzione tra maiuscole e minuscole.

Quindi, chiama il metodo del get selettore per ottenere l'iteratore. I nomi delle campagne sono univoci, quindi ne verrà recuperato solo uno, se esistente.

function main() {
    var campaignName = 'CAMPAIGN NAME GOES HERE';

    var iterator = AdsApp.campaigns()
        .withCondition(`Name = '${campaignName}'`)
        .get();

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

Ottenere una campagna per ID

Se hai accesso all'ID della campagna, usalo al suo posto. L'uso degli ID per ottenere entità offre prestazioni migliori. Invece di usare il withCondition metodo di filtro, usare il withIds metodo. Ad esempio, withIds(['12345']).

function main() {
    var campaignId = '12345';

    var iterator = AdsApp.campaigns()
        .withIds([campaignId])
        .get();

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

Ottenere i dati sul rendimento di una campagna

Per ottenere le metriche relative alle prestazioni di una campagna, chiamare il metodo getStats della campagna. Quando si ottiene la campagna, è necessario specificare l'intervallo di date dei dati delle metriche desiderati. È possibile specificare l'intervallo di date usando un valore letterale predefinito, ad esempio LAST_MONTH o OGGI, oppure una data di inizio e di fine. Per specificare l'intervallo di date, utilizzare uno dei forDateRange metodi quando si seleziona la campagna (vedere CampaignSelector).

Per un elenco delle metriche a cui è possibile accedere, vedi l'oggetto Stats .

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

Sospendere una campagna

Per sospendere una campagna, chiamare il metodo della pause campagna. Per abilitarla di nuovo, chiamare il metodo della enable campagna. Per determinare lo stato della campagna, chiamare i metodi e isPausedisRemoved i metodi della isEnabledcampagna.

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();
    }
}