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 de 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 la 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

Uniquement en sortie. Nom à afficher de l'audience propriétaire et partenaire.
description

string

Uniquement en sortie. 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 une audience propriétaire et partenaire.
audienceType

enum (AudienceType)

Uniquement en sortie. Type d'audience.
audienceSource

enum (AudienceSource)

Uniquement en sortie. Source de l'audience.
membershipDurationDays

string (int64 format)

Uniquement en sortie. Durée en jours pendant laquelle un participant reste dans l'audience après l'événement qualificatif. Si l'audience n'a pas d'expiration, définissez la valeur de ce champ sur 10 000. Sinon, 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'une des audienceType suivantes est utilisée:

  • 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 est masqué et la valeur 0 est 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 est masqué et la valeur 0 est 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 du réseau YouTube.

Si la taille est inférieure à 1 000, le nombre est masqué et la valeur 0 est 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 est masqué et la valeur 0 est 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 de l'application mobile sur le Réseau Display.

Si la taille est inférieure à 1 000, le nombre est masqué et la valeur 0 est 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 est masqué et la valeur 0 est 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 dans le Réseau Display.

Si la taille est inférieure à 1 000, le nombre est masqué et la valeur 0 est 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 des ID d'appareil mobile importés.

S'applique 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 membres de l'audience initiale.

S'applique uniquement à audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

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

S'applique uniquement à audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

Types de ressources d'audience propriétaire et partenaire possibles.

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 les clients à des ID d'appareil mobile connus.
CUSTOMER_MATCH_USER_ID L'audience a été générée en associant les clients à des ID utilisateur connus.
ACTIVITY_BASED

L'audience a été créée en fonction de l'activité des campagnes.
FREQUENCY_CAP

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 en fonction des 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 "Commerce" moyennant un supplément.
LINEAR Audience pour les contenus TV linéaires.

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 Proviennent de Display & Video 360.
CAMPAIGN_MANAGER Origine : Campaign Manager 360
AD_MANAGER Origine : Google Ad Manager
SEARCH_ADS_360 Origine : Search Ads 360
YOUTUBE Origine : YouTube
ADS_DATA_HUB Proviennent d'Ads Data Hub.

ContactInfoList

Message wrapper pour une liste de coordonnées définissant les membres de l'audience de ciblage par liste de clients.

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

object (ContactInfo)

Liste d'objets ContactInfo définissant les membres de l'audience de ciblage par liste de clients. La taille des membres après avoir divisé les contactInfos ne doit pas dépasser 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, une erreur est renvoyée.

ContactInfo

Coordonnées permettant de définir un membre de l'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

Liste des adresses e-mail du membre hachées SHA-256. Avant de hacher, supprimez tous les espaces et assurez-vous que la chaîne est en minuscules.
hashedPhoneNumbers[]

string

Liste des numéros de téléphone du membre hachés SHA256. 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

Liste des codes postaux du membre.

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

string

Prénom du membre haché en SHA-256. Avant de hacher, supprimez tous les espaces et assurez-vous que la chaîne est en minuscules.

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

string

Nom de famille du membre haché SHA-256. Avant de hacher, supprimez tous les espaces et assurez-vous que la chaîne est en minuscules.

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

string

Code pays du membre.

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

ConsentStatus

État du consentement.

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

MobileDeviceIdList

Message wrapper pour une liste d'ID d'appareil mobile définissant les membres de l'audience du ciblage par liste de clients.

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

string

Liste d'ID d'appareil mobile définissant les membres de l'audience de ciblage par liste de clients. La taille de mobileDeviceIds ne doit pas dépasser 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, une erreur est renvoyée.

Méthodes

create

 Crée une FirstPartyAndPartnerAudience.

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 FirstPartyAndPartnerAudience existante.