REST Resource: firstPartyAndPartnerAudiences

Recurso: FirstPartyAndPartnerAudience

Descreve uma lista de público-alvo próprio ou de parceiros usada para segmentação. Os públicos-alvo próprios são criados com o uso de dados do cliente. Os públicos-alvo de parceiros são fornecidos por provedores de dados de terceiros e só podem ser licenciados para clientes.

Representação 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
}
Campos
name

string

Apenas saída. O nome do recurso do público-alvo próprio e de parceiros.
firstPartyAndPartnerAudienceId

string (int64 format)

Identificador. O ID exclusivo do público-alvo próprio e de parceiros. Atribuído pelo sistema.
displayName

string

Opcional. O nome de exibição do público-alvo próprio e de parceiros.
description

string

Opcional. A descrição do público-alvo fornecida pelo usuário.

Aplicável apenas a públicos-alvo próprios.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

Apenas saída. Se o público-alvo é próprio e de parceiros.
audienceType

enum (AudienceType)

Imutável. O tipo de público-alvo.
audienceSource

enum (AudienceSource)

Apenas saída. É a origem do público-alvo.
membershipDurationDays

string (int64 format)

Opcional. A duração em dias que uma entrada permanece no público-alvo após o evento de qualificação. O valor definido precisa ser maior que 0 e menor ou igual a 540.

Aplicável apenas a públicos-alvo próprios.

Este campo é obrigatório se um dos seguintes audienceType for usado:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

Apenas saída. O tamanho estimado do público-alvo para a Rede de Display.

Se o tamanho for menor que 1.000, o número será ocultado e 0 será retornado por motivos de privacidade. Caso contrário, o número será arredondado para dois dígitos significativos.

Retornado apenas na solicitação GET.
activeDisplayAudienceSize

string (int64 format)

Apenas saída. O tamanho estimado do público-alvo da Rede de Display no último mês.

Se o tamanho for menor que 1.000, o número será ocultado e 0 será retornado por motivos de privacidade. Caso contrário, o número será arredondado para dois dígitos significativos.

Retornado apenas na solicitação GET.
youtubeAudienceSize

string (int64 format)

Apenas saída. O tamanho estimado do público-alvo da rede do YouTube.

Se o tamanho for menor que 1.000, o número será ocultado e 0 será retornado por motivos de privacidade. Caso contrário, o número será arredondado para dois dígitos significativos.

Aplicável apenas a públicos-alvo próprios.

Retornado apenas na solicitação GET.
gmailAudienceSize

string (int64 format)

Apenas saída. O tamanho estimado do público-alvo para a rede do Gmail.

Se o tamanho for menor que 1.000, o número será ocultado e 0 será retornado por motivos de privacidade. Caso contrário, o número será arredondado para dois dígitos significativos.

Aplicável apenas a públicos-alvo próprios.

Retornado apenas na solicitação GET.
displayMobileAppAudienceSize

string (int64 format)

Apenas saída. O tamanho estimado do público-alvo de apps para dispositivos móveis na Rede de Display.

Se o tamanho for menor que 1.000, o número será ocultado e 0 será retornado por motivos de privacidade. Caso contrário, o número será arredondado para dois dígitos significativos.

Aplicável apenas a públicos-alvo próprios.

Retornado apenas na solicitação GET.
displayMobileWebAudienceSize

string (int64 format)

Apenas saída. O tamanho estimado do público-alvo da Web para dispositivos móveis na Rede de Display.

Se o tamanho for menor que 1.000, o número será ocultado e 0 será retornado por motivos de privacidade. Caso contrário, o número será arredondado para dois dígitos significativos.

Aplicável apenas a públicos-alvo próprios.

Retornado apenas na solicitação GET.
displayDesktopAudienceSize

string (int64 format)

Apenas saída. O tamanho estimado do público-alvo de computadores na Rede de Display.

Se o tamanho for menor que 1.000, o número será ocultado e 0 será retornado por motivos de privacidade. Caso contrário, o número será arredondado para dois dígitos significativos.

Aplicável apenas a públicos-alvo próprios.

Retornado apenas na solicitação GET.
appId

string

Opcional. O appId corresponde ao tipo de mobileDeviceIds que está sendo enviado.

Aplicável apenas a audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

Tipos possíveis de um recurso de público-alvo próprio e de parceiros.

Tipos enumerados
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED Valor padrão quando o tipo não é especificado ou é desconhecido.
TYPE_FIRST_PARTY Público-alvo criado com o uso de dados do cliente.
TYPE_PARTNER Público-alvo fornecido por provedores de dados de terceiros.

AudienceType

Tipos possíveis de públicos-alvo.

Tipos enumerados
AUDIENCE_TYPE_UNSPECIFIED Valor padrão quando o tipo não é especificado ou é desconhecido.
CUSTOMER_MATCH_CONTACT_INFO O público-alvo foi gerado pela correspondência de clientes com dados de contato conhecidos.
CUSTOMER_MATCH_DEVICE_ID O público-alvo foi gerado pela correspondência de clientes com IDs de dispositivos móveis conhecidos.
CUSTOMER_MATCH_USER_ID O público-alvo foi gerado pela correspondência de clientes com IDs de usuário conhecidos.
ACTIVITY_BASED

Descontinuado: o público-alvo foi criado com base na atividade da campanha.
FREQUENCY_CAP

Descontinuado: o público-alvo foi criado com base na exclusão do número de impressões veiculadas a ele.
TAG_BASED O público-alvo foi criado com base em variáveis personalizadas anexadas ao pixel.
YOUTUBE_USERS O público-alvo foi criado com base em interações anteriores com vídeos, anúncios do YouTube ou canal do YouTube.
THIRD_PARTY O público-alvo foi licenciado para uso de terceiros.
COMMERCE Público-alvo fornecido por parceiros comerciais mediante uma taxa.
LINEAR Público-alvo do conteúdo de TV linear.
AGENCY Público-alvo fornecido por uma agência.

AudienceSource

Possíveis origens de público-alvo.

Tipos enumerados
AUDIENCE_SOURCE_UNSPECIFIED Valor padrão quando a origem de público-alvo não é especificada ou é desconhecida.
DISPLAY_VIDEO_360 Originado no Display & Video 360.
CAMPAIGN_MANAGER Originado do Campaign Manager 360.
AD_MANAGER Originada do Google Ad Manager.
SEARCH_ADS_360 Originado do Search Ads 360.
YOUTUBE Originado do YouTube.
ADS_DATA_HUB Originado do Ads Data Hub.

Métodos

get

 Recebe um público-alvo próprio ou de parceiros.

list

 Lista públicos-alvo próprios e de parceiros.