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

Nom de la méthode Type renvoyé Description
forDateRange(Object dateFrom, Object dateTo) CampaignAudienceSelector Applique les dates de début et de fin de la sélection des métriques de performances.
forDateRange(string dateRange) CampaignAudienceSelector Applique la plage de dates prédéfinie pour la sélection des métriques de performances.
get CampaignAudienceIterator Permet d’utiliser un itérateur pour itérer dans la liste des audiences de la campagne.
orderBy(string orderBy) CampaignAudienceSelector Applique l’ordre spécifié aux audiences de campagne sélectionnées.
withCondition(string condition) CampaignAudienceSelector Applique des critères de filtre aux audiences de campagne.
withIds(string[] ids) CampaignAudienceSelector Obtient les audiences de campagne avec les ID spécifiés.
withLimit(int limit) CampaignAudienceSelector Obtient les n meilleures audiences de campagne qui correspondent aux critères de sélection.

forDateRange(Object dateFrom, Object dateTo)

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

Spécifiez une plage de dates uniquement si :

  • Vous appliquez des conditions ou un ordre qui font référence à des champs de métrique de performances.
  • Vous souhaitez obtenir les données de performances des objets que vous sélectionnez. Par exemple, si vous prévoyez 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 une base, où 1 correspond à 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

Nom Type Description
dateFrom Objet Date de début de la plage de dates qui spécifie les données de performances à inclure dans le sélecteur. Spécifiez la date à l’aide d’une chaîne au format AAAAMMJJ ou un objet au format {année : 2020, mois : 12, jour : 31}.
dateTo Objet Date de fin de la plage de dates qui spécifie les données de performances à inclure dans le sélecteur. Spécifiez la date à l’aide d’une chaîne au format AAAAMMJJ ou un objet au format {année : 2020, mois : 12, jour : 1}.

Retourne

Type Description
CampaignAudienceSelector Sélecteur avec plage de dates appliquée.

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 font référence à des champs de métrique de performances.
  • Vous souhaitez obtenir les données de performances des objets que vous sélectionnez. Par exemple, si vous prévoyez 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 :

  • TODAY
  • 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

Nom Type Description
dateRange String Chaîne de plage de dates prédéfinie qui spécifie les données de performances à inclure dans le sélecteur. La chaîne de plage de dates prédéfinie est sensible à la casse. Les valeurs possibles respectant la casse sont : 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.

Retourne

Type Description
CampaignAudienceSelector Sélecteur avec plage de dates appliquée.

Obtenir

Permet d’utiliser un itérateur pour itérer dans la liste des audiences de la campagne.

Retourne

Type Description
CampaignAudienceIterator Itérateur utilisé pour itérer dans les audiences de campagne sélectionnées.

orderBy(String orderBy)

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

Spécifiez le paramètre orderBy au format « columnName orderDirection » où :

  • columnName est l’une des colonnes prises en charge.
  • orderDirection est l’ordre dans lequel trier les résultats. Réglez sur ASC pour classer les résultats dans l’ordre croissant ou 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 la 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 au sein de x par champ y, etc. Si vous spécifiez plusieurs orderBy() appels dans une chaîne ou dans des appels de sélecteur distincts, Scripts ordonne la liste des entités à l’aide du champ spécifié dans le dernier orderBy() appel. 

Arguments

Nom Type Description
orderBy string L’ordre à appliquer.

Retourne

Type Description
CampaignAudienceSelector avec classement appliqué.

withCondition(condition de chaîne)

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

Spécifiez le paramètre de condition au format « valeur de l’opérateur columnName » où :

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 de l’audience des campagnes. Les noms sont sensibles à la casse.

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

Column Type Exemple
AbsoluteTopImpressionRate double withCondition("AbsoluteTopImpressionRate > 0.25")
AverageCpc double withCondition("AverageCpc < 2.75")
AverageCpm double withCondition("AverageCpm > 0.65")
Taux de conversion des clics double withCondition("ClickConversionRate > 0.25")
Clics long withCondition("Clicks >= 33")
ConvertedClicks long withCondition("ConvertedClicks >= 10")
Cost double withCondition("Cost > 3.25")

Le coût est exprimé dans la devise du compte.
Ctr double withCondition("Ctr > 0.05")

Le CTR est de l’ordre de 0..1, donc utilisez 0.05 pour un CTR de 5 %.
Impressions long withCondition("Impressions > 10")
TopImpressionRate double withCondition("TopImpressionRate > 0.25")

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

Column Type Exemple
ID d’audience long ID de l’audience associée.

withCondition("AudienceId = 123456789")
Nom de campagne string Nom de la campagne de l’association.

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus (CampaignStatus) énumération Le status de la campagne de l’association. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • SUPPRIMÉ
Cet exemple retourne uniquement les audiences de campagne dont la campagne parente est suspendue.

withCondition("CampaignStatus = PAUSED")
Statut énumération Le status de l’association. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • SUPPRIMÉ
Cet exemple retourne uniquement les audiences de campagne activées.

withCondition("Status = ENABLED")
UserListName string Nom de l’audience associée.

withCondition("UserListName = 'foo'")

Arguments

Nom Type Description
Condition physique string Condition à appliquer au sélecteur.

Retourne

Type Description
CampaignAudienceSelector avec la condition appliquée.

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 ET. Par exemple, l’entité est sélectionnée uniquement si la condition A est vraie ET la condition B est vraie. 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

Nom Type Description
Ids string[] Un tableau d’ID d’audience de campagne. Pour connaître les limites, consultez Limites d’exécution de script.

Retourne

Type Description
CampaignAudienceSelector avec les ID appliqués.

withLimit(int limit)

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

Arguments

Nom Type Description
limit int Nombre d’audiences de campagne à renvoyer. Le nombre réel peut être inférieur.

Retourne

Type Description
CampaignAudienceSelector Sélecteur avec limite appliquée.
  • Dernière mise à jour :