Partager via

KeywordSelector

  • Article

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

Exemple d’utilisation :

    var iterator = AdsApp.keywords()
        .withCondition("AdGroupName = 'AD GROUP NAME GOES HERE'")
        .withCondition("CampaignName = 'CAMPAIGN NAME GOES HERE'")
        .get();

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

Méthodes

Nom de la méthode Type renvoyé Description
forDateRange(Object dateFrom, Object dateTo) KeywordSelector Applique les dates de début et de fin pour la sélection des métriques de performances.
forDateRange(string dateRange) KeywordSelector Applique la plage de dates prédéfinie pour la sélection des métriques de performances.
get KeywordIterator Obtient un itérateur utilisé pour itérer au sein de la liste des mots clés.
orderBy(string orderBy) KeywordSelector Applique l’ordre spécifié aux mots clés sélectionnés.
withCondition(string condition) KeywordSelector Applique des critères de filtre aux mots clés.
withIds(string[] ids) KeywordSelector Obtient des mots clés avec les ID spécifiés.
withLimit(int limit) KeywordSelector Obtient les n premiers mots clés 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
KeywordSelector 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.

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

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.

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
KeywordSelector Sélecteur avec plage de dates appliquée.

Avoir

Obtient un itérateur utilisé pour itérer au sein de la liste des mots clés.

Retourne

Type Description
KeywordIterator Itérateur utilisé pour itérer au sein des mots clés sélectionnés.

orderBy(string orderBy)

Applique l’ordre spécifié aux mots clés sélectionnés.

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 résultats 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
KeywordSelector Sélecteur avec classement appliqué.

withCondition(String condition)

Applique des critères de filtre aux mots clés.

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 pour le filtrage mot clé. Les noms des colonnes sont sensibles à la casse.

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

Column Type Exemple Filtre de l’interface utilisateur web Microsoft Advertising
AbsoluteTopImpressionRate double withCondition("AbsoluteTopImpressionRate > 0.25") Abs. Top Impr. Rate
AverageCpc double withCondition("AverageCpc < 2.75") Avg. CPC
AverageCpm double withCondition("AverageCpm > 0.65") Avg. CPM
ClickConversionRate double withCondition("ClickConversionRate > 0.25") Taux conv.
Clics long withCondition("Clicks >= 33") Clics
ConvertedClicks long withCondition("ConvertedClicks >= 10") Conv.
Coût double withCondition("Cost > 3.25")

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

Le CTR étant dans la plage 0..1, utilisez 0,05 pour un CTR de 5 %.		 CTR
Impressions long withCondition("Impressions > 10") Impr.
TopImpressionRate double withCondition("TopImpressionRate > 0.25") Top Impr. Rate

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

Column Type Exemple Filtre de l’interface utilisateur web Microsoft Advertising
Statut Énumération Le mot clé est status. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • ENLEVÉ
withCondition("Status = ENABLED")		 Statut
CombinedApprovalStatus string Le status d’approbation du mot clé. 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 mots clés qui nécessitent une attention particulière.

withCondition("CombinedApprovalStatus IN ['APPROVED_LIMITED', 'DISAPPROVED']")
Texte string Texte du mot clé. Incluez uniquement le texte du mot clé. N’incluez pas le type de correspondance du mot clé dans le texte. Par exemple, si l’mot clé correspond exactement mot clé comme [books], utilisez books et non [books].

withCondition("Text STARTS_WITH 'flowers'")		 Texte du mot clé
KeywordMatchType Énumération Type de correspondance du mot clé. Les valeurs possibles respectant la casse sont les suivantes :
  • LARGE
  • EXACTE
  • PHRASE
withCondition("KeywordMatchType = EXACT")		 Type de correspondance
MaxCpc double Le montant maximal de l’offre DU MOT CLÉ. Le CPP est dans la devise du compte.

withCondition("MaxCpc > 0.40")		 Offre
DestinationUrl string withCondition("DestinationUrl STARTS_WITH 'http://www.contoso.com'") Destination URL
FinalUrls string withCondition("FinalUrls CONTAINS 'http://www.contoso.com'")
QualityScore int withCondition("QualityScore > 5") Qual. Score
FirstPageCpc double Montant moyen facturé à chaque fois qu’un annonceur clique sur son annonce lorsqu’elle s’affiche sur la barre latérale. Par exemple, si un annonceur a payé un total de 48,35 $ pour 300 clics, le COÛT moyen de l’annonceur est de 0,16 $. Utilisez ces informations pour décider s’il faut augmenter votre enchère de mot clé afin d’améliorer les chances que votre annonce s’affiche sur la barre latérale. Le CPP est dans la devise du compte.

withCondition("FirstPageCpc > 6.00")		 Est. enchère de première page
TopOfPageCpc double Montant moyen facturé à chaque fois qu’un annonceur clique sur son annonce lorsqu’elle apparaît au-dessus des résultats de recherche organiques. Par exemple, si un annonceur a payé un total de 48,35 $ pour 300 clics, le COÛT moyen de l’annonceur est de 0,16 $. Utilisez ces informations pour vous aider à décider s’il faut augmenter votre mot clé enchère afin d’améliorer les chances que votre annonce s’affiche au-dessus des résultats de recherche organiques. Le CPP est dans la devise du compte courant.

withCondition("TopOfPageCpc > 8.00")		 Meilleure position
AdGroupName string Nom du groupe d’annonces qui contient les mots clés.

withCondition("AdGroupName = 'foo'")
AdGroupStatus Énumération La status du groupe d’annonces. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • ENLEVÉ
withCondition("AdGroupStatus = ENABLED")
CampaignName string Nom de la campagne qui contient les mots clés.

withCondition("CampaignName = 'bar'")
CampaignStatus Énumération La campagne est status. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • ENLEVÉ
withCondition("CampaignStatus = ENABLED")
LabelNames jeu de chaînes Liste d’un ou de plusieurs noms d’étiquette respectant la casse. Utilisez pour obtenir des mots clés associés aux étiquettes nommées.

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

withCondition('Id > 1234')

Arguments

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

Retourne

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

withIds(string[] ids)

Obtient des mots clé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 mot clé 33333.

AdsApp.keywords()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

Arguments

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

Retourne

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

withLimit(int limit)

Obtient les n premiers mots clés qui correspondent aux critères de sélection.

Arguments

Nom Type Description
limit int Nombre de mots clés à retourner. Le nombre réel peut être inférieur.

Retourne

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

Voir aussi