Partager via

AdSelector

  • Article

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

Méthodes

Nom de la méthode Type renvoyé Description
forDateRange(Object dateFrom, Object dateTo) AdSelector Applique les dates de début et de fin pour la sélection des métriques de performances.
forDateRange(string dateRange) AdSelector Applique la plage de dates prédéfinie pour la sélection des métriques de performances.
get AdIterator Obtient un itérateur utilisé pour itérer dans la liste des annonces.
orderBy(string orderBy) AdSelector Applique le classement spécifié aux annonces sélectionnées.
withCondition(string condition) AdSelector Applique des critères de filtre aux annonces.
withIds(string[] ids) AdSelector Obtient des publicités avec les ID spécifiés.
withLimit(int limit) AdSelector Obtient les n premières annonces qui correspondent aux critères de sélection.

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

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.
dateTo Objet Date de fin de la plage de dates qui spécifie les données de performances à inclure dans le sélecteur.

Retourne

Type Description
AdSelector 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 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

Nom Type Description
dateRange Chaîne 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 respecte la casse.

Retourne

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

Avoir

Obtient un itérateur utilisé pour itérer dans la liste des annonces.

Retourne

Type Description
AdIterator Itérateur utilisé pour itérer au sein des annonces sélectionnées.

orderBy(String orderBy)

Applique le classement spécifié aux annonces 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 des annonces 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

Nom Type Description
Orderby string Ordre à appliquer.

Retourne

Type Description
AdSelector Sélecteur avec classement appliqué.

withCondition(String condition)

Applique des critères de filtre aux annonces.

Spécifiez le paramètre de condition sous la forme « columnName operator value » 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 des publicités. Les noms des colonnes 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")
ClickConversionRate double withCondition("ClickConversionRate > 0.25")
Clics long withCondition("Clicks >= 33")
ConvertedClicks long withCondition("ConvertedClicks >= 10")
Coût double withCondition("Cost > 3.25")

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

Le CTR étant dans la plage 0..1, 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
Statut Énumération Le status de l’annonce. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • ENLEVÉ
Cet exemple retourne uniquement les publicités activées.

withCondition("Status = ENABLED")
Type Énumération Type dérivé de l’annonce. Les valeurs possibles respectant la casse sont les suivantes :
  • EXPANDED_TEXT_AD
Cet exemple retourne uniquement des annonces textuelles développées.

withCondition("Type = EXPANDED_TEXT_AD")
CombinedApprovalStatus string Le status d’approbation de l’annonce. Les valeurs possibles respectant la casse sont les suivantes :
  • APPROUVÉ
  • APPROVED_LIMITED
  • UNDER_REVIEW
  • DÉSAPPROUVÉ
Pour plus d’informations sur ces valeurs, consultez Approbation éditoriale status valeurs.

Cet exemple retourne des publicités qui nécessitent une attention particulière.

withCondition("CombinedApprovalStatus IN ['APPROVED_LIMITED', 'DISAPPROVED']")
CreativeFinalUrls chaîne URL finale de l’annonce.

withCondition("CreativeFinalUrls CONTAINS_IGNORE_CASE 'contoso.com'")
AdGroupName string Nom du groupe d’annonces auquel appartiennent les annonces.

withCondition("AdGroupName CONTAINS_IGNORE_CASE 'truck'")
AdGroupStatus Énumération Status du groupe d’annonces auquel appartiennent les annonces. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • ENLEVÉ
Cet exemple retourne uniquement les annonces dont le groupe d’annonces parent est suspendu.

withCondition("AdGroupStatus = PAUSED")
CampaignName string Nom de la campagne à laquelle appartiennent les publicités.

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus Énumération La status de la campagne à laquelle appartiennent les publicités. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • ENLEVÉ
Cet exemple retourne uniquement les publicités dont la campagne parente est suspendue.

withCondition("CampaignStatus = PAUSED")
LabelNames jeu de chaînes Liste d’un ou de plusieurs noms d’étiquette respectant la casse. Utilisez pour obtenir des publicités associées aux étiquettes nommées.

withCondition("LabelNames CONTAINS_ANY ['bar', 'foo']")
ID Entier long ID de la publicité à tester. Par exemple, vous pouvez utiliser cette colonne pour case activée pour les publicités dont les ID sont supérieurs à l’ID spécifié.

withCondition('Id > 1234')

Arguments

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

Retourne

Type Description
AdSelector Sélecteur avec la condition appliquée.

withIds(string[] ids)

Obtient des publicités 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 la publicité 33333.

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

Arguments

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

Retourne

Type Description
AdSelector Sélecteur avec les ID appliqués.

withLimit(int limit)

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

Arguments

Nom Type Description
limit int Nombre d’annonces à retourner. Le nombre réel peut être inférieur.

Retourne

Type Description
AdSelector Sélecteur avec limite appliquée.

Voir aussi

AdsApp.ads()