REST Resource: firstPartyAndPartnerAudiences

Recurso: FirstPartyAndPartnerAudience

Describe una lista de público propia o de socios que se utiliza para la segmentación. Los públicos propios se crean mediante el uso de 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,

  // 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.
}
Campos
name

string

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

string (int64 format)

Identificador. Es el ID único del público propio y del público de socios. El sistema lo asigna.
displayName

string

Solo salida. Es el nombre visible del público propio y del público de socios.
description

string

Solo salida. Es la descripción del público que proporcionó el usuario.

Solo se aplica a los públicos propios.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

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

enum (AudienceType)

Solo salida. Es el tipo de público.
audienceSource

enum (AudienceSource)

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

string (int64 format)

Solo salida. Es la duración en días que una entrada permanece en el público después del evento de calificación. Si el público no tiene vencimiento, establece el valor de este campo en 10000. De lo contrario, 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 mostrará 0 por motivos de privacidad. De lo contrario, el número se redondeará a dos dígitos significativos.

Solo se muestra en la solicitud GET.
activeDisplayAudienceSize

string (int64 format)

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

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

Solo se muestra 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 mostrará 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 muestra 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 mostrará 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 muestra en la solicitud GET.
displayMobileAppAudienceSize

string (int64 format)

Solo salida. Es el tamaño estimado del público de aplicaciones 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 mostrará 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 muestra en la solicitud GET.
displayMobileWebAudienceSize

string (int64 format)

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

Si el tamaño es inferior a 1,000, el número se ocultará y se mostrará 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 muestra en la solicitud GET.
displayDesktopAudienceSize

string (int64 format)

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

Si el tamaño es inferior a 1,000, el número se ocultará y se mostrará 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 muestra en la solicitud GET.
appId

string

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

Solo se aplica a audienceType CUSTOMER_MATCH_DEVICE_ID
Campo de unión members. Los miembros iniciales del público de Segmentación por clientes. Las direcciones (members) solo pueden ser una de las siguientes opciones:
contactInfoList

object (ContactInfoList)

Solo entrada. Una lista de información de contacto para definir los miembros iniciales del público.

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

FirstPartyAndPartnerAudienceType

Tipos posibles de un recurso de público propio y de socios.

Enumeraciones
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Es el valor predeterminado cuando no se especifica el tipo o es desconocido.
TYPE_FIRST_PARTY Es un público que se crea mediante el uso de datos del cliente.
TYPE_PARTNER Es el público que proporcionan los proveedores de datos externos.

AudienceType

Posibles tipos de públicos.

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

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

El público se creó con base en la exclusión de la cantidad de impresiones que se publicaron.
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 canales de YouTube.
THIRD_PARTY El público tiene licencia para su uso por parte de un tercero.
COMMERCE Es un público que proporcionan los socios comerciales por una tarifa.
LINEAR Es el público del contenido de TV lineal.

AudienceSource

Posibles fuentes de datos del público.

Enumeraciones
AUDIENCE_SOURCE_UNSPECIFIED Es el valor predeterminado cuando no se especifica la fuente del público o cuando esta es desconocida.
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.

ContactInfoList

Es un mensaje de 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)

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 superior a 500,000.
consent

object (Consent)

Solo entrada. Es la configuración de consentimiento de los usuarios en contactInfos.

Si no se establece este campo, significa que no se especifica el consentimiento.

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

ContactInfo

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

Es una lista del correo electrónico con hash SHA256 del miembro. Antes de generar un hash, quita todos los espacios en blanco y asegúrate de que la cadena esté en minúsculas.
hashedPhoneNumbers[]

string

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

string

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

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

string

Es el nombre del miembro con codificación hash SHA256. Antes de generar un 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

Es el apellido del miembro con codificación hash SHA256. Antes de generar un 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

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

También se debe configurar con los siguientes campos:

ConsentStatus

Estado del consentimiento

Enumeraciones
CONSENT_STATUS_UNSPECIFIED El valor de tipo no se especifica 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 miembros del público de Segmentación por clientes.

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

string

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 la configuración de consentimiento de los usuarios en mobileDeviceIds.

Si no se establece este campo, significa que no se especifica el consentimiento.

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

Métodos

create

 Crea un 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

 Muestra los públicos propios y de socios.

patch

 Actualiza un FirstPartyAndPartnerAudience existente.