Package google.ads.datamanager.v1

Índice

IngestionService

Serviço para enviar dados de público-alvo a destinos compatíveis.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Faz upload de uma lista de recursos AudienceMember para o Destination fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/datamanager
IngestEvents

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Faz upload de uma lista de recursos Event do Destination fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/datamanager
RemoveAudienceMembers

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Remove uma lista de recursos AudienceMember do Destination fornecido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/datamanager

AdIdentifiers

Identificadores e outras informações usadas para corresponder o evento de conversão a outras atividades on-line, como cliques em anúncios.

Campos
session_attributes

string

Opcional. Atributos de sessão para atribuição e estimativa de eventos.
gclid

string

Opcional. O ID de clique do Google (gclid) associado a esse evento.
gbraid

string

Opcional. O identificador de cliques associados a eventos de app e feitos em dispositivos iOS 14 (ou mais recente).
wbraid

string

Opcional. O identificador de cliques associados a eventos da Web e feitos em dispositivos iOS 14 (ou mais recente).
landing_page_device_info

DeviceInfo

Opcional. Informações coletadas sobre o dispositivo usado (se houver) no momento do acesso ao site do anunciante após a interação com o anúncio.

AddressInfo

Informações de endereço do usuário.

Campos
given_name

string

Obrigatório. Dado o nome (primeiro) do usuário, tudo em minúsculas, sem pontuação, sem espaços em branco à esquerda ou à direita e criptografado com hash como SHA-256.
family_name

string

Obrigatório. Sobrenome do usuário, todo em minúsculas, sem pontuação, sem espaços em branco à esquerda ou à direita e criptografado com hash como SHA-256.
region_code

string

Obrigatório. O código regional de duas letras no formato ISO-3166-1 alpha-2 do endereço do usuário.
postal_code

string

Obrigatório. O CEP do endereço do usuário.

AudienceMember

O membro do público-alvo em que a operação será realizada.

Campos
consent

Consent

Opcional. A configuração de consentimento do usuário.
Campo de união data. O tipo de dados de identificação a serem processados. data pode ser apenas de um dos tipos a seguir:
user_data

UserData

Dados fornecidos pelo usuário que o identificam.
pair_data

PairData

IDs da Reconciliação de dados de identificação entre publishers e anunciantes (PAIR).
mobile_data

MobileData

Dados que identificam os dispositivos móveis do usuário.

CartData

Os dados do carrinho associados ao evento.

Campos
merchant_id

string

Opcional. O ID do Merchant Center associado aos itens.
merchant_feed_label

string

Opcional. O rótulo do feed do Merchant Center associado ao feed dos itens.
merchant_feed_language_code

string

Opcional. O código de idioma ISO 639-1 associado ao feed do Merchant Center dos itens.
transaction_discount

double

Opcional. A soma de todos os descontos associados à transação.
items[]

Item

Opcional. A lista de itens associados ao evento.

Configurações de consentimento da Lei de Mercados Digitais (DMA) para o usuário.

Campos
ad_user_data

ConsentStatus

Opcional. Representa se o usuário consente com os dados do usuário do anúncio.
ad_personalization

ConsentStatus

Opcional. Representa se o usuário consente com a personalização de anúncios.

ConsentStatus

Representa se o usuário concedeu, negou ou não especificou o consentimento.

Enums
CONSENT_STATUS_UNSPECIFIED Não especificado.
CONSENT_GRANTED Concedido.
CONSENT_DENIED Negada.

CustomVariable

Variável personalizada para conversões de anúncios.

Campos
variable

string

Opcional. O nome da variável personalizada a ser definida. Se a variável não for encontrada para o destino especificado, ela será ignorada.
value

string

Opcional. O valor a ser armazenado para a variável personalizada.
destination_references[]

string

Opcional. String de referência usada para determinar a qual dos Event.destination_references a variável personalizada deve ser enviada. Se estiver vazio, o Event.destination_references será usado.

CustomerType

Tipo do cliente associado ao evento.

Enums
CUSTOMER_TYPE_UNSPECIFIED CustomerType não especificado. Nunca deve ser usado.
NEW O cliente é novo para o anunciante.
RETURNING O cliente está retornando ao anunciante.
REENGAGED O cliente interagiu novamente com o anunciante.

CustomerValueBucket

O valor do cliente avaliado pelo anunciante.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Unspecified CustomerValueBucket. Nunca deve ser usado.
LOW O cliente tem baixo valor.
MEDIUM O cliente é de valor médio.
HIGH O cliente é de alto valor.

Destino

O produto do Google para onde você está enviando dados. Por exemplo, uma conta do Google Ads.

Campos
reference

string

Opcional. ID do recurso Destination, exclusivo na solicitação. Usado para fazer referência a este Destination no IngestEventsRequest.
login_account

ProductAccount

Opcional. A conta usada para fazer essa chamada de API. Para adicionar ou remover dados do operating_account, esse login_account precisa ter acesso de gravação ao operating_account. Por exemplo, uma conta de administrador do operating_account ou uma conta com um link estabelecido para o operating_account.
linked_account

ProductAccount

Opcional. Uma conta a que o login_account do usuário chamador tem acesso por um link de conta estabelecido. Por exemplo, o login_account de um parceiro de dados pode ter acesso ao linked_account de um cliente. O parceiro pode usar esse campo para enviar dados do linked_account para outro operating_account.
operating_account

ProductAccount

Obrigatório. A conta para enviar ou remover os dados.
product_destination_id

string

Obrigatório. O objeto na conta do produto para ingestão. Por exemplo, um ID de público-alvo do Google Ads ou do Display & Video 360.

DeviceInfo

Informações sobre o dispositivo usado (se houver) quando o evento ocorreu.

Campos
user_agent

string

Opcional. A string de user agent do dispositivo para o contexto especificado.
ip_address

string

Opcional. O endereço IP do dispositivo para o contexto especificado.

Observação:o Google Ads não oferece suporte à correspondência de endereços IP para usuários finais no Espaço Econômico Europeu (EEE), no Reino Unido (UK) ou na Suíça (CH). Adicione lógica para excluir condicionalmente o compartilhamento de endereços IP de usuários dessas regiões e forneça informações claras e abrangentes sobre os dados coletados nos seus sites, apps e outras propriedades. Além disso, obtenha consentimento quando exigido por lei ou pelas políticas do Google aplicáveis. Consulte a página Sobre as importações de conversões off-line para mais detalhes.

Codificação

O tipo de codificação das informações de identificação com hash.

Enums
ENCODING_UNSPECIFIED Tipo de codificação não especificado. Nunca deve ser usado.
HEX Codificação hexadecimal.
BASE64 Codificação Base64.

EncryptionInfo

Informações de criptografia dos dados ingeridos.

Campos
Campo de união wrapped_key. A chave encapsulada usada para criptografar os dados. wrapped_key pode ser apenas de um dos tipos a seguir:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Informações da chave encapsulada do Google Cloud Platform.

Evento

Um evento que representa uma interação do usuário com o site ou app de um anunciante.

Campos
destination_references[]

string

Opcional. String de referência usada para determinar o destino. Se estiver vazio, o evento será enviado para todos os destinations na solicitação.
transaction_id

string

Obrigatório. O identificador exclusivo do evento.
event_timestamp

Timestamp

Obrigatório. Hora em que o evento ocorreu
last_updated_timestamp

Timestamp

Opcional. A última vez que o evento foi atualizado.
user_data

UserData

Opcional. Partes de dados fornecidos pelo usuário, representando o usuário a que o evento está associado.
consent

Consent

Opcional. Informações sobre se o usuário associado deu diferentes tipos de consentimento.
ad_identifiers

AdIdentifiers

Opcional. Identificadores e outras informações usadas para corresponder o evento de conversão a outras atividades on-line, como cliques em anúncios.
currency

string

Opcional. O código da moeda associado a todos os valores monetários neste evento.
conversion_value

double

Opcional. O valor de conversão associado ao evento, para conversões com base no valor.
event_source

EventSource

Opcional. Indicador de onde o evento ocorreu (Web, app, loja física etc.).
event_device_info

DeviceInfo

Opcional. Informações coletadas sobre o dispositivo usado (se houver) quando o evento ocorreu.
cart_data

CartData

Opcional. Informações sobre a transação e os itens associados ao evento.
custom_variables[]

CustomVariable

Opcional. Outras informações de par chave/valor a serem enviadas aos contêineres de conversão (ação de conversão ou atividade do FL).
experimental_fields[]

ExperimentalField

Opcional. Uma lista de pares de chave-valor para campos experimentais que podem ser promovidos para fazer parte da API.
user_properties

UserProperties

Opcional. Informações avaliadas pelo anunciante sobre o usuário no momento em que o evento ocorreu.

EventSource

A origem do evento.

Enums
EVENT_SOURCE_UNSPECIFIED EventSource não especificado. Nunca deve ser usado.
WEB O evento foi gerado em um navegador da Web.
APP O evento foi gerado por um app.
IN_STORE O evento foi gerado de uma transação na loja.
PHONE O evento foi gerado em uma ligação.
OTHER O evento foi gerado de outras fontes.

ExperimentalField

Campo experimental que representa campos não oficiais.

Campos
field

string

Opcional. O nome do campo a ser usado.
value

string

Opcional. O valor do campo a ser definido.

GcpWrappedKeyInfo

Informações sobre a chave encapsulada do Google Cloud Platform.

Campos
key_type

KeyType

Obrigatório. O tipo de algoritmo usado para criptografar os dados.
wip_provider

string

Obrigatório. O provedor de pool de Identidade da carga de trabalho necessário para usar a KEK.
kek_uri

string

Obrigatório. ID do recurso do Cloud Key Management Service do Google Cloud Platform.
encrypted_dek

string

Obrigatório. A chave de criptografia de dados criptografada codificada em base64.

KeyType

O tipo de algoritmo usado para criptografar os dados.

Enums
KEY_TYPE_UNSPECIFIED Tipo de chave não especificado. Nunca deve ser usado.
XCHACHA20_POLY1305 Algoritmo XChaCha20-Poly1305

IngestAudienceMembersRequest

Solicitação para fazer upload de participantes do público-alvo nos destinos fornecidos. Retorna um IngestAudienceMembersResponse.

Campos
destinations[]

Destination

Obrigatório. A lista de destinos para enviar os membros do público-alvo.
audience_members[]

AudienceMember

Obrigatório. A lista de usuários para enviar aos destinos especificados. No máximo 10.000 recursos AudienceMember podem ser enviados em uma única solicitação.
consent

Consent

Opcional. Consentimento no nível da solicitação para aplicar a todos os usuários na solicitação. O consentimento no nível do usuário substitui o consentimento no nível da solicitação e pode ser especificado em cada AudienceMember.
validate_only

bool

Opcional. Para fins de teste. Se true, a solicitação será validada, mas não executada. Apenas erros são retornados, não resultados.
encoding

Encoding

Opcional. Obrigatório para uploads de UserData. O tipo de codificação dos identificadores de usuário. Para identificadores de usuário com hash, esse é o tipo de codificação da string com hash. Para identificadores de usuário criptografados com hash, esse é o tipo de codificação da string criptografada externa, mas não necessariamente da string com hash interna. Isso significa que a string com hash interna pode ser codificada de uma maneira diferente da string criptografada externa. Para uploads que não são UserData, esse campo é ignorado.
encryption_info

EncryptionInfo

Opcional. Informações de criptografia para uploads do UserData. Se não for definido, será presumido que as informações de identificação enviadas foram criptografadas com hash, mas não criptografadas. Para uploads que não são UserData, esse campo é ignorado.
terms_of_service

TermsOfService

Opcional. Os Termos de Serviço que o usuário aceitou/rejeitou.

IngestAudienceMembersResponse

Resposta do IngestAudienceMembersRequest.

Campos
request_id

string

O ID gerado automaticamente da solicitação.

IngestEventsRequest

Solicitação para fazer upload de participantes do público-alvo nos destinos fornecidos. Retorna um IngestEventsResponse.

Campos
destinations[]

Destination

Obrigatório. A lista de destinos para enviar os eventos.
events[]

Event

Obrigatório. A lista de eventos a serem enviados aos destinos especificados. No máximo, 2.000 recursos Event podem ser enviados em uma única solicitação.
consent

Consent

Opcional. Consentimento no nível da solicitação para aplicar a todos os usuários na solicitação. O consentimento no nível do usuário substitui o consentimento no nível da solicitação e pode ser especificado em cada Event.
validate_only

bool

Opcional. Para fins de teste. Se true, a solicitação será validada, mas não executada. Apenas erros são retornados, não resultados.
encoding

Encoding

Opcional. Obrigatório para uploads de UserData. O tipo de codificação dos identificadores de usuário. Para identificadores de usuário com hash, esse é o tipo de codificação da string com hash. Para identificadores de usuário criptografados com hash, esse é o tipo de codificação da string criptografada externa, mas não necessariamente da string com hash interna. Isso significa que a string com hash interna pode ser codificada de uma maneira diferente da string criptografada externa. Para uploads que não são UserData, esse campo é ignorado.
encryption_info

EncryptionInfo

Opcional. Informações de criptografia para uploads do UserData. Se não for definido, será presumido que as informações de identificação enviadas foram criptografadas com hash, mas não criptografadas. Para uploads que não são UserData, esse campo é ignorado.

IngestEventsResponse

Resposta do IngestEventsRequest.

Campos
request_id

string

O ID gerado automaticamente da solicitação.

Item

Representa um item no carrinho associado ao evento.

Campos
merchant_product_id

string

Opcional. O ID do produto na conta do Merchant Center.
quantity

int64

Opcional. O número deste item associado ao evento.
unit_price

double

Opcional. O preço unitário, excluindo tributos, frete e descontos no nível da transação.

MobileData

IDs de dispositivos móveis do público-alvo. É necessário pelo menos um ID de dispositivo móvel.

Campos
mobile_ids[]

string

Obrigatório. A lista de IDs de dispositivos móveis (ID de publicidade/IDFA). No máximo, 10 mobileIds podem ser fornecidos em um único AudienceMember.

PairData

IDs de PAIR para o público-alvo. É necessário ter pelo menos um ID de PAIR.

Campos
pair_ids[]

string

Obrigatório. Dados de PII fornecidos pela cleanroom, criptografados com hash SHA256 e criptografados com uma cifra comutativa EC usando a chave do editor para a lista de usuários PAIR. No máximo, 10 pairIds podem ser fornecidos em um único AudienceMember.

Produto

Representa um produto específico do Google. Usado para localizar contas e destinos.

Enums
PRODUCT_UNSPECIFIED Produto não especificado. Nunca deve ser usado.
GOOGLE_ADS Google Ads
DISPLAY_VIDEO_PARTNER Parceiro do Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Anunciante do Display & Video 360.
DATA_PARTNER Parceiro de dados.

ProductAccount

Representa uma conta específica.

Campos
product

Product

Obrigatório. O produto a que a conta pertence. Por exemplo, GOOGLE_ADS.
account_id

string

Obrigatório. O ID da conta. Por exemplo, o ID da sua conta do Google Ads.

RemoveAudienceMembersRequest

Solicitação para remover usuários de um público-alvo nos destinos fornecidos. Retorna um RemoveAudienceMembersResponse.

Campos
destinations[]

Destination

Obrigatório. A lista de destinos de onde os usuários serão removidos.
audience_members[]

AudienceMember

Obrigatório. A lista de usuários a serem removidos.
validate_only

bool

Opcional. Para fins de teste. Se true, a solicitação será validada, mas não executada. Apenas erros são retornados, não resultados.
encoding

Encoding

Opcional. Obrigatório para uploads de UserData. O tipo de codificação dos identificadores de usuário. Aplicável apenas à codificação externa para identificadores de usuários criptografados. Para uploads que não são UserData, esse campo é ignorado.
encryption_info

EncryptionInfo

Opcional. Informações de criptografia para uploads do UserData. Se não for definido, será presumido que as informações de identificação enviadas foram criptografadas com hash, mas não criptografadas. Para uploads que não são UserData, esse campo é ignorado.

RemoveAudienceMembersResponse

Resposta do RemoveAudienceMembersRequest.

Campos
request_id

string

O ID gerado automaticamente da solicitação.

TermsOfService

Os Termos de Serviço que o usuário aceitou/rejeitou.

Campos
customer_match_terms_of_service_status

TermsOfServiceStatus

Opcional. Os Termos de Serviço da Segmentação por lista de clientes: https://support.google.com/adspolicy/answer/6299717. Isso precisa ser aceito para todos os uploads nas listas de usuários da Segmentação por lista de clientes.

TermsOfServiceStatus

Representa a decisão do autor da chamada de aceitar ou rejeitar os Termos de Serviço.

Enums
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Não especificado.
ACCEPTED Status que indica que o autor da chamada escolheu aceitar os Termos de Serviço.
REJECTED Status que indica que o autor da chamada escolheu rejeitar os Termos de Serviço.

UserData

Dados que identificam o usuário. É necessário pelo menos um identificador.

Campos
user_identifiers[]

UserIdentifier

Obrigatório. Os identificadores do usuário. É possível fornecer várias instâncias do mesmo tipo de dado (por exemplo, vários endereços de e-mail). Para aumentar a probabilidade de uma correspondência, forneça o máximo possível de identificadores. No máximo, 10 userIdentifiers podem ser fornecidos em um único AudienceMember ou Event.

UserIdentifier

Um único identificador do usuário.

Campos
Campo de união identifier. É necessário especificar exatamente um. identifier pode ser apenas de um dos tipos a seguir:
email_address

string

Endereço de e-mail criptografado com hash usando a função de hash SHA-256 após a normalização.
phone_number

string

Número de telefone criptografado com hash usando a função hash SHA-256 após a normalização (padrão E164).
address

AddressInfo

Os componentes conhecidos do endereço de um usuário. Contém um agrupamento de identificadores que são correspondidos de uma só vez.

UserProperties

Informações avaliadas pelo anunciante sobre o usuário no momento em que o evento ocorreu. Consulte https://support.google.com/google-ads/answer/14007601 para mais detalhes.

Campos
customer_type

CustomerType

Opcional. Tipo do cliente associado ao evento.
customer_value_bucket

CustomerValueBucket

Opcional. O valor do cliente avaliado pelo anunciante.