Partilhar via


Exemplos de scripts para gerir campanhas

As secções seguintes mostram exemplos de scripts que efetuam várias ações em campanhas.

Obter todas as campanhas

Para obter todas as campanhas numa conta, primeiro chame o método do campaigns objeto AdsApp para obter o seletor. Em seguida, chame o método do get seletor para obter um iterador que utiliza para iterar através da lista de campanhas. Uma vez que o exemplo não especifica filtros, o seletor devolve 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, chame primeiro o método do campaigns objeto AdsApp para obter o seletor. O seletor contém vários métodos de filtro que utiliza para filtrar a lista de campanhas. Utilize o withCondition método para filtrar as campanhas para um nome de campanha específico. Tenha em atenção que os operandos e operadores são sensíveis às maiúsculas e 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, utilize-o em alternativa. A utilização de IDs para obter entidades proporciona um melhor desempenho. Em vez de utilizar o withCondition método de filtro, utilize 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. Quando receber a campanha, terá de especificar o intervalo de datas dos dados de métricas que pretende. Pode especificar o intervalo de datas com um literal predefinido, como LAST_MONTH ou HOJE, ou uma data de início e de fim. Para especificar o intervalo de datas, utilize um dos forDateRange métodos quando selecionar a campanha (consulte CampaignSelector).

Para obter uma lista das métricas a que pode aceder, veja o objeto Estatísticas .

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