Ejemplos de scripts para administrar presupuestos compartidos

En las secciones siguientes se muestran ejemplos de scripts que realizan diversas acciones en los presupuestos compartidos.

Adición de presupuestos compartidos

Para agregar un presupuesto compartido, debe usar la aplicación web microsoft Advertising. Para obtener más información, consulte Cómo compartir un presupuesto entre varias campañas?

Asociación de una campaña con un presupuesto compartido

Para asociar una campaña a un presupuesto compartido, debe usar la aplicación web Microsoft Advertising. Para obtener más información, consulte Cómo compartir un presupuesto entre varias campañas?

Obtener todos los presupuestos compartidos

Para obtener todos los presupuestos compartidos de una cuenta, llame primero al método del budgets objeto AdsApp para obtener el selector. A continuación, llame al método del get selector para obtener un iterador que se usa para recorrer en iteración la lista de presupuestos compartidos. Dado que el ejemplo no especifica ningún filtro, el selector devuelve todos los presupuestos compartidos de la cuenta. Para determinar el número de presupuestos compartidos en el iterador, llame al método del totalNumEntities iterador.

Nota:

Los presupuestos compartidos no incluyen presupuestos no compartidos (campañas individuales).

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

Obtener un presupuesto compartido por nombre

Para obtener un presupuesto compartido por nombre, llame primero al método del budgets objeto AdsApp para obtener el selector. El selector contiene una serie de métodos de filtro que se usan para filtrar la lista de presupuestos. Use el withCondition método para filtrar los presupuestos por nombre. Por ejemplo, para filtrar la lista por un nombre específico, use: withCondition("BudgetName = '<budgetnamegoeshere>'"). Para filtrar la lista por un nombre parcial, use: withCondition("BudgetName CONTAINS_IGNORE_CASE '<partialnamegoeshere>'"). Tenga en cuenta que los operandos y operadores distinguen mayúsculas de minúsculas.

A continuación, llame al método del get selector para obtener el 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();
    }
}

Obtención de presupuestos compartidos por identificador

Si tiene acceso al identificador del presupuesto compartido, úselo en su lugar. El uso de identificadores para obtener entidades proporciona un mejor rendimiento. En lugar de usar el método de withCondition filtro, use el withIds método . Por ejemplo, withIds(['12345']).

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

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

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

Obtener todas las campañas que comparten el presupuesto

Para obtener todas las campañas que comparten el presupuesto, llama al método de campañas del presupuesto. Puede llamar a este método solo desde un objeto Budget que obtenga de BudgetSelector; no se puede llamar si el origen del presupuesto es el método getBudget de la campaña.

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

Obtención de los datos de rendimiento de un presupuesto compartido

Para obtener las métricas de rendimiento de un presupuesto compartido, llame al método getStats del presupuesto. Al obtener la lista de presupuestos de recursos compartidos, debe especificar el intervalo de fechas de los datos de métricas que desee. Puede especificar el intervalo de fechas mediante un literal predefinido, como LAST_MONTH o TODAY, o una fecha de inicio y finalización. Para especificar el intervalo de fechas, use uno de los forDateRange métodos al seleccionar los presupuestos (consulte BudgetSelector).

Para obtener una lista de las métricas a las que puede acceder, consulte el objeto Stats . Las métricas son la agregación de todas las campañas que comparten el presupuesto.

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.
    }
}