Esempi di script per la gestione delle campagne

Le sezioni seguenti illustrano esempi di script che eseguono varie azioni contro le campagne.

Ottenere tutte le campagne

Per ottenere tutte le campagne in un account, chiamare innanzitutto il metodo dell'oggetto campaignsAdsApp per ottenere il selettore. Chiamare quindi il metodo del get selettore per ottenere un iteratore usato 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 innanzitutto il metodo dell'oggetto campaignsAdsApp per ottenere il selettore. Il selettore contiene diversi metodi di filtro usati per filtrare l'elenco di campagne. Usare il withCondition metodo per filtrare le campagne per un nome di campagna specifico. Si noti che gli operandi e gli operatori fanno distinzione tra maiuscole e minuscole.

Chiamare quindi il metodo del get selettore per ottenere l'iteratore. I nomi delle campagne sono univoci, quindi ne si otterrà 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 la campagna in base all'ID

Se si ha accesso all'ID della campagna, usarlo. L'uso degli ID per ottenere le entità offre prestazioni migliori. Anziché 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 sulle prestazioni di una campagna

Per ottenere le metriche delle prestazioni di una campagna, chiama 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 TODAY, oppure una data di inizio e fine. Per specificare l'intervallo di date, usare uno dei forDateRange metodi quando si seleziona la campagna (vedere CampaignSelector).

Per un elenco delle metriche a cui è possibile accedere, vedere 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 abilitarlo nuovamente, chiamare il metodo della enable campagna. Per determinare lo stato della campagna, chiamare i metodi , isPausede isRemoved 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();
    }
}