Exemples de script pour la gestion des campagnes

Article
12/21/2023

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

Obtenir toutes les campagnes

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

function main() {
    // Gets all campaigns in the account.
    var iterator = AdsApp.campaigns().get();

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

Obtenir une campagne par nom

Pour obtenir une campagne par son nom, appelez d’abord la méthode de campaigns 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 campagnes. Utilisez la withCondition méthode pour filtrer les campagnes pour un nom de campagne spécifique. 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. Les noms de campagne étant uniques, vous n’en récupérerez qu’un, s’il existe.

function main() {
    var campaignName = 'CAMPAIGN NAME GOES HERE';

    var iterator = AdsApp.campaigns()
        .withCondition(`Name = '${campaignName}'`)
        .get();

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

Obtenir la campagne par ID

Si vous avez accès à l’ID de la campagne, 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 campaignId = '12345';

    var iterator = AdsApp.campaigns()
        .withIds([campaignId])
        .get();

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

Obtenir les données de performances d’une campagne

Pour obtenir les métriques de performances d’une campagne, appelez la méthode getStats de la campagne. Lorsque vous obtenez la campagne, 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 la campagne (voir CampaignSelector).

Pour obtenir la liste des métriques accessibles, consultez l’objet Stats .

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

    // Get the campaign. You need to specify the date range of the
    // performance data you want to get.
    var iterator = AdsApp.campaigns()
        .withIds([campaignId])
        .forDateRange('LAST_WEEK')
        .get();

    // If the campaign is found, log some metrics.
    while (iterator.hasNext()) {
        var campaign = iterator.next();
        var metrics = campaign.getStats(); // Gets the performance metrics.
    }
}

Suspendre une campagne

Pour suspendre une campagne, appelez la méthode de la pause campagne. Pour l’activer à nouveau, appelez la méthode de la enable campagne. Pour déterminer la status de la campagne, appelez les méthodes , isPausedet isRemoved de isEnabledla campagne.

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

    var iterator = AdsApp.campaigns()
        .withIds([campaignId])
        .get();

    // If the campaign is found, pause it.
    while (iterator.hasNext()) {
        var campaign = iterator.next();
        campaign.pause();
    }
}

Partager via