REST Resource: accountTypes.accounts.userLists

Ressource : UserList

Ressource de liste d'utilisateurs.

Représentation JSON 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
Champs
name

string

Identifiant. Nom de ressource de la liste d'utilisateurs. Format : accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

Uniquement en sortie. ID unique de la liste d'utilisateurs.
readOnly

boolean

Uniquement en sortie. Option indiquant si un utilisateur peut modifier une liste.
membershipDuration

string (Duration format)

Facultatif. Durée pendant laquelle un utilisateur reste dans la liste des utilisateurs. Les durées valides sont des multiples exacts de 24 heures (86 400 secondes). Si vous fournissez une valeur qui n'est pas un multiple exact de 24 heures, une erreur INVALID_ARGUMENT sera générée.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
accessReason

enum (AccessReason)

Uniquement en sortie. Raison pour laquelle ce compte a été autorisé à accéder à la liste.
sizeInfo

object (SizeInfo)

Uniquement en sortie. Nombre estimé de membres de cette liste d'utilisateurs dans différents réseaux cibles.
targetNetworkInfo

object (TargetNetworkInfo)

Facultatif. Informations sur l'éligibilité pour différents réseaux cibles.
displayName

string

Obligatoire. Nom à afficher de la liste des utilisateurs.
description

string

Facultatif. Description de la liste d'utilisateurs.
membershipStatus

enum (MembershipStatus)

Facultatif. État d'appartenance à cette liste d'utilisateurs.
integrationCode

string

Facultatif. ID provenant d'un système externe. Les vendeurs de listes d'utilisateurs l'utilisent pour corréler les ID dans leurs systèmes.
closingReason

enum (ClosingReason)

Uniquement en sortie. Motif de la clôture de l'état d'appartenance à cette liste d'utilisateurs.
accountAccessStatus

enum (AccessStatus)

Facultatif. Indique si ce partage est toujours activé. Lorsque la liste d'utilisateurs est partagée avec le compte, ce champ est défini sur ENABLED. Le propriétaire de la liste d'utilisateurs peut ensuite décider de révoquer le partage et de le rendre DISABLED.
Champ d'union user_list_info. Informations supplémentaires sur la liste d'utilisateurs. user_list_info ne peut être qu'un des éléments suivants :
ingestedUserListInfo

object (IngestedUserListInfo)

Facultatif. Représente une liste d'utilisateurs renseignée par les données ingérées par l'utilisateur.

MembershipStatus

État de la liste d'utilisateurs.

Enums
MEMBERSHIP_STATUS_UNSPECIFIED Non spécifié.
OPEN Ouverte : la liste d'utilisateurs s'enrichit de membres et peut être ciblée.
CLOSED État "Fermée" : aucun nouveau membre n'est ajouté.

ClosingReason

Indique la raison pour laquelle la liste des utilisateurs a été fermée. Cette énumération n'est utilisée que lorsqu'une liste est fermée automatiquement par le système.

Enums
CLOSING_REASON_UNSPECIFIED Non spécifié.
UNUSED La liste d'utilisateurs a été fermée, car elle n'a pas été utilisée récemment pour le ciblage. Pour en savoir plus, consultez https://support.google.com/google-ads/answer/2472738.

AccessReason

Énumération décrivant les raisons possibles d'accès.

Enums
ACCESS_REASON_UNSPECIFIED Non spécifié.
OWNED La ressource appartient à l'utilisateur.
SHARED La ressource est partagée avec l'utilisateur.
LICENSED L'utilisateur dispose de la licence pour la ressource.
SUBSCRIBED L'utilisateur s'est abonné à la ressource.
AFFILIATED La ressource est accessible à l'utilisateur.

AccessStatus

Indique si ce client a toujours accès à la liste.

Enums
ACCESS_STATUS_UNSPECIFIED Non spécifié.
ENABLED L'accès est activé.
DISABLED L'accès est désactivé.

SizeInfo

Nombre estimé de membres de cette liste d'utilisateurs dans différents réseaux cibles.

Représentation JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
Champs
displayNetworkMembersCount

string (int64 format)

Uniquement en sortie. Nombre estimé de membres de cette liste d'utilisateurs sur le Réseau Display de Google.
searchNetworkMembersCount

string (int64 format)

Uniquement en sortie. Nombre estimé de membres de cette liste d'utilisateurs dans le domaine google.com. Voici les membres disponibles pour le ciblage dans les campagnes sur le Réseau de Recherche.
youtubeMembersCount

string (int64 format)

Uniquement en sortie. Nombre estimé de membres dans cette liste d'utilisateurs sur YouTube.
gmailMembersCount

string (int64 format)

Uniquement en sortie. Nombre estimé de membres de cette liste d'utilisateurs dans Gmail.

TargetNetworkInfo

Informations sur l'éligibilité pour différents réseaux cibles.

Représentation JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
Champs
eligibleForDisplay

boolean

Uniquement en sortie. Indique que cette liste d'utilisateurs est éligible au Réseau Display de Google.

IngestedUserListInfo

Représente une liste d'utilisateurs renseignée à partir des données fournies par l'utilisateur.

Représentation JSON 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
Champs
uploadKeyTypes[]

enum (UploadKeyType)

Obligatoire. Immuable. Types de clés d'importation de cette liste d'utilisateurs.
contactIdInfo

object (ContactIdInfo)

Facultatif. Informations supplémentaires lorsque CONTACT_ID fait partie des uploadKeyTypes.
mobileIdInfo

object (MobileIdInfo)

Facultatif. Informations supplémentaires lorsque MOBILE_ID fait partie des uploadKeyTypes.
userIdInfo

object (UserIdInfo)

Facultatif. Informations supplémentaires lorsque USER_ID fait partie des uploadKeyTypes.
pairIdInfo

object (PairIdInfo)

Facultatif. Informations supplémentaires lorsque PAIR_ID fait partie des uploadKeyTypes.

Cette fonctionnalité n'est disponible que pour les partenaires de données.
pseudonymousIdInfo

object (PseudonymousIdInfo)

Facultatif. Les informations supplémentaires pour PSEUDONYMOUS_ID font partie des uploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

Facultatif. Informations supplémentaires pour les audiences partenaires.

Cette fonctionnalité n'est disponible que pour les partenaires de données.

UploadKeyType

Énumération contenant les types de clés d'importation possibles d'une liste d'utilisateurs.

Enums
UPLOAD_KEY_TYPE_UNSPECIFIED Non spécifié.
CONTACT_ID Informations sur les clients, telles que leur adresse e-mail, leur numéro de téléphone ou leur adresse physique.
MOBILE_ID Identifiants publicitaires pour mobile.
USER_ID ID utilisateur fournis par des tiers.
PAIR_ID ID de rapprochement de l'identité des annonceurs pour les éditeurs.
PSEUDONYMOUS_ID ID de plate-forme de gestion des données : - ID utilisateur Google ; - ID fourni par le partenaire ; - ID fourni par l'éditeur ; - IDFA iOS ; - Identifiant publicitaire Android ; - ID Roku ; - ID Amazon Fire TV ; - ID Xbox ou Microsoft

ContactIdInfo

Informations supplémentaires lorsque CONTACT_ID fait partie des uploadKeyTypes.

Représentation JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
Champs
matchRatePercentage

integer

Uniquement en sortie. Taux de correspondance pour les listes d'utilisateurs pour le ciblage par liste de clients.
dataSourceType

enum (DataSourceType)

Facultatif. Immuable. Source des données importées

DataSourceType

Indique la source des données importées.

Enums
DATA_SOURCE_TYPE_UNSPECIFIED Non spécifié.
DATA_SOURCE_TYPE_FIRST_PARTY Les données importées sont des données first party.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU Les données importées proviennent d'un organisme de crédit tiers.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE Les données importées proviennent d'un fichier d'électeurs tiers.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA Les données importées sont des données de partenaires tiers.

MobileIdInfo

Informations supplémentaires lorsque MOBILE_ID fait partie des uploadKeyTypes.

Représentation JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
Champs
dataSourceType

enum (DataSourceType)

Facultatif. Immuable. Source des données importées.
keySpace

enum (KeySpace)

Obligatoire. Immuable. Espace de clés des ID mobiles.
appId

string

Obligatoire. Immuable. Chaîne qui identifie de manière unique une application mobile à partir de laquelle les données ont été collectées.

KeySpace

Espace de clés pour l'identité mobile.

Enums
KEY_SPACE_UNSPECIFIED Non spécifié.
IOS Espace de clés iOS.
ANDROID Espace de clés Android.

UserIdInfo

Informations supplémentaires lorsque USER_ID fait partie des uploadKeyTypes.

Représentation JSON 
{
  "dataSourceType": enum (DataSourceType)
}
Champs
dataSourceType

enum (DataSourceType)

Facultatif. Immuable. Source des données importées.

PairIdInfo

Informations supplémentaires lorsque PAIR_ID fait partie des uploadKeyTypes.

Cette fonctionnalité n'est disponible que pour les partenaires de données.

Représentation JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
Champs
publisherId

string (int64 format)

Obligatoire. Immuable. Identifie l'éditeur avec lequel la liste d'utilisateurs Publisher Advertiser Identity Reconciliation est réconciliée. Ce champ est fourni par le fournisseur de la salle blanche et n'est unique que dans le champ d'application de cette salle blanche. Cette chaîne ne peut pas être utilisée comme identifiant global dans plusieurs cleanrooms.
publisherName

string

Obligatoire. Nom descriptif de l'éditeur à afficher dans l'UI pour une meilleure expérience de ciblage.
matchRatePercentage

integer

Obligatoire. Ce champ indique le pourcentage de membres de cette liste d'utilisateurs correspondant aux données first party de l'éditeur. Doit être compris entre 0 et 100 (inclus).
advertiserIdentifierCount

string (int64 format)

Facultatif. Nombre d'enregistrements de données first party de l'annonceur importés chez un fournisseur de salle blanche. Cela n'indique pas la taille d'une liste d'utilisateurs PAIR.
cleanRoomIdentifier

string

Obligatoire. Immuable. Identifie une relation unique entre un annonceur et un éditeur avec un ou plusieurs fournisseurs de salles blanches.

PseudonymousIdInfo

Informations supplémentaires lorsque PSEUDONYMOUS_ID fait partie des uploadKeyTypes.

Représentation JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
Champs
syncStatus

enum (SyncStatus)

Uniquement en sortie. État de la synchronisation de la liste d'utilisateurs.
billableRecordCount

string (int64 format)

Facultatif. Immuable. Nombre d'enregistrements facturables (par exemple, importés ou mis en correspondance).

SyncStatus

État de la synchronisation de la liste d'utilisateurs.

Enums
SYNC_STATUS_UNSPECIFIED Non spécifié.
CREATED La liste d'utilisateurs a été créée en tant qu'espace réservé. Le contenu et/ou les métadonnées de la liste sont toujours en cours de synchronisation. La liste d'utilisateurs n'est pas prête à être utilisée.
READY_FOR_USE La liste des utilisateurs est prête à être utilisée. Le contenu et les cookies ont été correctement synchronisés.
FAILED Une erreur s'est produite lors de la synchronisation du contenu et/ou des métadonnées de la liste des utilisateurs. Impossible d'utiliser la liste des utilisateurs.

PartnerAudienceInfo

Informations supplémentaires pour les audiences partenaires.

Cette fonctionnalité n'est disponible que pour les partenaires de données.

Représentation JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
Champs
partnerAudienceSource

enum (PartnerAudienceSource)

Obligatoire. Immuable. Source de l'audience partenaire.
commercePartner

string

Facultatif. Nom du partenaire commercial. Uniquement autorisé si partnerAudienceSource est défini sur COMMERCE_AUDIENCE.

PartnerAudienceSource

Source d'audience partenaire.

Enums
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED Non spécifié.
COMMERCE_AUDIENCE La source d'audience partenaire est une audience pour le commerce.
LINEAR_TV_AUDIENCE La source d'audience partenaire est l'audience de la TV linéaire.
AGENCY_PROVIDER_AUDIENCE La source d'audience partenaire est une audience d'agence/fournisseur.

Méthodes

create

 Crée une UserList.

delete

 Supprime une UserList.

get

 Obtient une UserList.

list

 Liste les listes d'utilisateurs.

patch

 Met à jour une liste d'utilisateurs.