Partager via


CampaignExcludedAudienceSelector

Contient les méthodes de filtrage et de tri d’une liste d’audiences exclues 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 excluded audiences
        // in the campaign excluded audience.
        var audienceIterator = campaign.targeting().excludedAudiences()
            .withLimit(10)
            .withIds("123456789")
            .get();
    
        // Loops through all campaign excluded audiences in the campaign excluded audience.
        while (audienceIterator.hasNext()) {
            var audience = audienceIterator.next();
        }
    }

Méthodes

Nom de la méthode Type renvoyé Description
get CampaignExcludedAudienceIterator Obtient un itérateur utilisé pour itérer dans la liste des audiences exclues de campagne.
orderBy(string orderBy) CampaignExcludedAudienceSelector Applique le classement spécifié aux audiences exclues de la campagne sélectionnée.
withCondition(string condition) CampaignExcludedAudienceSelector Applique des critères de filtre aux audiences exclues de la campagne.
withIds(string[] ids) CampaignExcludedAudienceSelector Obtient les audiences exclues de campagne avec les ID spécifiés.
withLimit(int limit) CampaignExcludedAudienceSelector Obtient les n premières audiences exclues de campagne qui correspondent aux critères de sélection.

Avoir

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

Retourne

Type Description
CampaignExcludedAudienceIterator Itérateur utilisé pour itérer dans les audiences exclues de la campagne sélectionnée.

orderBy(String orderBy)

Applique le classement spécifié aux audiences exclues de la campagne sélectionnée.

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 exclues 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

Nom Type Description
Orderby string Ordre à appliquer.

Retourne

Type Description
CampaignExcludedAudienceSelector Sélecteur avec classement appliqué.

withCondition(String condition)

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

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 d’audiences exclues de campagne. Les noms respectent la casse.

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

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

withCondition("AudienceId = 123456789")
CampaignName chaîne Nom de la campagne de l’association.

withCondition("CampaignName CONTAINS_IGNORE_CASE 'truck'")
CampaignStatus Énumération Le status de la campagne de l’association. Les valeurs possibles respectant la casse sont les suivantes :
  • ACTIVÉ
  • PAUSE
  • ENLEVÉ
Cet exemple retourne uniquement les audiences exclues 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
  • ENLEVÉ
Cet exemple retourne uniquement les audiences exclues de campagne activées.

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

withCondition("UserListName = 'foo'")

Arguments

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

Retourne

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

withIds(string[] ids)

Obtient les audiences exclues 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 le public exclu de la campagne 33333.

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

Arguments

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

Retourne

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

withLimit(int limit)

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

Arguments

Nom Type Description
limit int Nombre de campagnes exclues les audiences à retourner. Le nombre réel peut être inférieur.

Retourne

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