Skriptbeispiele für die Verwaltung von freigegebenen Budgets

Die folgenden Abschnitte zeigen Beispiele für Skripts, die verschiedene Aktionen für gemeinsame Budgets ausführen.

Hinzufügen von freigegebenen Budgets

Um ein gemeinsames Budget hinzuzufügen, müssen Sie die Microsoft Advertising-Webanwendung verwenden. Weitere Informationen finden Sie unter Gewusst wie Ein Budget für mehrere Kampagnen freigeben?

Zuordnen einer Kampagne zu einem gemeinsamen Budget

Um eine Kampagne einem gemeinsamen Budget zuzuordnen, müssen Sie die Microsoft Advertising-Webanwendung verwenden. Weitere Informationen finden Sie unter Gewusst wie Ein Budget für mehrere Kampagnen freigeben?

Abrufen aller freigegebenen Budgets

Um alle freigegebenen Budgets in einem Konto abzurufen, rufen Sie zuerst die Methode des budgetsAdsApp-Objekts auf, um die Auswahl abzurufen. Rufen Sie dann die -Methode des Selektors get auf, um einen Iterator abzurufen, mit dem Sie die Liste der freigegebenen Budgets durchlaufen. Da im Beispiel keine Filter angegeben werden, gibt der Selektor alle freigegebenen Budgets im Konto zurück. Um die Anzahl der freigegebenen Budgets im Iterator zu bestimmen, rufen Sie die -Methode des totalNumEntities Iterators auf.

Hinweis

Freigegebene Budgets enthalten keine nicht freigegebenen Budgets (einzelne Kampagnenbudgets).

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

Abrufen eines freigegebenen Budgets nach Namen

Um ein freigegebenes Budget anhand des Namens zu erhalten, rufen Sie zuerst die Methode des budgetsAdsApp-Objekts auf, um den Selektor abzurufen. Die Auswahl enthält eine Reihe von Filtermethoden, mit denen Sie die Liste der Budgets filtern. Verwenden Sie die withCondition -Methode, um die Budgets nach Namen zu filtern. Verwenden Sie beispielsweise , um die Liste nach einem bestimmten Namen zu filtern: withCondition("BudgetName = '<budgetnamegoeshere>'"). Um die Liste nach einem Teilnamen zu filtern, verwenden Sie: withCondition("BudgetName CONTAINS_IGNORE_CASE '<partialnamegoeshere>'"). Beachten Sie, dass bei den Operanden und Operatoren die Groß-/Kleinschreibung beachtet wird.

Rufen Sie als Nächstes die -Methode des Selektors get auf, um den Iterator abzurufen.

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

Abrufen freigegebener Budgets nach ID

Wenn Sie Zugriff auf die ID des freigegebenen Budgets haben, verwenden Sie sie stattdessen. Die Verwendung von IDs zum Abrufen von Entitäten bietet eine bessere Leistung. Verwenden Sie anstelle der withCondition Filtermethode die withIds -Methode. Beispiel: withIds(['12345']).

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

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

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

Abrufen aller Kampagnen, die sich das Budget teilen

Rufen Sie die Kampagnenmethode des Budgets auf, um alle Kampagnen abzurufen, die sich das Budget teilen. Sie können diese Methode nur über ein Budget-Objekt aufrufen, das Sie von BudgetSelector erhalten. Sie können es nicht aufrufen, wenn die Quelle des Budgets die getBudget-Methode der Kampagne ist.

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

Abrufen der Leistungsdaten eines freigegebenen Budgets

Rufen Sie die getStats-Methode des Budgets auf, um die Leistungsmetriken eines freigegebenen Budgets abzurufen. Wenn Sie die Liste der Freigabebudgets erhalten, müssen Sie den Datumsbereich der gewünschten Metrikdaten angeben. Sie können den Datumsbereich mithilfe eines vordefinierten Literals angeben, z. B. LAST_MONTH oder HEUTE, oder mit einem Start- und Enddatum. Um den Datumsbereich anzugeben, verwenden Sie eine der forDateRange Methoden, wenn Sie die Budgets auswählen (siehe BudgetSelector).

Eine Liste der Metriken, auf die Sie zugreifen können, finden Sie im Stats-Objekt . Die Metriken sind die Aggregation aller Kampagnen, die sich das Budget teilen.

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