REST Resource: customers.userLists

Ressource: UserList

Définit une liste d'utilisateurs gérée par Ads Data Hub.

Représentation JSON 
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
Champs
name

string

Uniquement en sortie. Nom qui identifie de manière unique une liste d'utilisateurs Ads Data Hub. Il se présente sous la forme customer/[customerId]/userLists/[userListId]
userListId

string (int64 format)

Uniquement en sortie. ID de la liste d'utilisateurs. Ce champ est généré par le service et permet de renseigner la liste des utilisateurs.
adsDataCustomerId

string (int64 format)

Immuable. Numéro client Ads Data Hub associé à cette liste d'utilisateurs. Cet identifiant doit être spécifié en tant que adsAdsCustomerId lorsque vous exécutez des tâches UserListQuery à l'aide de cette liste d'utilisateurs. S'il est absent, le client parent sera utilisé. Une fois la liste créée, vous ne pourrez plus modifier ce paramètre.
title

string

Obligatoire. Titre de la liste d'utilisateurs, qui est unique pour l'élément adsDataCustomerId spécifié.
description

string

Obligatoire. Description de la liste d'utilisateurs.
type

enum (UserListType)

Uniquement en sortie. Les valeurs de type "UserList" doivent être cohérentes avec celles de "userList". Cette valeur est en lecture seule et sera accessible pour les requêtes get/list.
createEmail

string

Uniquement en sortie. Adresse e-mail de l'utilisateur ayant créé cette liste d'utilisateurs.
listSize

string (int64 format)

Uniquement en sortie. Nombre d'utilisateurs dans la liste des utilisateurs. La mise à jour de la taille de la liste peut être retardée.
populateTime

string (Timestamp format)

Uniquement en sortie. Heure du dernier remplissage de la liste.

Horodatage au format RFC3339 UTC "Zulu" avec une résolution de nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Uniquement en sortie. État de la liste d'utilisateurs (actif/supprimé). Cette valeur est en lecture seule et sera accessible pour les requêtes get/list.

Champ d'union user_list. Configuration supplémentaire en fonction du type de liste d'utilisateurs.

Vous devez en définir un seul. user_list ne peut être qu'un des éléments suivants :
frequencyList

object (FrequencyBasedListInfo)

Liste d'utilisateurs pour la limitation de la fréquence d'exposition.
remarketingList

object (RemarketingListInfo)

Liste de remarketing.

Type de liste d'utilisateurs

Genre de la liste d'utilisateurs. La construction et l'utilisation de la liste d'utilisateurs au moment du ciblage dépendent de cette énumération. Une fois créée, son type ne peut pas être modifié.

Enums
USER_LIST_TYPE_UNSPECIFIED Valeur par défaut: ne doit pas être utilisée.
REMARKETING Audiences de remarketing créées avec des requêtes SQL sur ADH La liste de remarketing peut être utilisée pour le ciblage positif et négatif.
FREQUENCY_BASED Audiences à fréquence limitée. Les audiences de ce type sont limitées au ciblage à exclure.

Fréquence basée sur la liste

Métadonnées pour la liste d'utilisateurs basée sur la fréquence.

Représentation JSON 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
Champs
dv360LineitemIds[]
(deprecated)

string (int64 format)

ID des éléments de campagne DV360 qui contribuent à la fréquence.
cmCampaignIds[]
(deprecated)

string (int64 format)

ID des campagnes CM qui contribuent à la fréquence.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

ID des campagnes Google Ads qui contribuent à la fréquence.
eventMatchers[]

object (EventMatcher)

Événements qui contribuent à la fréquence. Lors de la création de listes d'utilisateurs basées sur la fréquence, il est préférable d'utiliser eventMatchers pour spécifier les événements qui contribuent à la fréquence. Les variables dv360LineitemIds, cmCampaignIds et googleAdsCampaignIds sont utilisées si la valeur eventMatchers est vide.
frequencyConstraint

object (FrequencyConstraint)

Décrit quand un utilisateur est ajouté à la liste.
slidingWindowDays

integer

Obligatoire. Taille de la fenêtre temporelle utilisée pour calculer la fréquence de chaque événement. Mesure en jours

Match Matcher

Événement générique qui contribue à la fréquence.

Représentation JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
Champs
matchType

enum (MatchType)

Type de contrainte qui sera inclus dans le nombre d'expositions.
value

string

Valeur de la contrainte. Par exemple, si vous spécifiez un ID de campagne Google Ads de 1 234, matchType indiquera GOOGLE_ADS_CAMPAIGN_ID et la valeur sera '1234'. Les événements associés à cette valeur pour le type de correspondance correspondant seront inclus dans le nombre d'expositions.

MatchType

Types de contraintes compatibles avec le nombre d'expositions. D'autres types pourront être ajoutés à cette énumération à l'avenir pour prendre en charge des contraintes supplémentaires. Vous pouvez spécifier un filtre sur le type de correspondance dans "DedescribeValidFréquenceLimitingEventMatchersRequest" pour limiter les correspondances trouvées dans les résultats à celles qui sont compatibles avec votre API. Par exemple, si vous définissez le filtre comme "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" ne renverra que les événements de ces deux types.

Enums
MATCH_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
CM_CAMPAIGN_ID Type de contrainte représentant l'ID de campagne Campaign Manager.
DV360_INSERTION_ORDER_ID Type de contrainte représentant l'ID de l'ordre d'insertion DV360.
DV360_LINE_ITEM_ID Type de contrainte représentant l'ID de l'élément de campagne DV360.
GOOGLE_ADS_CAMPAIGN_ID Type de contrainte représentant l'ID de campagne Google Ads.

Contrainte de fréquence

Spécifiez le nombre minimal d'événements pour la limite.

Représentation JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
Champs
eventType

enum (EventType)

Immuable. Type d'événement qui sera pris en compte dans seuilEventCount. Pour le moment, nous ne représentons pas explicitement les contraintes de comparaison en supposant que toutes les valeurs soient GREATER_OR_EQUAL.
thresholdEventCount

string (int64 format)

Obligatoire. Chaque utilisateur doit apparaître dans au moins K événements.

EventType

Types d'événements permettant de comptabiliser la fréquence.

Enums
EVENT_TYPE_UNSPECIFIED Valeur par défaut: ne doit pas être utilisée.
IMPRESSIONS Comptabilise toutes les impressions.

Infos de liste de remarketing

Métadonnées pour les listes de remarketing.

Représentation JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
Champs
userListQuery

string

Immuable. Ressource de requête de la liste d'utilisateurs Ads Data Hub qui spécifie la manière dont les utilisateurs sont ajoutés à cette audience. Sous la forme: customers/[customerId]/userListQuery/[query_resource_id]
populatingUserListQueries[]

string

Uniquement en sortie. Ressources de requête de la liste d'utilisateurs Ads Data Hub qui ont renseigné cette audience. Il s'agit d'un ancien champ destiné à accepter les listes d'utilisateurs remplies par plusieurs requêtes avant l'entrée en vigueur des restrictions 1:1 "userlist:query". Sous la forme: customers/[customerId]/userListQuery/[query_resource_id]

State

État de la liste des utilisateurs.

Enums
STATE_UNSPECIFIED Valeur par défaut / non définie.
STATE_ACTIVE La liste des utilisateurs est toujours ouverte et active.
STATE_DELETED La liste d'utilisateurs est marquée comme supprimée et ne doit plus être utilisée pour le ciblage

Méthodes

addEventMatchers

 Ajoute des outils de mise en correspondance des événements à une liste d'utilisateurs basée sur la fréquence.

addRecipients

 Ajoutez des entités aux destinataires d'une liste d'utilisateurs gérée par Ads Data Hub.

create

 Crée une liste d'utilisateurs gérée par Ads Data Hub.

delete

 Supprimez la liste d'utilisateurs gérée par Ads Data Hub demandée.

generateFrequencyListMemberships

 Générer des adhésions pour la liste d'utilisateurs

get

 Récupère la liste des utilisateurs gérés par Ads Data Hub, qui est demandée.

list

 Répertorie les listes d'utilisateurs gérées par le client Ads Data Hub spécifié.

patch

 Met à jour la liste d'utilisateurs gérée par Ads Data Hub demandée.

removeRecipients

 Supprime les entités des destinataires d'une liste d'utilisateurs gérée par Ads Data Hub.