Exemplos de scripts para gerir orçamentos partilhados

As secções seguintes mostram exemplos de scripts que executam várias ações em orçamentos partilhados.

Adicionar orçamentos partilhados

Para adicionar um orçamento partilhado, tem de utilizar a aplicação Web Microsoft Advertising. Para obter detalhes, consulte Como devo proceder para compartilhar um orçamento em várias campanhas?

Associar uma campanha a um orçamento partilhado

Para associar uma campanha a um orçamento partilhado, tem de utilizar a aplicação Web Microsoft Advertising. Para obter detalhes, consulte Como devo proceder para compartilhar um orçamento em várias campanhas?

Obtenha todos os orçamentos partilhados

Para obter todos os orçamentos compartilhados em uma conta, primeiro chame o método do budgets objeto AdsApp para obter o seletor. Em seguida, chame o método do get seletor para obter um iterador que você usa para iterar pela lista de orçamentos compartilhados. Como o exemplo não especifica filtros, o seletor retorna todos os orçamentos compartilhados na conta. Para determinar o número de orçamentos compartilhados no iterador, chame o método do totalNumEntities iterador.

Nota

Os orçamentos partilhados não incluem orçamentos não partilhados (campanhas individuais).

function main() {
    // Gets all shared budgets in the account.
    var iterator = AdsApp.budgets().get();
    
    // Iterates through the list of shared budgets and logs 
    // each budgets's name and amount.
    while (iterator.hasNext()) {
        var budget = iterator.next();
    }
}

Obter um orçamento partilhado pelo nome

Para obter um orçamento compartilhado pelo nome, primeiro chame o método do budgets objeto AdsApp para obter o seletor. O seletor contém vários métodos de filtro que você usa para filtrar a lista de orçamentos. Use o withCondition método para filtrar os orçamentos por nome. Por exemplo, para filtrar a lista por um nome específico, utilize: withCondition("BudgetName = '<budgetnamegoeshere>'"). Para filtrar a lista por um nome parcial, utilize: withCondition("BudgetName CONTAINS_IGNORE_CASE '<partialnamegoeshere>'"). 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.

function main() {
    // Partial name of the shared budget to get.
    var budgetName = 'PARTIAL NAME GOES HERE';

    // Get the budgets that contain the partial name.
    var iterator = AdsApp.budgets()
          .withCondition(`BudgetName CONTAINS_IGNORE_CASE '${budgetName}'`)
          .get();

    // Iterates through the list of shared budgets and logs 
    // each budget's name and amount.
    while (iterator.hasNext()) {
        var budget = iterator.next();
    }
}

Obter orçamentos partilhados por ID

Se tiver acesso ao ID do orçamento partilhado, utilize-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 sharedBudgetId = '12345';

    var iterator = AdsApp.budgets()
        .withIds([sharedBudgetId])
        .get();

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

Obter todas as campanhas que partilham o orçamento

Para obter todas as campanhas que partilham o orçamento, ligue para o método de campanhas do orçamento. Você pode chamar esse método somente de um objeto Budget obtido de BudgetSelector; você não pode chamá-lo se a fonte do orçamento for o método getBudget da campanha.

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

    var budgets = AdsApp.budgets()
        .withIds([sharedBudgetId])
        .get();

    while (budgets.hasNext()) {
        var budget = budgets.next();

        var campaigns = budget.campaigns().get();

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

Obter dados de desempenho de um orçamento partilhado

Para obter as métricas de desempenho de um orçamento compartilhado, chame o método getStats do orçamento. Quando obtiver a lista de orçamentos de partilha, tem de especificar o intervalo de datas dos dados de métricas pretendidos. 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, utilize um dos forDateRange métodos ao selecionar os orçamentos (consulte BudgetSelector).

Para obter uma lista de métricas que você pode acessar, consulte o objeto Stats . As métricas são a agregação de todas as campanhas que compartilham o orçamento.

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

    // Get the shared budget. You need to specify the date range of the
    // performance data you want to get.
    var budgets = AdsApp.budgets()
        .forDateRange('LAST_WEEK')
        .withIds([sharedBudgetId])
        .get();
    
    // If the budget is found, log some metrics.
    while (budgets.hasNext()) {
        var budget = budgets.next();
        var metrics = budget.getStats(); // Gets the performance metrics.
    }
}
  • Last updated on