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
RetrieveRequestStatus

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

Recebe o status de uma solicitação com o ID dela.

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 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 com duas letras no formato ISO-3166-1 alfa-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
destination_references[]

string

Opcional. Define para qual Destination o membro do público-alvo será enviado.
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.

AwsWrappedKeyInfo

Uma chave de criptografia de dados encapsulada por uma chave do AWS KMS.

Campos
key_type

KeyType

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

string

Obrigatório. O nome de recurso da Amazon da função do IAM a ser assumida para acesso de descriptografia do KMS. Precisa estar no formato "arn:{partition}:iam::{account_id}:role/{role_name}"
kek_uri

string

Obrigatório. O URI da chave do AWS KMS usada para descriptografar a DEK. Precisa estar no formato "arn:{partition}:kms:{region}:{account_id}:key/{key_id}"
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.

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

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 no 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.

Tipos enumerados
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.

Tipos enumerados
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.

Tipos enumerados
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. Use para referenciar este Destination no IngestEventsRequest e no IngestAudienceMembersRequest.
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, um ID de público-alvo do Display & Video 360 ou um ID de ação de conversão do Google Ads.

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 a importação de conversões off-line para mais detalhes.

Codificação

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

Tipos enumerados
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.
aws_wrapped_key_info

AwsWrappedKeyInfo

Informações da chave encapsulada do Amazon Web Services.

ErrorCount

A contagem de erros para um determinado motivo.

Campos
record_count

int64

A contagem de registros que não foram enviados por um determinado motivo.
reason

ProcessingErrorReason

O motivo do erro dos registros com falha.

ErrorInfo

Contagens de erros para cada tipo de erro.

Campos
error_counts[]

ErrorCount

Uma lista de erros e contagens por motivo de erro. Talvez não seja preenchido em todos os casos.

ErrorReason

Motivos de erro para a API Data Manager.

Tipos enumerados
ERROR_REASON_UNSPECIFIED Não use este valor padrão.
INTERNAL_ERROR Ocorreu um erro interno.
DEADLINE_EXCEEDED A solicitação levou muito tempo para responder.
RESOURCE_EXHAUSTED Excesso de solicitações.
NOT_FOUND Recurso não encontrado.
PERMISSION_DENIED O usuário não tem permissão ou o recurso não foi encontrado.
INVALID_ARGUMENT Houve um problema com a solicitação.
REQUIRED_FIELD_MISSING Está faltando um campo obrigatório.
INVALID_FORMAT O formato é inválido.
INVALID_HEX_ENCODING O valor codificado em HEX está incorreto.
INVALID_BASE64_ENCODING O valor codificado em base64 está incorreto.
INVALID_SHA256_FORMAT O valor codificado em SHA256 está incorreto.
INVALID_POSTAL_CODE O código postal não é válido.
INVALID_COUNTRY_CODE O código do país não é válido.
INVALID_ENUM_VALUE O valor da enumeração não pode ser usado.
INVALID_USER_LIST_TYPE O tipo da lista de usuários não é aplicável a esta solicitação.
INVALID_AUDIENCE_MEMBER Este membro do público-alvo não é válido.
TOO_MANY_AUDIENCE_MEMBERS O número máximo de membros do público-alvo permitido por solicitação é 10.000.
TOO_MANY_USER_IDENTIFIERS O número máximo de identificadores de usuários permitidos por membro do público-alvo é 10.
TOO_MANY_DESTINATIONS O número máximo de destinos permitidos por solicitação é 10.
INVALID_DESTINATION O destino não é válido.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED O parceiro de dados não tem acesso à lista de usuários da conta operacional.
INVALID_MOBILE_ID_FORMAT O formato do ID do dispositivo móvel não é válido.
INVALID_USER_LIST_ID A lista de usuários não é válida.
MULTIPLE_DATA_TYPES_NOT_ALLOWED Não é permitido ingerir vários tipos de dados em uma única solicitação.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER As configurações de destino que contêm uma conta de login do DataPartner precisam ter a mesma conta de login em todas as configurações de destino.
TERMS_AND_CONDITIONS_NOT_SIGNED Os Termos e Condições obrigatórios não foram aceitos.
INVALID_NUMBER_FORMAT Formato de número inválido.
INVALID_CONVERSION_ACTION_ID O ID da ação de conversão não é válido.
INVALID_CONVERSION_ACTION_TYPE O tipo de ação de conversão não é válido.
INVALID_CURRENCY_CODE O código de moeda não é aceito.
INVALID_EVENT Este evento não é válido.
TOO_MANY_EVENTS O número máximo de eventos permitidos por solicitação é 10.000.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS A conta de destino não está ativada para conversões otimizadas para leads.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS Não é possível usar as conversões otimizadas para a conta de destino devido às políticas de dados do cliente do Google. Entre em contato com seu representante do Google.
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED A conta de destino não aceitou os termos das conversões otimizadas.
DUPLICATE_DESTINATION_REFERENCE Dois ou mais destinos na solicitação têm a mesma referência.
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER Conta operacional sem suporte para autorização de parceiro de dados.
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER Conta vinculada não compatível para autorização de parceiro de dados.
NO_IDENTIFIERS_PROVIDED Os dados de eventos não contêm identificadores de usuário ou de publicidade.
INVALID_PROPERTY_TYPE O tipo de propriedade não é compatível.
INVALID_STREAM_TYPE O tipo de stream não é compatível.
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT A conta vinculada só é compatível quando a conta de login é uma conta DATA_PARTNER.
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH A conta de login precisa ser a mesma da conta operacional para o caso de uso específico.
EVENT_TIME_INVALID O evento não ocorreu dentro do período aceitável.
RESERVED_NAME_USED O parâmetro usa um nome reservado.
INVALID_EVENT_NAME O nome do evento não é compatível.
NOT_ALLOWLISTED A conta não está na lista de permissões para o recurso especificado.
INVALID_REQUEST_ID O ID da solicitação usado para recuperar o status de uma solicitação não é válido. O status só pode ser recuperado para solicitações bem-sucedidas e que não têm validate_only=true.
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT Um evento tinha dois ou mais destinos do Google Analytics.
FIELD_VALUE_TOO_LONG O valor do campo é muito longo.
TOO_MANY_ELEMENTS Há muitos elementos em uma lista na solicitação.

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

Opcional. O identificador exclusivo do evento. Obrigatório para conversões que usam várias fontes de dados.
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.
event_name

string

Opcional. O nome do evento. Obrigatório para eventos do GA4.
client_id

string

Opcional. Um identificador exclusivo da instância de usuário de um cliente da Web para este fluxo da Web do GA4.
user_id

string

Opcional. Um identificador exclusivo de um usuário, conforme definido pelo anunciante.
additional_event_parameters[]

EventParameter

Opcional. Um agrupamento de parâmetros de evento a serem incluídos no evento que ainda não foram especificados usando outros campos estruturados.

EventParameter

Parâmetro de evento para eventos do GA4.

Campos
parameter_name

string

Obrigatório. O nome do parâmetro a ser usado.
value

string

Obrigatório. A representação de string do valor do parâmetro a ser definido.

EventSource

A origem do evento.

Tipos enumerados
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 com base em 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. Precisa estar no formato "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}".
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.

Tipos enumerados
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.

É possível testar esse método no APIs Explorer REST:
Testar com REST
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.

É possível testar esse método no APIs Explorer REST:
Testar com REST
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.
item_id

string

Opcional. Um identificador exclusivo para referenciar o item.
additional_item_parameters[]

ItemParameter

Opcional. Um agrupamento de parâmetros de evento relacionados a um item que serão incluídos no evento e que ainda não foram especificados usando outros campos estruturados.

ItemParameter

Um agrupamento de parâmetros de evento relacionados a um item que serão incluídos no evento e que ainda não foram especificados usando outros campos estruturados.

Campos
parameter_name

string

Obrigatório. O nome do parâmetro a ser usado.
value

string

Obrigatório. A representação de string do valor do parâmetro a ser definido.

MatchRateRange

O intervalo da taxa de correspondência do upload ou da lista de usuários.

Tipos enumerados
MATCH_RATE_RANGE_UNKNOWN O intervalo da taxa de correspondência é desconhecido.
MATCH_RATE_RANGE_NOT_ELIGIBLE O intervalo de taxa de correspondência não está qualificado.
MATCH_RATE_RANGE_LESS_THAN_20 O intervalo da taxa de correspondência é inferior a 20% (no intervalo [0, 20)).
MATCH_RATE_RANGE_20_TO_30 O intervalo da taxa de correspondência é entre 20% e 30% (no intervalo [20, 31)).
MATCH_RATE_RANGE_31_TO_40 O intervalo da taxa de correspondência é entre 31% e 40% (no intervalo [31, 41)).
MATCH_RATE_RANGE_41_TO_50 O intervalo da taxa de correspondência está entre 41% e 50% (no intervalo [41, 51)).
MATCH_RATE_RANGE_51_TO_60 O intervalo da taxa de correspondência é entre 51% e 60% (no intervalo [51, 61).
MATCH_RATE_RANGE_61_TO_70 O intervalo da taxa de correspondência está entre 61% e 70% (no intervalo [61, 71)).
MATCH_RATE_RANGE_71_TO_80 O intervalo da taxa de correspondência está entre 71% e 80% (no intervalo [71, 81)).
MATCH_RATE_RANGE_81_TO_90 O intervalo da taxa de correspondência está entre 81% e 90% (no intervalo [81, 91)).
MATCH_RATE_RANGE_91_TO_100

O intervalo da taxa de correspondência é entre 91% e 100% (no intervalo [91, 100]).

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 da 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.

ProcessingErrorReason

O motivo do erro de processamento.

Tipos enumerados
PROCESSING_ERROR_REASON_UNSPECIFIED O motivo do erro de processamento é desconhecido.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE A variável personalizada é inválida.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED O status da variável personalizada não está ativado.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD A conversão é mais antiga que a idade máxima aceita.
PROCESSING_ERROR_REASON_DUPLICATE_GCLID Já existe uma conversão com os mesmos valores de GCLID e data/hora no sistema.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID Uma conversão com a mesma combinação de ID do pedido e ação de conversão já foi enviada.
PROCESSING_ERROR_REASON_INVALID_GBRAID Não foi possível decodificar o GBRAID.
PROCESSING_ERROR_REASON_INVALID_GCLID Não foi possível decodificar o ID de clique do Google.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID O ID do comerciante contém caracteres que não são dígitos.
PROCESSING_ERROR_REASON_INVALID_WBRAID Não foi possível decodificar o wbraid.
PROCESSING_ERROR_REASON_INTERNAL_ERROR Erro interno.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Os Termos das conversões otimizadas não foram assinados na conta de destino.
PROCESSING_ERROR_REASON_INVALID_EVENT O evento é inválido.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS O número de transações correspondentes é menor que o limite mínimo.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS As transações são menores que o limite mínimo.
PROCESSING_ERROR_REASON_INVALID_FORMAT O evento tem um erro de formato.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR O evento tem um erro de descriptografia.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR Não foi possível descriptografar a DEK.
PROCESSING_ERROR_REASON_INVALID_WIP O WIP está formatado incorretamente ou não existe.
PROCESSING_ERROR_REASON_INVALID_KEK A KEK não pode descriptografar dados porque é a KEK errada ou não existe.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED O WIP não pôde ser usado porque foi rejeitado pela condição de atestado.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED O sistema não tinha as permissões necessárias para acessar a KEK.
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED O sistema não conseguiu fazer a autenticação com a AWS.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Não foi possível descriptografar os dados UserIdentifier usando a DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER O usuário tentou ingerir eventos com um identificador de publicidade que não é dos anúncios da conta operacional.

ProcessingWarningReason

O motivo do aviso de processamento.

Tipos enumerados
PROCESSING_WARNING_REASON_UNSPECIFIED O motivo do aviso de processamento é desconhecido.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED O sistema não tinha as permissões necessárias para acessar a KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR Não foi possível descriptografar a DEK.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR O evento tem um erro de descriptografia.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED O WIP não pôde ser usado porque foi rejeitado pela condição de atestado.
PROCESSING_WARNING_REASON_INVALID_WIP O WIP está formatado incorretamente ou não existe.
PROCESSING_WARNING_REASON_INVALID_KEK A KEK não pode descriptografar dados porque é a KEK errada ou não existe.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Não foi possível descriptografar os dados UserIdentifier usando a DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR Erro interno.
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED O sistema não conseguiu fazer a autenticação com a AWS.

Produto

Obsoleto. Use AccountType. Representa um produto específico do Google.

Tipos enumerados
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
(deprecated)

Product

Obsoleto. Use account_type.
account_id

string

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

AccountType

Opcional. O tipo da conta. Por exemplo, GOOGLE_ADS. É necessário account_type ou o product descontinuado. Se os dois forem definidos, os valores precisarão corresponder.

AccountType

Representa tipos de Contas do Google. Usado para localizar contas e destinos.

Tipos enumerados
ACCOUNT_TYPE_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.
GOOGLE_ANALYTICS_PROPERTY Google Analytics.

RemoveAudienceMembersRequest

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

É possível testar esse método no APIs Explorer REST:
Testar com REST
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.

RequestStatusPerDestination

Um status de solicitação por destino.

Campos
destination

Destination

Um destino em uma solicitação da API DM.
request_status

RequestStatus

O status da solicitação do destino.
error_info

ErrorInfo

Um erro de informações que contém o motivo e as contagens de erros relacionados ao upload.
warning_info

WarningInfo

Informações de aviso que contêm o motivo e a quantidade de avisos relacionados ao envio.
Campo de união status. O status do destino. status pode ser apenas de um dos tipos a seguir:
audience_members_ingestion_status

IngestAudienceMembersStatus

O status da solicitação de inclusão de membros do público-alvo.
events_ingestion_status

IngestEventsStatus

O status da solicitação de eventos de ingestão.
audience_members_removal_status

RemoveAudienceMembersStatus

O status da solicitação de remoção de participantes do público-alvo.

IngestAudienceMembersStatus

O status da solicitação de inclusão de membros do público-alvo.

Campos
Campo de união status. O status da ingestão de participantes do público-alvo no destino. status pode ser apenas de um dos tipos a seguir:
user_data_ingestion_status

IngestUserDataStatus

O status da ingestão de dados do usuário no destino.
mobile_data_ingestion_status

IngestMobileDataStatus

O status da ingestão de dados móveis no destino.
pair_data_ingestion_status

IngestPairDataStatus

O status da ingestão de dados do par no destino.

IngestEventsStatus

O status da ingestão de eventos no destino.

Campos
record_count

int64

A contagem total de eventos enviados na solicitação de upload. Inclui todos os eventos na solicitação, independentemente de terem sido ingeridos com sucesso ou não.

IngestMobileDataStatus

O status da ingestão de dados móveis no destino que contém estatísticas relacionadas a ela.

Campos
record_count

int64

A contagem total de membros do público-alvo enviada na solicitação de upload para o destino. Inclui todos os membros do público-alvo na solicitação, independentemente de terem sido ingeridos ou não.
mobile_id_count

int64

A contagem total de IDs de dispositivos móveis enviados na solicitação de upload para o destino. Inclui todos os IDs de dispositivos móveis na solicitação, independentemente de terem sido ingeridos ou não.

IngestPairDataStatus

O status da ingestão de dados do par no destino que contém estatísticas relacionadas à ingestão.

Campos
record_count

int64

A contagem total de membros do público-alvo enviada na solicitação de upload para o destino. Inclui todos os membros do público-alvo na solicitação, independentemente de terem sido ingeridos ou não.
pair_id_count

int64

A contagem total de IDs de pares enviados na solicitação de upload para o destino. Inclui todos os IDs de pares na solicitação, independente de terem sido ingeridos ou não.

IngestUserDataStatus

O status da ingestão de dados do usuário no destino com estatísticas relacionadas a ela.

Campos
record_count

int64

A contagem total de membros do público-alvo enviada na solicitação de upload para o destino. Inclui todos os membros do público-alvo na solicitação, independentemente de terem sido ingeridos ou não.
user_identifier_count

int64

A contagem total de identificadores de usuário enviados na solicitação de upload para o destino. Inclui todos os identificadores de usuário na solicitação, independentemente de terem sido ingeridos ou não.
upload_match_rate_range

MatchRateRange

O intervalo da taxa de correspondência do upload.

RemoveAudienceMembersStatus

O status da solicitação de remoção de participantes do público-alvo.

Campos
Campo de união status. O status da remoção dos participantes do público-alvo do destino. status pode ser apenas de um dos tipos a seguir:
user_data_removal_status

RemoveUserDataStatus

O status da remoção dos dados do usuário do destino.
mobile_data_removal_status

RemoveMobileDataStatus

O status da remoção de dados móveis do destino.
pair_data_removal_status

RemovePairDataStatus

O status da remoção dos dados do par do destino.

RemoveMobileDataStatus

O status da remoção de dados móveis do destino.

Campos
record_count

int64

A contagem total de membros do público-alvo enviada na solicitação de remoção. Inclui todos os membros do público-alvo na solicitação, independente de terem sido removidos ou não.
mobile_id_count

int64

A contagem total de IDs de dispositivos móveis enviados na solicitação de remoção. Inclui todos os IDs de dispositivos móveis na solicitação, independentemente de terem sido removidos ou não.

RemovePairDataStatus

O status da remoção dos dados do par do destino.

Campos
record_count

int64

A contagem total de membros do público-alvo enviada na solicitação de remoção. Inclui todos os membros do público-alvo na solicitação, independente de terem sido removidos ou não.
pair_id_count

int64

A contagem total de IDs de pares enviados na solicitação de remoção. Inclui todos os IDs de pares na solicitação, independente de terem sido removidos ou não.

RemoveUserDataStatus

O status da remoção dos dados do usuário do destino.

Campos
record_count

int64

A contagem total de membros do público-alvo enviada na solicitação de remoção. Inclui todos os membros do público-alvo na solicitação, independente de terem sido removidos ou não.
user_identifier_count

int64

A contagem total de identificadores de usuário enviados na solicitação de remoção. Inclui todos os identificadores de usuário na solicitação, independentemente de terem sido removidos ou não.

RequestStatus

O status da solicitação.

Tipos enumerados
REQUEST_STATUS_UNKNOWN O status da solicitação é desconhecido.
SUCCESS A solicitação foi concluída.
PROCESSING A solicitação está sendo processada.
FAILED Falha na solicitação.
PARTIAL_SUCCESS A solicitação foi parcialmente concluída.

RetrieveRequestStatusRequest

Solicitação para receber o status da solicitação feita à API DM para um determinado ID de solicitação. Retorna um RetrieveRequestStatusResponse.

É possível testar esse método no APIs Explorer REST:
Testar com REST
Campos
request_id

string

Obrigatório. Obrigatório. O ID da solicitação da API Data Manager.

RetrieveRequestStatusResponse

Resposta do RetrieveRequestStatusRequest.

Campos
request_status_per_destination[]

RequestStatusPerDestination

Uma lista de status de solicitação por destino. A ordem dos status corresponde à ordem dos destinos na solicitação original.

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 ao ingerir UserData ou MobileData. Esse campo não é obrigatório para a lista de usuários da Segmentação por parceiro.

TermsOfServiceStatus

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

Tipos enumerados
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 de identificadores possível. 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.
additional_user_properties[]

UserProperty

Opcional. Um agrupamento de outras propriedades do usuário para o usuário associado a esse evento.

UserProperty

Um agrupamento de outras propriedades do usuário para o usuário associado a esse evento.

Campos
property_name

string

Obrigatório. O nome da propriedade do usuário a ser usada.
value

string

Obrigatório. A representação de string do valor da propriedade do usuário a ser usada.

WarningCount

A contagem de avisos para um determinado motivo.

Campos
record_count

int64

A contagem de registros que têm um aviso.
reason

ProcessingWarningReason

O motivo do aviso.

WarningInfo

Contagens de avisos para cada tipo.

Campos
warning_counts[]

WarningCount

Uma lista de avisos e contagens por motivo de aviso.