Exemplos de scripts para gerir orçamentos partilhados

As secções seguintes mostram exemplos de scripts que efetuam várias ações em relação a 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 partilhar 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 partilhar um orçamento em várias campanhas?

Obter todos os orçamentos partilhados

Para obter todos os orçamentos partilhados numa 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 utiliza para iterar através da lista de Orçamentos partilhados. Uma vez que o exemplo não especifica filtros, o seletor devolve todos os orçamentos partilhados na conta. Para determinar o número de orçamentos partilhados no iterador, chame o método do totalNumEntities iterador.

Nota

Os orçamentos partilhados não incluem orçamentos não partilhados (campanha individual).

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 partilhado pelo nome, chame primeiro o método do budgets objeto AdsApp para obter o seletor. O seletor contém vários métodos de filtro que utiliza para filtrar a lista de orçamentos. Utilize 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>'"). 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.

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. 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 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, chame o método de campanhas do orçamento. Pode chamar este método apenas a partir de um objeto Orçamento que obtém do BudgetSelector; não lhe pode chamar se a origem 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 os dados de desempenho de um orçamento partilhado

Para obter as métricas de desempenho de um orçamento partilhado, chame o método getStats do orçamento. Quando obtém a lista de orçamentos de partilha, tem 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 os orçamentos (veja BudgetSelector).

Para obter uma lista das métricas a que pode aceder, veja o objeto Estatísticas . As métricas são a agregação de todas as campanhas que partilham 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.
    }
}