REST Resource: firstPartyAndPartnerAudiences

Ressource : FirstPartyAndPartnerAudience

Décrit une liste d'audience propriétaire ou partenaire utilisée pour le ciblage. Les audiences first party sont créées à l'aide des données client. Les audiences partenaires sont fournies par des fournisseurs de données tiers et ne peuvent être concédées sous licence qu'aux clients.

Représentation JSON 
{
  "name": string,
  "firstPartyAndPartnerAudienceId": string,
  "displayName": string,
  "description": string,
  "firstPartyAndPartnerAudienceType": enum (FirstPartyAndPartnerAudienceType),
  "audienceType": enum (AudienceType),
  "audienceSource": enum (AudienceSource),
  "membershipDurationDays": string,
  "displayAudienceSize": string,
  "activeDisplayAudienceSize": string,
  "youtubeAudienceSize": string,
  "gmailAudienceSize": string,
  "displayMobileAppAudienceSize": string,
  "displayMobileWebAudienceSize": string,
  "displayDesktopAudienceSize": string,
  "appId": string,

  // Union field members can be only one of the following:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of list of possible types for union field members.
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'audience propriétaire et partenaire.
firstPartyAndPartnerAudienceId

string (int64 format)

Identifiant. ID unique de l'audience propriétaire et partenaire. Attribué par le système.
displayName

string

Facultatif. Nom à afficher de l'audience propriétaire et partenaire.
description

string

Facultatif. Description de l'audience fournie par l'utilisateur.

Ne s'applique qu'aux audiences propriétaires.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

Uniquement en sortie. Indique si l'audience est propriétaire ou partenaire.
audienceType

enum (AudienceType)

Immuable. Type d'audience.
audienceSource

enum (AudienceSource)

Uniquement en sortie. Source de l'audience.
membershipDurationDays

string (int64 format)

Facultatif. Durée en jours pendant laquelle une entrée reste dans l'audience après l'événement éligible. La valeur définie doit être supérieure à 0 et inférieure ou égale à 540.

Ne s'applique qu'aux audiences propriétaires.

Ce champ est obligatoire si l'un des audienceType suivants est utilisé :

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

Uniquement en sortie. Taille estimée de l'audience pour le Réseau Display.

Si la taille est inférieure à 1 000, le nombre sera masqué et la valeur 0 sera renvoyée pour des raisons de confidentialité. Dans le cas contraire, le nombre sera arrondi à deux chiffres significatifs.

Renvoyé uniquement dans la requête GET.
activeDisplayAudienceSize

string (int64 format)

Uniquement en sortie. Taille estimée de l'audience sur le Réseau Display au cours du mois dernier.

Si la taille est inférieure à 1 000, le nombre sera masqué et la valeur 0 sera renvoyée pour des raisons de confidentialité. Dans le cas contraire, le nombre sera arrondi à deux chiffres significatifs.

Renvoyé uniquement dans la requête GET.
youtubeAudienceSize

string (int64 format)

Uniquement en sortie. Taille estimée de l'audience pour le réseau YouTube.

Si la taille est inférieure à 1 000, le nombre sera masqué et la valeur 0 sera renvoyée pour des raisons de confidentialité. Dans le cas contraire, le nombre sera arrondi à deux chiffres significatifs.

Ne s'applique qu'aux audiences propriétaires.

Renvoyé uniquement dans la requête GET.
gmailAudienceSize

string (int64 format)

Uniquement en sortie. Taille estimée de l'audience pour le réseau Gmail.

Si la taille est inférieure à 1 000, le nombre sera masqué et la valeur 0 sera renvoyée pour des raisons de confidentialité. Dans le cas contraire, le nombre sera arrondi à deux chiffres significatifs.

Ne s'applique qu'aux audiences propriétaires.

Renvoyé uniquement dans la requête GET.
displayMobileAppAudienceSize

string (int64 format)

Uniquement en sortie. Taille estimée de l'audience d'applications mobiles sur le Réseau Display.

Si la taille est inférieure à 1 000, le nombre sera masqué et la valeur 0 sera renvoyée pour des raisons de confidentialité. Dans le cas contraire, le nombre sera arrondi à deux chiffres significatifs.

Ne s'applique qu'aux audiences propriétaires.

Renvoyé uniquement dans la requête GET.
displayMobileWebAudienceSize

string (int64 format)

Uniquement en sortie. Taille estimée de l'audience Web mobile sur le Réseau Display.

Si la taille est inférieure à 1 000, le nombre sera masqué et la valeur 0 sera renvoyée pour des raisons de confidentialité. Dans le cas contraire, le nombre sera arrondi à deux chiffres significatifs.

Ne s'applique qu'aux audiences propriétaires.

Renvoyé uniquement dans la requête GET.
displayDesktopAudienceSize

string (int64 format)

Uniquement en sortie. Taille estimée de l'audience sur ordinateur sur le Réseau Display.

Si la taille est inférieure à 1 000, le nombre sera masqué et la valeur 0 sera renvoyée pour des raisons de confidentialité. Dans le cas contraire, le nombre sera arrondi à deux chiffres significatifs.

Ne s'applique qu'aux audiences propriétaires.

Renvoyé uniquement dans la requête GET.
appId

string

Facultatif. L'appId correspond au type de mobileDeviceIds importés.

Applicable uniquement à audienceType CUSTOMER_MATCH_DEVICE_ID
Champ d'union members. Membres initiaux de l'audience de ciblage par liste de clients. members ne peut être qu'un des éléments suivants :
contactInfoList

object (ContactInfoList)

Uniquement en entrée. Liste des coordonnées permettant de définir les premiers membres de l'audience.

Applicable uniquement à audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

Uniquement en entrée. Liste d'ID d'appareils mobiles permettant de définir les membres de l'audience initiale.

Applicable uniquement à audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

Types possibles d'une ressource d'audience propriétaire et partenaire.

Enums
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Valeur par défaut lorsque le type n'est pas spécifié ou est inconnu.
TYPE_FIRST_PARTY Audience créée à l'aide de données client.
TYPE_PARTNER Audience fournie par des fournisseurs de données tiers.

AudienceType

Types d'audiences possibles.

Enums
AUDIENCE_TYPE_UNSPECIFIED Valeur par défaut lorsque le type n'est pas spécifié ou est inconnu.
CUSTOMER_MATCH_CONTACT_INFO L'audience a été générée en associant les clients à des coordonnées connues.
CUSTOMER_MATCH_DEVICE_ID L'audience a été générée en associant des clients à des ID d'appareils mobiles connus.
CUSTOMER_MATCH_USER_ID L'audience a été générée en associant des clients à des ID utilisateur connus.
ACTIVITY_BASED

Obsolète : l'audience a été créée en fonction de l'activité des campagnes.
FREQUENCY_CAP

Obsolète : l'audience a été créée en excluant le nombre d'impressions qui lui ont été diffusées.
TAG_BASED L'audience a été créée à partir de variables personnalisées associées au pixel.
YOUTUBE_USERS L'audience a été créée en fonction des interactions passées avec des vidéos, des annonces YouTube ou une chaîne YouTube.
THIRD_PARTY L'audience a été concédée sous licence par un tiers.
COMMERCE Audience fournie par des partenaires commerciaux moyennant des frais.
LINEAR Audience pour les contenus TV linéaires.
AGENCY Audience fournie par une agence.

AudienceSource

Sources d'audience possibles.

Enums
AUDIENCE_SOURCE_UNSPECIFIED Valeur par défaut lorsque la source d'audience n'est pas spécifiée ou est inconnue.
DISPLAY_VIDEO_360 Le trafic provient de Display & Video 360.
CAMPAIGN_MANAGER Provient de Campaign Manager 360.
AD_MANAGER Origine : Google Ad Manager.
SEARCH_ADS_360 Provenant de Search Ads 360.
YOUTUBE Originaire de YouTube.
ADS_DATA_HUB Origine : Ads Data Hub.

ContactInfoList

Message wrapper pour une liste d'informations de contact définissant les membres d'une audience de ciblage par liste de clients.

Représentation JSON 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
Champs
contactInfos[]

object (ContactInfo)

Facultatif. Liste d'objets ContactInfo définissant les membres de l'audience de ciblage par liste de clients. La taille des membres après la division des contactInfos ne doit pas être supérieure à 500 000.
consent

object (Consent)

Uniquement en entrée. Paramètre de consentement pour les utilisateurs de contactInfos.

Si vous ne définissez pas ce champ, cela signifie que le consentement n'est pas spécifié.

Si les champs adUserData ou adPersonalization sont définis sur CONSENT_STATUS_DENIED, la requête renvoie une erreur.

ContactInfo

Informations de contact définissant un membre d'une audience de ciblage par liste de clients.

Représentation JSON 
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
Champs
hashedEmails[]

string

Facultatif. Liste des adresses e-mail hachées SHA256 des membres. Avant le hachage, supprimez tous les espaces et assurez-vous que la chaîne est entièrement en minuscules.
hashedPhoneNumbers[]

string

Facultatif. Liste des numéros de téléphone hachés au format SHA256 du membre. Avant le hachage, tous les numéros de téléphone doivent être mis en forme au format E.164 et inclure l'indicatif téléphonique du pays.
zipCodes[]

string

Facultatif. Liste des codes postaux du membre.

Doit également être défini avec les champs suivants :
hashedFirstName

string

Facultatif. Prénom du membre haché au format SHA-256. Avant le hachage, supprimez tous les espaces et assurez-vous que la chaîne est entièrement en minuscules.

Doit également être défini avec les champs suivants :
hashedLastName

string

Facultatif. Nom de famille du membre haché au format SHA256. Avant le hachage, supprimez tous les espaces et assurez-vous que la chaîne est entièrement en minuscules.

Doit également être défini avec les champs suivants :
countryCode

string

Facultatif. Code pays du membre.

Doit également être défini avec les champs suivants :

ConsentStatus

État du consentement.

Enums
CONSENT_STATUS_UNSPECIFIED La valeur du type n'est pas spécifiée ou est inconnue dans cette version.
CONSENT_STATUS_GRANTED Le consentement est accordé.
CONSENT_STATUS_DENIED L'autorisation est refusée.

MobileDeviceIdList

Message wrapper pour une liste d'ID d'appareils mobiles définissant les membres de l'audience de ciblage par liste de clients.

Représentation JSON 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
Champs
mobileDeviceIds[]

string

Facultatif. Liste d'ID d'appareils mobiles définissant les membres de l'audience de ciblage par liste de clients. La taille de mobileDeviceIds ne doit pas être supérieure à 500 000.
consent

object (Consent)

Uniquement en entrée. Paramètre de consentement pour les utilisateurs de mobileDeviceIds.

Si vous ne définissez pas ce champ, cela signifie que le consentement n'est pas spécifié.

Si les champs adUserData ou adPersonalization sont définis sur CONSENT_STATUS_DENIED, la requête renvoie une erreur.

Méthodes

create

 Crée une audience propriétaire et partenaire.

editCustomerMatchMembers

 Met à jour la liste des membres d'une audience de ciblage par liste de clients.

get

 Récupère une audience propriétaire ou partenaire.

list

 Liste les audiences propriétaires et partenaires.

patch

 Met à jour une ressource FirstPartyAndPartnerAudience existante.