REST Resource: firstPartyAndPartnerAudiences

Recurso: FirstPartyAndPartnerAudience

Describe una lista de público de origen o de socios que se usa para la segmentación. Los públicos de origen se crean a través del uso de los datos del cliente. Los públicos de socios son proporcionados por proveedores de datos externos y solo se pueden otorgar licencias a los clientes.

Representación 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of mutually exclusive fields.
}
Campos
name

string

Solo salida. Es el nombre del recurso del público propio y del público socio.
firstPartyAndPartnerAudienceId

string (int64 format)

Es el identificador. Es el ID único del público de origen y del socio. El sistema lo asigna.
displayName

string

Opcional. Es el nombre visible del público propio y del público del socio.
description

string

Opcional. Es la descripción del público proporcionada por el usuario.

Solo se aplica a los públicos propios.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

Solo salida. Indica si el público es propio y de socios.
audienceType

enum (AudienceType)

Inmutable. Es el tipo de público.
audienceSource

enum (AudienceSource)

Solo salida. Es la fuente del público.
membershipDurationDays

string (int64 format)

Opcional. Es la duración en días que una entrada permanece en el público después del evento apto. El valor establecido debe ser mayor que 0 y menor o igual que 540.

Solo se aplica a los públicos propios.

Este campo es obligatorio si se usa uno de los siguientes audienceType:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

Solo salida. Es el tamaño estimado del público para la Red de Display.

Si el tamaño es inferior a 1,000, el número se ocultará y se devolverá 0 por motivos de privacidad. De lo contrario, el número se redondeará a dos dígitos significativos.

Solo se devuelve en la solicitud GET.
activeDisplayAudienceSize

string (int64 format)

Solo salida. Es el tamaño estimado del público de la Red de Display durante el último mes.

Si el tamaño es inferior a 1,000, el número se ocultará y se devolverá 0 por motivos de privacidad. De lo contrario, el número se redondeará a dos dígitos significativos.

Solo se devuelve en la solicitud GET.
youtubeAudienceSize

string (int64 format)

Solo salida. Es el tamaño estimado del público de la red de YouTube.

Si el tamaño es inferior a 1,000, el número se ocultará y se devolverá 0 por motivos de privacidad. De lo contrario, el número se redondeará a dos dígitos significativos.

Solo se aplica a los públicos propios.

Solo se devuelve en la solicitud GET.
gmailAudienceSize

string (int64 format)

Solo salida. Es el tamaño estimado del público para la red de Gmail.

Si el tamaño es inferior a 1,000, el número se ocultará y se devolverá 0 por motivos de privacidad. De lo contrario, el número se redondeará a dos dígitos significativos.

Solo se aplica a los públicos propios.

Solo se devuelve en la solicitud GET.
displayMobileAppAudienceSize

string (int64 format)

Solo salida. Es el tamaño estimado del público de la aplicación para dispositivos móviles en la Red de Display.

Si el tamaño es inferior a 1,000, el número se ocultará y se devolverá 0 por motivos de privacidad. De lo contrario, el número se redondeará a dos dígitos significativos.

Solo se aplica a los públicos propios.

Solo se devuelve en la solicitud GET.
displayMobileWebAudienceSize

string (int64 format)

Solo salida. Es el tamaño estimado del público de la Web en dispositivos móviles en la Red de Display.

Si el tamaño es inferior a 1,000, el número se ocultará y se devolverá 0 por motivos de privacidad. De lo contrario, el número se redondeará a dos dígitos significativos.

Solo se aplica a los públicos propios.

Solo se devuelve en la solicitud GET.
displayDesktopAudienceSize

string (int64 format)

Solo salida. Es el tamaño estimado del público de computadoras en la Red de Display.

Si el tamaño es inferior a 1,000, el número se ocultará y se devolverá 0 por motivos de privacidad. De lo contrario, el número se redondeará a dos dígitos significativos.

Solo se aplica a los públicos propios.

Solo se devuelve en la solicitud GET.
appId

string

Opcional. El appId coincide con el tipo de mobileDeviceIds que se suben.

Solo se aplica a audienceType CUSTOMER_MATCH_DEVICE_ID
Son los miembros iniciales del público de Segmentación por clientes. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
contactInfoList

object (ContactInfoList)

Solo entrada. Es una lista de información de contacto para definir a los miembros del público inicial.

Solo se aplica a audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

Solo entrada. Es una lista de IDs de dispositivos móviles para definir los miembros iniciales del público.

Solo se aplica a audienceType CUSTOMER_MATCH_DEVICE_ID
Fin de los campos mutuamente excluyentes.

ContactInfoList

Es un mensaje wrapper para una lista de información de contacto que define a los miembros del público de la Segmentación por clientes.

Representación JSON 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
Campos
contactInfos[]

object (ContactInfo)

Opcional. Es una lista de objetos ContactInfo que definen a los miembros del público de Segmentación por clientes. El tamaño de los miembros después de dividir los contactInfos no debe ser mayor que 500,000.
consent

object (Consent)

Solo entrada. Es el parámetro de configuración del consentimiento para los usuarios de contactInfos.

Si no se configura este campo, se indica que no se especificó el consentimiento.

Si los campos adUserData o adPersonalization se configuran como CONSENT_STATUS_DENIED, la solicitud mostrará un error.

ContactInfo

Es la información de contacto que define a un miembro del público de Segmentación por clientes.

Representación JSON 
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
Campos
hashedEmails[]

string

Opcional. Es una lista de correos electrónicos con hash SHA256 del miembro. Antes de aplicar el hash, quita todos los espacios en blanco y asegúrate de que la cadena esté en minúsculas.
hashedPhoneNumbers[]

string

Opcional. Es una lista de números de teléfono del miembro con codificación hash SHA256. Antes de generar el hash, todos los números de teléfono deben tener el formato E.164 y deben incluir el código de país.
zipCodes[]

string

Opcional. Es una lista de códigos postales del miembro.

También se debe configurar con los siguientes campos:
hashedFirstName

string

Opcional. Es el nombre del miembro con codificación hash SHA256. Antes de aplicar el hash, quita todos los espacios en blanco y asegúrate de que la cadena esté en minúsculas.

También se debe configurar con los siguientes campos:
hashedLastName

string

Opcional. Apellido del miembro con codificación hash SHA256. Antes de aplicar el hash, quita todos los espacios en blanco y asegúrate de que la cadena esté en minúsculas.

También se debe configurar con los siguientes campos:
countryCode

string

Opcional. Es el código de país del miembro.

También se debe configurar con los siguientes campos:

ConsentStatus

Es el estado de consentimiento.

Enums
CONSENT_STATUS_UNSPECIFIED El valor del tipo no se especificó o es desconocido en esta versión.
CONSENT_STATUS_GRANTED Se otorga el consentimiento.
CONSENT_STATUS_DENIED Se rechazó el consentimiento.

MobileDeviceIdList

Es un mensaje de wrapper para una lista de IDs de dispositivos móviles que definen a los miembros del público de Segmentación por clientes.

Representación JSON 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
Campos
mobileDeviceIds[]

string

Opcional. Es una lista de IDs de dispositivos móviles que definen a los miembros del público de Segmentación por clientes. El tamaño de mobileDeviceIds no debe ser superior a 500,000.
consent

object (Consent)

Solo entrada. Es el parámetro de configuración del consentimiento para los usuarios de mobileDeviceIds.

Si no se configura este campo, se indica que no se especificó el consentimiento.

Si los campos adUserData o adPersonalization se configuran como CONSENT_STATUS_DENIED, la solicitud mostrará un error.

FirstPartyAndPartnerAudienceType

Son los posibles tipos de un recurso de público propio y de socios.

Enums
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Es el valor predeterminado cuando el tipo no se especifica o es desconocido.
TYPE_FIRST_PARTY Público creado a partir del uso de datos del cliente.
TYPE_PARTNER Público proporcionado por proveedores de datos externos.

AudienceType

Son los tipos de público posibles.

Enums
AUDIENCE_TYPE_UNSPECIFIED Es el valor predeterminado cuando el tipo no se especifica o es desconocido.
CUSTOMER_MATCH_CONTACT_INFO El público se generó a través de la correlación de clientes con información de contacto conocida.
CUSTOMER_MATCH_DEVICE_ID El público se generó a través de la correlación de clientes con IDs de dispositivos móviles conocidos.
CUSTOMER_MATCH_USER_ID El público se generó a través de la correlación de clientes con IDs de usuario conocidos.
ACTIVITY_BASED

Obsoleto: El público se creó en función de la actividad de la campaña.
FREQUENCY_CAP

Obsoleto: El público se creó en función de la exclusión de la cantidad de impresiones que se publicaron para él.
TAG_BASED El público se creó en función de las variables personalizadas adjuntas al píxel.
YOUTUBE_USERS El público se creó en función de las interacciones anteriores con videos, anuncios de YouTube o el canal de YouTube.
THIRD_PARTY El público tiene licencia de uso de un tercero.
COMMERCE Público proporcionado por socios comerciales por una tarifa.
LINEAR Es el público del contenido de la TV lineal.
AGENCY Es el público que proporciona una agencia.

AudienceSource

Son las posibles fuentes de datos del público.

Enums
AUDIENCE_SOURCE_UNSPECIFIED Es el valor predeterminado cuando no se especifica la fuente de datos del público o se desconoce.
DISPLAY_VIDEO_360 Se originó en Display & Video 360.
CAMPAIGN_MANAGER Se originó en Campaign Manager 360.
AD_MANAGER Se originó en Google Ad Manager.
SEARCH_ADS_360 Se originó en Search Ads 360.
YOUTUBE Se originó en YouTube.
ADS_DATA_HUB Se originó en el Centro de Datos de Anuncios.

Métodos

create

 Crea un objeto FirstPartyAndPartnerAudience.

editCustomerMatchMembers

 Actualiza la lista de miembros de un público de Segmentación por clientes.

get

 Obtiene un público propio o de socios.

list

 Enumera los públicos propios y los públicos de socios.

patch

 Actualiza un objeto FirstPartyAndPartnerAudience existente.