Exemples de script pour la gestion des budgets partagés

Les sections suivantes présentent des exemples de scripts qui effectuent diverses actions sur des budgets partagés.

Ajouter des budgets partagés

Pour ajouter un budget partagé, vous devez utiliser l’application web Microsoft Advertising. Pour plus d’informations, consultez Comment faire partager un budget entre plusieurs campagnes ?

Associer une campagne à un budget partagé

Pour associer une campagne à un budget partagé, vous devez utiliser l’application web Microsoft Advertising. Pour plus d’informations, consultez Comment faire partager un budget entre plusieurs campagnes ?

Obtenir tous les budgets partagés

Pour obtenir tous les budgets partagés dans un compte, appelez d’abord la méthode de budgets l’objet AdsApp pour obtenir le sélecteur. Ensuite, appelez la méthode du get sélecteur pour obtenir un itérateur que vous utilisez pour itérer dans la liste des budgets partagés. Étant donné que l’exemple ne spécifie aucun filtre, le sélecteur retourne tous les budgets partagés dans le compte. Pour déterminer le nombre de budgets partagés dans l’itérateur, appelez la méthode de l’itérateur totalNumEntities .

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

Obtenir un budget partagé par nom

Pour obtenir un budget partagé par nom, appelez d’abord la méthode de budgets l’objet AdsApp pour obtenir le sélecteur. Le sélecteur contient un certain nombre de méthodes de filtre que vous utilisez pour filtrer la liste des budgets. Utilisez la withCondition méthode pour filtrer les budgets par nom. Par exemple, pour filtrer la liste pour un nom spécifique, utilisez : withCondition("BudgetName = '<budgetnamegoeshere>'"). Pour filtrer la liste par un nom partiel, utilisez : withCondition("BudgetName CONTAINS_IGNORE_CASE '<partialnamegoeshere>'"). Notez que les opérandes et les opérateurs respectent la casse.

Ensuite, appelez la méthode du get sélecteur pour obtenir l’itérateur.

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

Obtenir des budgets partagés par ID

Si vous avez accès à l’ID du budget partagé, utilisez-le à la place. L’utilisation d’ID pour obtenir des entités offre de meilleures performances. Au lieu d’utiliser la withCondition méthode filter, utilisez la withIds méthode . Par exemple : withIds(['12345']).

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

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

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

Obtenir toutes les campagnes qui partagent le budget

Pour obtenir toutes les campagnes qui partagent le budget, appelez la méthode des campagnes du budget. Vous pouvez appeler cette méthode uniquement à partir d’un objet Budget que vous obtenez à partir de BudgetSelector ; vous ne pouvez pas l’appeler si la source du budget est la méthode getBudget de la campagne.

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

Obtenir les données de performances d’un budget partagé

Pour obtenir les métriques de performances d’un budget partagé, appelez la méthode getStats du budget. Lorsque vous obtenez la liste des budgets de partage, vous devez spécifier la plage de dates des données de métriques souhaitées. Vous pouvez spécifier la plage de dates à l’aide d’un littéral prédéfini, tel que LAST_MONTH ou AUJOURD’HUI, ou d’une date de début et de fin. Pour spécifier la plage de dates, utilisez l’une des forDateRange méthodes lorsque vous sélectionnez les budgets (voir BudgetSelector).

Pour obtenir la liste des métriques accessibles, consultez l’objet Stats . Les métriques sont l’agrégation de toutes les campagnes qui partagent le budget.

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