REST Resource: firstPartyAndPartnerAudiences

Recurso: FirstPartyAndPartnerAudience

Descreve uma lista de público-alvo própria ou de parceiro usada para segmentação. Os públicos-alvo próprios são criados usando dados do cliente. Os públicos-alvo de parceiros são fornecidos por provedores de dados terceirizados 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,

  // 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

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

string (int64 format)

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

string

Apenas saída. O nome de exibição do público-alvo próprio e de parceiro.
description

string

Apenas saída. A descrição do público-alvo fornecida pelo usuário.

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

enum (FirstPartyAndPartnerAudienceType)

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

enum (AudienceType)

Apenas saída. O tipo de público-alvo.
audienceSource

enum (AudienceSource)

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

string (int64 format)

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

Aplicável somente 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 da Rede de Display no mês passado.

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 somente 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 somente 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 somente 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 somente 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 somente 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
Campo de união members. Os membros iniciais do público-alvo segmentado por lista de clientes. members pode ser apenas de um dos tipos a seguir:
contactInfoList

object (ContactInfoList)

Somente entrada. Uma lista de informações de contato para definir os membros iniciais do público-alvo.

Aplicável apenas a audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

Somente entrada. Uma lista de IDs de dispositivos móveis para definir os membros iniciais do público-alvo.

Aplicável apenas a audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

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

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 usando dados do cliente.
TYPE_PARTNER Público-alvo fornecido por provedores de dados terceirizados.

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 informações de contato conhecidas.
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

O público-alvo foi criado com base na atividade da campanha.
FREQUENCY_CAP

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 ou canais do YouTube.
THIRD_PARTY O público-alvo foi licenciado para uso de terceiros.
COMMERCE Público-alvo fornecido por parceiros de comércio mediante uma taxa.
LINEAR Público-alvo para 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 da audiência não é especificada ou é desconhecida.
DISPLAY_VIDEO_360 Originado no Display & Video 360.
CAMPAIGN_MANAGER Originada no Campaign Manager 360.
AD_MANAGER Originado do Google Ad Manager.
SEARCH_ADS_360 Originado no Search Ads 360.
YOUTUBE Originado do YouTube.
ADS_DATA_HUB Originado no Ads Data Hub.

ContactInfoList

Mensagem wrapper para uma lista de dados de contato que define os membros do público-alvo segmentado por lista de clientes.

Representação JSON 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
Campos
contactInfos[]

object (ContactInfo)

Uma lista de objetos ContactInfo que definem os membros do público-alvo segmentado por lista de clientes. O tamanho dos membros após a divisão das contactInfos não pode ser maior que 500.000.
consent

object (Consent)

Somente entrada. A configuração de consentimento para os usuários em contactInfos.

Deixar esse campo sem definição indica que o consentimento não foi especificado.

Se os campos adUserData ou adPersonalization forem definidos como CONSENT_STATUS_DENIED, a solicitação vai retornar um erro.

ContactInfo

Dados de contato que definem um membro do público-alvo segmentado por lista de clientes.

Representação JSON 
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
Campos
hashedEmails[]

string

Uma lista de e-mails com hash SHA256 do membro. Antes de fazer o hash, remova todos os espaços em branco e verifique se a string está em letras minúsculas.
hashedPhoneNumbers[]

string

Uma lista de números de telefone com hash SHA256 do membro. Antes do hash, todos os números de telefone precisam ser formatados usando o formato E.164 e incluir o código de discagem do país.
zipCodes[]

string

Uma lista de CEPs do membro.

Também precisa ser definido com os seguintes campos:
hashedFirstName

string

Nome com hash SHA256 do membro. Antes de fazer o hash, remova todos os espaços em branco e verifique se a string está em letras minúsculas.

Também precisa ser definido com os seguintes campos:
hashedLastName

string

Sobrenome do membro com hash SHA256. Antes de fazer o hash, remova todos os espaços em branco e verifique se a string está em letras minúsculas.

Também precisa ser definido com os seguintes campos:
countryCode

string

Código do país do membro.

Também precisa ser definido com os seguintes campos:

ConsentStatus

Status de consentimento.

Tipos enumerados
CONSENT_STATUS_UNSPECIFIED O valor do tipo não foi especificado ou é desconhecido nesta versão.
CONSENT_STATUS_GRANTED O consentimento é concedido.
CONSENT_STATUS_DENIED O consentimento foi negado.

MobileDeviceIdList

Mensagem de wrapper para uma lista de IDs de dispositivos móveis que definem membros do público-alvo por lista de clientes.

Representação JSON 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
Campos
mobileDeviceIds[]

string

Uma lista de IDs de dispositivos móveis que definem os membros do público-alvo segmentado por lista de clientes. O tamanho de mobileDeviceIds não pode ser maior que 500.000.
consent

object (Consent)

Somente entrada. A configuração de consentimento para os usuários em mobileDeviceIds.

Deixar esse campo sem definição indica que o consentimento não foi especificado.

Se os campos adUserData ou adPersonalization forem definidos como CONSENT_STATUS_DENIED, a solicitação vai retornar um erro.

Métodos

create

 Cria um FirstPartyAndPartnerAudience.

editCustomerMatchMembers

 Atualiza a lista de membros de um público-alvo por lista de clientes.

get

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

list

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

patch

 Atualiza um FirstPartyAndPartnerAudience.