Exemplos de scripts para gerir campanhas

As seções a seguir mostram exemplos de scripts que executam várias ações em campanhas.

Nota

A gestão de campanhas Performance Max com scripts não é suportada.

Obter todas as campanhas

Para obter todas as campanhas em uma conta, primeiro chame o método do campaigns objeto AdsApp para obter o seletor. Em seguida, chame o método do get seletor e obtenha um iterador que você usa para iterar pela lista de campanhas. Como o exemplo não especifica filtros, o seletor retorna todas as campanhas na conta. Para determinar o número de campanhas no iterador, chame o método do totalNumEntities iterador.

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

Obter uma campanha pelo nome

Para obter uma campanha pelo nome, primeiro chame o método do campaigns objeto AdsApp para obter o seletor. O seletor contém vários métodos de filtro que você usa para filtrar a lista de campanhas. Use o withCondition método para filtrar as campanhas por um nome de campanha específico. Observe que os operandos e operadores diferenciam maiúsculas de minúsculas.

Em seguida, chame o método do get seletor para obter o iterador. Os nomes das campanhas são exclusivos, pelo que só terá acesso a um, se existir.

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

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

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

Obter campanha por ID

Se tiver acesso ao ID da campanha, use-o. O uso de IDs para obter entidades proporciona melhor desempenho. Em vez de usar o withCondition método filter, use o withIds método. Por exemplo, withIds(['12345']).

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

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

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

Obter os dados de desempenho de uma campanha

Para obter as métricas de desempenho de uma campanha, chame o método getStats da campanha. Ao receber a campanha, você precisa especificar o intervalo de datas dos dados de métricas desejados. Pode especificar o intervalo de datas através de um literal predefinido, como LAST_MONTH ou HOJE ou uma data de início e de fim. Para especificar o intervalo de datas, use um dos forDateRange métodos ao selecionar a campanha (consulte CampaignSelector).

Para obter uma lista de métricas que você pode acessar, consulte o objeto 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.
    }
}

Colocar uma campanha em pausa

Para colocar uma campanha em pausa, chame o método da pause campanha. Para ativá-la novamente, chame o método da enable campanha. Para determinar o status da campanha, chame os métodos , isPausede isRemoved da isEnabledcampanha.

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