CampaignAudienceSelector

Contient les méthodes de filtrage et de tri d’une liste d’audiences de campagne. Pour plus d’informations sur les sélecteurs, consultez Sélecteurs.

Exemple d’utilisation :

    // Gets the iterator that iterates all campaigns
    // in the account.
    var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get();

    // Loops through all campaigns in the account.
    while (iterator.hasNext()) {
        var campaign = iterator.next();

        // Gets the iterator that iterates all campaign audiences
        // in the campaign audience.
        var audienceIterator = campaign.targeting().audiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign audiences in the campaign audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

Méthodes

forDateRange(Object dateFrom, Object dateTo)

Applique les dates de début et de fin pour la sélection des métriques de performances.

Spécifiez une plage de dates uniquement si :

• Vous appliquez des conditions ou un ordre qui référence des champs de métrique de performances.
• Vous souhaitez obtenir des données de performances pour les objets que vous sélectionnez. Par exemple, si vous envisagez d’appeler la getStats() méthode .

Vous pouvez spécifier les paramètres de date à l’aide de chaînes ou d’objets. Pour utiliser des chaînes, spécifiez la date au format AAAAMMJJ. Si vous utilisez des objets, créez un objet avec les champs suivants :

• year
• month
• Jour

Par exemple :

var date = {year: 2018, month: 5, day: 13};

Le mois est basé sur un, où 1 est janvier et 12 décembre.

La plage de dates est inclusive. Si vous spécifiez plusieurs plages de dates, seule la dernière plage de dates est utilisée.

Arguments

Retourne

forDateRange(String dateRange)

Applique la plage de dates prédéfinie pour la sélection des métriques de performances.

Spécifiez une plage de dates uniquement si :

• Vous appliquez des conditions ou un ordre qui référence des champs de métrique de performances.
• Vous souhaitez obtenir des données de performances pour les objets que vous sélectionnez. Par exemple, si vous envisagez d’appeler la getStats() méthode .

Si vous spécifiez plusieurs plages de dates, seule la dernière plage de dates est utilisée.

Valeurs de plage de dates prises en charge :

• AUJOURD'HUI
• HIER
• LAST_WEEK
• LAST_BUSINESS_WEEK
• LAST_7_DAYS
• THIS_WEEK_SUN_TODAY
• LAST_14_DAYS
• LAST_30_DAYS
• LAST_WEEK_SUN_SAT
• THIS_MONTH
• LAST_MONTH
• ALL_TIME

Arguments

Retourne

Avoir

Obtient un itérateur utilisé pour itérer dans la liste des audiences de campagne.

Retourne

orderBy(String orderBy)

Applique l’ordre spécifié aux audiences de campagne sélectionnées.

Spécifiez le paramètre orderBy sous la forme « columnName orderDirection » où :

• columnName est l’une des colonnes prises en charge.
• orderDirection est l’ordre dans lequel trier les résultats. Définissez sur ASC pour classer les résultats dans l’ordre croissant ou sur DESC pour classer les résultats dans l’ordre décroissant. La valeur par défaut est ASC.

Par exemple, l’appel suivant retourne les audiences de campagne dans l’ordre croissant par AverageCpc.

selector = selector.orderBy("AverageCpc");

Les sélecteurs prennent en charge le classement des entités par un seul champ. Vous ne pouvez pas classer la liste des entités par champ x, et dans x par champ y, et ainsi de suite. Si vous spécifiez plusieurs orderBy() appels dans une chaîne ou dans des appels de sélecteur distincts, les scripts commandent la liste des entités à l’aide du champ spécifié dans le dernier orderBy() appel. 

Arguments

Retourne

withCondition(String condition)

Applique des critères de filtre aux audiences des campagnes.

Spécifiez le paramètre de condition sous la forme « columnName operator value » où :

• columnName est l’une des colonnes prises en charge. Si columName est défini sur un nom de colonne de métrique de performance, vous devez spécifier une plage de dates à l’aide de forDateRange(String dateRange) ou forDateRange(Object dateFrom, Object dateTo).
• est l’un des opérateurs pris en charge.

Opérateurs

L’opérateur que vous utilisez dépend du type de la colonne. Les opérateurs respectent la casse. Par exemple, utilisez STARTS_WITH au lieu de starts_with.

Opérateurs pour les colonnes qui contiennent des entiers et des valeurs longues :

<
<=
>
>=
=
!=

Opérateurs pour les colonnes qui contiennent des valeurs doubles :

<
>

Opérateurs pour les colonnes qui contiennent des valeurs de chaîne :

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

Opérateurs pour les colonnes qui contiennent des valeurs d’énumération :

=
!=
IN []
NOT_IN []

Opérateurs pour les colonnes qui contiennent un tableau de chaînes :

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

Colonnes prises en charge

Colonnes prises en charge pour le filtrage d’audience de campagne. Les noms respectent la casse.

Voici les colonnes de métriques de performances que vous pouvez spécifier.

Voici les propriétés d’entité que vous pouvez spécifier.

Arguments

Retourne

withIds(string[] ids)

Obtient les audiences de campagne avec les ID spécifiés.

Vous pouvez appliquer une ou plusieurs conditions à un sélecteur. Une chaîne de conditions est considérée comme une opération AND. Par exemple, l’entité est sélectionnée uniquement si la condition A a la valeur true ET si la condition B a la valeur true. Par exemple, l’appel suivant sélectionne uniquement l’audience de campagne 33333.

var selector = AdsApp.adGroups()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Arguments

Retourne

withLimit(int limit)

Obtient les n premières audiences de campagne qui correspondent aux critères de sélection.

Arguments

Retourne