Índice
IngestionService(interface)MarketingDataInsightsService(interface)PartnerLinkService(interface)UserListDirectLicenseService(interface)UserListGlobalLicenseService(interface)UserListService(interface)AdIdentifiers(mensagem)AddressInfo(mensagem)AgeRange(enum)AudienceMember(mensagem)AwsWrappedKeyInfo(mensagem)AwsWrappedKeyInfo.KeyType(enum)Baseline(mensagem)Baseline.Location(mensagem)CartData(mensagem)Consent(mensagem)ConsentStatus(enum)ContactIdInfo(mensagem)CreatePartnerLinkRequest(mensagem)CreateUserListDirectLicenseRequest(mensagem)CreateUserListGlobalLicenseRequest(mensagem)CreateUserListRequest(mensagem)CustomVariable(mensagem)CustomerType(enum)CustomerValueBucket(enum)DataSourceType(enum)DeletePartnerLinkRequest(mensagem)DeleteUserListRequest(mensagem)Destination(mensagem)DeviceInfo(mensagem)Encoding(enum)EncryptionInfo(mensagem)ErrorCount(mensagem)ErrorInfo(mensagem)ErrorReason(enum)Event(mensagem)EventParameter(mensagem)EventSource(enum)ExperimentalField(mensagem)GcpWrappedKeyInfo(mensagem)GcpWrappedKeyInfo.KeyType(enum)Gender(enum)GetUserListDirectLicenseRequest(mensagem)GetUserListGlobalLicenseRequest(mensagem)GetUserListRequest(mensagem)IngestAudienceMembersRequest(mensagem)IngestAudienceMembersResponse(mensagem)IngestEventsRequest(mensagem)IngestEventsResponse(mensagem)IngestedUserListInfo(mensagem)IngestedUserListInfo.UploadKeyType(enum)Item(mensagem)ItemParameter(mensagem)ListUserListDirectLicensesRequest(mensagem)ListUserListDirectLicensesResponse(mensagem)ListUserListGlobalLicenseCustomerInfosRequest(mensagem)ListUserListGlobalLicenseCustomerInfosResponse(mensagem)ListUserListGlobalLicensesRequest(mensagem)ListUserListGlobalLicensesResponse(mensagem)ListUserListsRequest(mensagem)ListUserListsResponse(mensagem)MatchRateRange(enum)MobileData(mensagem)MobileIdInfo(mensagem)MobileIdInfo.KeySpace(enum)PairData(mensagem)PairIdInfo(mensagem)PartnerAudienceInfo(mensagem)PartnerAudienceInfo.PartnerAudienceSource(enum)PartnerLink(mensagem)PpidData(mensagem)ProcessingErrorReason(enum)ProcessingWarningReason(enum)Product(enum) (obsoleto)ProductAccount(mensagem)ProductAccount.AccountType(enum)PseudonymousIdInfo(mensagem)PseudonymousIdInfo.SyncStatus(enum)RemoveAudienceMembersRequest(mensagem)RemoveAudienceMembersResponse(mensagem)RequestStatusPerDestination(mensagem)RequestStatusPerDestination.IngestAudienceMembersStatus(mensagem)RequestStatusPerDestination.IngestEventsStatus(mensagem)RequestStatusPerDestination.IngestMobileDataStatus(mensagem)RequestStatusPerDestination.IngestPairDataStatus(mensagem)RequestStatusPerDestination.IngestPpidDataStatus(mensagem)RequestStatusPerDestination.IngestUserDataStatus(mensagem)RequestStatusPerDestination.IngestUserIdDataStatus(mensagem)RequestStatusPerDestination.RemoveAudienceMembersStatus(mensagem)RequestStatusPerDestination.RemoveMobileDataStatus(mensagem)RequestStatusPerDestination.RemovePairDataStatus(mensagem)RequestStatusPerDestination.RemovePpidDataStatus(mensagem)RequestStatusPerDestination.RemoveUserDataStatus(mensagem)RequestStatusPerDestination.RemoveUserIdDataStatus(mensagem)RequestStatusPerDestination.RequestStatus(enum)RetrieveInsightsRequest(mensagem)RetrieveInsightsResponse(mensagem)RetrieveInsightsResponse.MarketingDataInsight(mensagem)RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension(enum)RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute(mensagem)RetrieveRequestStatusRequest(mensagem)RetrieveRequestStatusResponse(mensagem)SearchPartnerLinksRequest(mensagem)SearchPartnerLinksResponse(mensagem)SizeInfo(mensagem)TargetNetworkInfo(mensagem)TermsOfService(mensagem)TermsOfServiceStatus(enum)UpdateUserListDirectLicenseRequest(mensagem)UpdateUserListGlobalLicenseRequest(mensagem)UpdateUserListRequest(mensagem)UserData(mensagem)UserIdData(mensagem)UserIdInfo(mensagem)UserIdentifier(mensagem)UserList(mensagem)UserList.AccessReason(enum)UserList.AccessStatus(enum)UserList.ClosingReason(enum)UserList.MembershipStatus(enum)UserListDirectLicense(mensagem)UserListGlobalLicense(mensagem)UserListGlobalLicenseCustomerInfo(mensagem)UserListGlobalLicenseType(enum)UserListLicenseClientAccountType(enum)UserListLicenseMetrics(mensagem)UserListLicensePricing(mensagem)UserListLicensePricing.UserListPricingBuyerApprovalState(enum)UserListLicensePricing.UserListPricingCostType(enum)UserListLicenseStatus(enum)UserProperties(mensagem)UserProperty(mensagem)WarningCount(mensagem)WarningInfo(mensagem)
IngestionService
Serviço para enviar dados de público-alvo a destinos compatíveis.
| IngestAudienceMembers |
|---|
|
Faz upload de uma lista de recursos
|
| IngestEvents |
|---|
|
Faz upload de uma lista de recursos
|
| RemoveAudienceMembers |
|---|
|
Remove uma lista de recursos
|
| RetrieveRequestStatus |
|---|
|
Recebe o status de uma solicitação com o ID dela.
|
MarketingDataInsightsService
Serviço para retornar insights sobre dados de marketing.
Esse recurso está disponível apenas para parceiros de dados.
| RetrieveInsights |
|---|
|
Recupera insights de dados de marketing para uma determinada lista de usuários. Esse recurso está disponível apenas para parceiros de dados. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
PartnerLinkService
Serviço para gerenciar links de parceiros.
| CreatePartnerLink |
|---|
|
Cria uma vinculação de parceiro para a conta especificada. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
| DeletePartnerLink |
|---|
|
Exclui uma vinculação de parceiro para a conta especificada. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
| SearchPartnerLinks |
|---|
|
Pesquisa todos os links de parceiro de e para uma determinada conta. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
UserListDirectLicenseService
Serviço para gerenciar licenças diretas de listas de usuários. A exclusão não é uma operação compatível com UserListDirectLicenses. Os chamadores precisam atualizar o status da licença para DISABLED em vez de desativar uma licença.
Esse recurso está disponível apenas para parceiros de dados.
| CreateUserListDirectLicense |
|---|
|
Cria uma licença direta de lista de usuários. Esse recurso está disponível apenas para parceiros de dados.
|
| GetUserListDirectLicense |
|---|
|
Recupera uma licença direta de lista de usuários. Esse recurso está disponível apenas para parceiros de dados.
|
| ListUserListDirectLicenses |
|---|
|
Lista todas as licenças diretas de lista de usuários pertencentes à conta principal. Esse recurso está disponível apenas para parceiros de dados.
|
| UpdateUserListDirectLicense |
|---|
|
Atualiza uma licença direta de lista de usuários. Esse recurso está disponível apenas para parceiros de dados.
|
UserListGlobalLicenseService
Serviço para gerenciar licenças globais de listas de usuários. A exclusão não é uma operação compatível com UserListGlobalLicenses. Os chamadores precisam atualizar o status da licença para DISABLED em vez de desativar uma licença.
Esse recurso está disponível apenas para parceiros de dados.
| CreateUserListGlobalLicense |
|---|
|
Cria uma licença global de lista de usuários. Esse recurso está disponível apenas para parceiros de dados.
|
| GetUserListGlobalLicense |
|---|
|
Recupera uma licença global de lista de usuários. Esse recurso está disponível apenas para parceiros de dados.
|
| ListUserListGlobalLicenseCustomerInfos |
|---|
|
Lista todas as informações do cliente para uma licença global de lista de usuários. Esse recurso está disponível apenas para parceiros de dados.
|
| ListUserListGlobalLicenses |
|---|
|
Lista todas as licenças globais de listas de usuários pertencentes à conta principal. Esse recurso está disponível apenas para parceiros de dados.
|
| UpdateUserListGlobalLicense |
|---|
|
Atualiza uma licença global de lista de usuários. Esse recurso está disponível apenas para parceiros de dados.
|
UserListService
Serviço para gerenciar recursos UserList.
| CreateUserList |
|---|
|
Cria uma UserList. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
| DeleteUserList |
|---|
|
Exclui uma UserList. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
| GetUserList |
|---|
|
Recebe uma UserList. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
| ListUserLists |
|---|
|
Lista UserLists. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
| UpdateUserList |
|---|
|
Atualiza uma UserList. Cabeçalhos de autorização: Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:
|
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 |
Opcional. Atributos de sessão para atribuição e estimativa de eventos. |
gclid |
Opcional. O ID de clique do Google (gclid) associado a esse evento. |
gbraid |
Opcional. O identificador de cliques associados a eventos de app e feitos em dispositivos iOS 14 (ou mais recente). |
wbraid |
Opcional. O identificador de cliques associados a eventos da Web e feitos em dispositivos iOS 14 (ou mais recente). |
landing_page_device_info |
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 |
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 |
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 |
Obrigatório. O código regional com duas letras no formato ISO-3166-1 alfa-2 do endereço do usuário. |
postal_code |
Obrigatório. O CEP do endereço do usuário. |
Faixa etária
As faixas etárias demográficas
| Tipos enumerados | |
|---|---|
AGE_RANGE_UNSPECIFIED |
Não especificado. |
AGE_RANGE_UNKNOWN |
Desconhecido. |
AGE_RANGE_18_24 |
Entre 18 e 24 anos. |
AGE_RANGE_25_34 |
Entre 25 e 34 anos. |
AGE_RANGE_35_44 |
Entre 35 e 44 anos. |
AGE_RANGE_45_54 |
Entre 45 e 54 anos. |
AGE_RANGE_55_64 |
Entre 55 e 64 anos. |
AGE_RANGE_65_UP |
65 anos ou mais. |
AudienceMember
O membro do público-alvo em que a operação será realizada.
| Campos | |
|---|---|
destination_references[] |
Opcional. Define para qual |
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 |
Dados fornecidos pelo usuário que o identificam. |
pair_data |
IDs da Reconciliação de dados de identificação entre publishers e anunciantes (PAIR). Esse recurso está disponível apenas para parceiros de dados. |
mobile_data |
Dados que identificam os dispositivos móveis do usuário. |
user_id_data |
Dados relacionados a identificadores exclusivos de um usuário, conforme definido pelo anunciante. |
ppid_data |
Dados relacionados a identificadores fornecidos pelo publisher. Esse recurso está disponível apenas para parceiros de dados. |
AwsWrappedKeyInfo
Uma chave de criptografia de dados encapsulada por uma chave do AWS KMS.
| Campos | |
|---|---|
key_type |
Obrigatório. O tipo de algoritmo usado para criptografar os dados. |
role_arn |
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 |
kek_uri |
Obrigatório. O URI da chave do AWS KMS usada para descriptografar a DEK. Precisa estar no formato |
encrypted_dek |
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 |
Valor de referência
Critérios de comparativo de mercado com que os insights são comparados.
| Campos | |
|---|---|
Campo de união baseline. Local de referência com que os insights são comparados. baseline pode ser apenas de um dos tipos a seguir: |
|
baseline_location |
O local de referência da solicitação. O local de referência é uma lista OR das regiões solicitadas. |
location_auto_detection_enabled |
Se definido como "true", o serviço tentará detectar automaticamente o local de base para insights. |
Local
O local de referência da solicitação. O local de referência está na lista OR de códigos de região ISO 3166-1 alpha-2 das regiões solicitadas.
| Campos | |
|---|---|
region_codes[] |
Lista de códigos de região ISO 3166-1 alfa-2. |
CartData
Os dados do carrinho associados ao evento.
| Campos | |
|---|---|
merchant_id |
Opcional. O ID do Merchant Center associado aos itens. |
merchant_feed_label |
Opcional. O rótulo do feed do Merchant Center associado ao feed dos itens. |
merchant_feed_language_code |
Opcional. O código de idioma no ISO 639-1 associado ao feed do Merchant Center dos itens. |
transaction_discount |
Opcional. A soma de todos os descontos associados à transação. |
items[] |
Opcional. A lista de itens associados ao evento. |
Consentimento
Configurações de consentimento da Lei de Mercados Digitais (DMA) para o usuário.
| Campos | |
|---|---|
ad_user_data |
Opcional. Representa se o usuário consente com os dados do usuário do anúncio. |
ad_personalization |
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. |
ContactIdInfo
Informações adicionais quando CONTACT_ID é um dos upload_key_types.
| Campos | |
|---|---|
match_rate_percentage |
Apenas saída. Taxa de correspondência para listas de usuários da segmentação por lista de clientes. |
data_source_type |
Opcional. Imutável. Origem dos dados de upload |
CreatePartnerLinkRequest
Solicitação para criar um recurso PartnerLink. Retorna um PartnerLink.
| Campos | |
|---|---|
parent |
Obrigatório. O pai, que tem essa coleção de links de parceiro. Formato: accountTypes/{account_type}/accounts/{account} |
partner_link |
Obrigatório. O link de parceiro a ser criado. |
CreateUserListDirectLicenseRequest
Solicitação para criar um recurso UserListDirectLicense.
| Campos | |
|---|---|
parent |
Obrigatório. A conta proprietária da lista de usuários que está sendo licenciada. Precisa estar no formato accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} |
user_list_direct_license |
Obrigatório. A licença direta da lista de usuários a ser criada. |
CreateUserListGlobalLicenseRequest
Solicitação para criar um recurso UserListGlobalLicense.
| Campos | |
|---|---|
parent |
Obrigatório. A conta proprietária da lista de usuários que está sendo licenciada. Precisa estar no formato accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} |
user_list_global_license |
Obrigatório. A licença global da lista de usuários a ser criada. |
CreateUserListRequest
Mensagem de solicitação para CreateUserList.
| Campos | |
|---|---|
parent |
Obrigatório. A conta principal em que essa lista de usuários será criada. Formato: accountTypes/{account_type}/accounts/{account} |
user_list |
Obrigatório. A lista de usuários a ser criada. |
validate_only |
Opcional. Se for verdadeiro, a solicitação será validada, mas não executada. |
CustomVariable
Variável personalizada para conversões de anúncios.
| Campos | |
|---|---|
variable |
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 |
Opcional. O valor a ser armazenado para a variável personalizada. |
destination_references[] |
Opcional. String de referência usada para determinar a qual dos |
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 é de baixo valor. |
MEDIUM |
O cliente é de valor médio. |
HIGH |
O cliente é de alto valor. |
DataSourceType
Indica a origem dos dados de upload.
| Tipos enumerados | |
|---|---|
DATA_SOURCE_TYPE_UNSPECIFIED |
Não especificado. |
DATA_SOURCE_TYPE_FIRST_PARTY |
Os dados enviados são próprios. |
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU |
Os dados enviados são de uma agência de crédito terceirizada. |
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE |
Os dados enviados são de um arquivo de eleitores de terceiros. |
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA |
Os dados enviados são de parceiros terceirizados. |
DeletePartnerLinkRequest
Solicitação para excluir um recurso PartnerLink. Retorna um google.protobuf.Empty.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da vinculação de parceiro a ser excluída. Formato: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} |
DeleteUserListRequest
Mensagem de solicitação para "DeleteUserList".
| Campos | |
|---|---|
name |
Obrigatório. O nome da lista de usuários a ser excluída. Formato: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
validate_only |
Opcional. Se for verdadeiro, a solicitação será validada, mas não executada. |
Destino
O produto do Google para onde você está enviando dados. Por exemplo, uma conta do Google Ads.
| Campos | |
|---|---|
reference |
Opcional. ID do recurso |
login_account |
Opcional. A conta usada para fazer essa chamada de API. Para adicionar ou remover dados do |
linked_account |
Opcional. Uma conta a que o |
operating_account |
Obrigatório. A conta para enviar ou remover os dados. |
product_destination_id |
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 |
Opcional. A string de user agent do dispositivo para o contexto especificado. |
ip_address |
Opcional. O endereço IP do dispositivo para o contexto especificado. Observação:o Google Ads não é compatível com correspondência de endereços IP para usuários finais no Espaço Econômico Europeu (EEE), no Reino Unido ou na Suíça. Adicione lógica para excluir condicionalmente o compartilhamento de endereços IP de usuários dessas regiões e dê informações claras e abrangentes sobre os dados coletados nos seus sites, apps e outros serviços. Além disso, peça o consentimento quando exigido por lei ou pelas políticas relevantes do Google. 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.
| 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 |
Informações da chave encapsulada do Google Cloud Platform. |
aws_wrapped_key_info |
Informações da chave encapsulada do Amazon Web Services. |
ErrorCount
A contagem de erros para um determinado motivo.
| Campos | |
|---|---|
record_count |
A contagem de registros que não foram enviados por um determinado motivo. |
reason |
O motivo do erro dos registros com falha. |
ErrorInfo
Contagens de erros para cada tipo de erro.
| Campos | |
|---|---|
error_counts[] |
Uma lista de erros e contagens por motivo de erro. Pode não ser preenchido em todos os casos. |
ErrorReason
Motivos de erro para a API Data Manager. OBSERVAÇÃO: esse tipo enumerado não está congelado, e novos valores podem ser adicionados no futuro.
| 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 da 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 não compatível 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 em questão. |
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. |
ALREADY_EXISTS |
O recurso já existe. |
IMMUTABLE_FIELD_FOR_UPDATE |
Tentou definir um campo imutável para uma solicitação de atualização. |
INVALID_RESOURCE_NAME |
O nome do recurso é inválido. |
INVALID_FILTER |
O filtro de consulta é inválido. |
INVALID_UPDATE_MASK |
A máscara de atualização é inválida. |
INVALID_PAGE_TOKEN |
O token de página é inválido. |
CANNOT_UPDATE_DISABLED_LICENSE |
Não é possível atualizar uma licença desativada. |
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST |
Não é possível licenciar listas de usuários sensíveis para esse cliente. |
INSUFFICIENT_COST |
O custo é muito baixo para esta licença. |
CANNOT_DISABLE_LICENSE |
Não é possível desativar a licença do revendedor porque ela está em uso. |
INVALID_CLIENT_ACCOUNT_ID |
ID da conta do cliente inválido. |
PRICING_ONLY_ZERO_COST_ALLOWED |
Não é permitido custo diferente de zero para esta conta de cliente. |
PRICE_TOO_HIGH |
O custo é muito alto para esta licença. |
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE |
O cliente não tem permissão para criar uma licença. |
INVALID_PRICING_END_DATE |
A data de término dos preços é inválida para esta licença. |
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT |
Não é possível licenciar uma lista lógica de usuários com um segmento compartilhado ou licenciado. |
MISMATCHED_ACCOUNT_TYPE |
O tipo de conta do cliente na solicitação não corresponde ao tipo de conta real do cliente. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE |
O tipo de licença não é compatível com o custo de compartilhamento de mídia. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER |
O tipo de cliente não aceita o custo de participação de mídia. |
INVALID_MEDIA_SHARE_COST |
Custo de parcela de mídia inválido. |
INVALID_COST_TYPE |
Tipo de custo inválido. |
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST |
O tipo UserList não é compatível com o custo de participação de mídia. |
MAX_COST_NOT_ALLOWED |
O custo máximo só é permitido para cost_type MEDIA_SHARE. |
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED |
O público-alvo de comércio só pode ser licenciado diretamente. |
INVALID_DESCRIPTION |
A descrição não é válida. |
INVALID_DISPLAY_NAME |
O nome de exibição não é válido. |
DISPLAY_NAME_ALREADY_USED |
O nome de exibição já está sendo usado em outra lista de usuários da conta. |
OWNERSHIP_REQUIRED_FOR_UPDATE |
É necessário ter a propriedade para modificar a lista de usuários. |
USER_LIST_MUTATION_NOT_SUPPORTED |
O tipo de lista de usuários é somente leitura e não aceita mutação. |
SENSITIVE_USER_LIST_IMMUTABLE |
Uma lista de usuários sensível à privacidade ou rejeitada por motivos legais não pode ser alterada por usuários externos. |
BILLABLE_RECORD_COUNT_IMMUTABLE |
O campo de registro faturável da lista de usuários de remarketing não pode ser modificado depois de definido. |
USER_LIST_NAME_RESERVED |
O nome da lista de usuários está reservado para listas do sistema. |
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA |
O anunciante precisa estar na lista de permissão para usar listas de remarketing criadas com dados enviados por ele. |
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE |
A origem do público-alvo do parceiro não é compatível com o tipo de lista de usuários. |
COMMERCE_PARTNER_NOT_ALLOWED |
A definição do campo commerce_partner só é compatível se o partner_audience_source for COMMERCE_AUDIENCE. |
UNSUPPORTED_PARTNER_AUDIENCE_INFO |
O campo partner_audience_info não é compatível com o tipo de lista de usuários. |
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED |
As contas de administrador não podem criar listas de usuários da Segmentação por parceiro. |
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA |
O parceiro de dados não está na lista de permissões para THIRD_PARTY_PARTNER_DATA. |
ADVERTISER_TOS_NOT_ACCEPTED |
O anunciante não aceitou os Termos de Serviço do parceiro. |
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA |
O anunciante não está na lista de permissões para THIRD_PARTY_PARTNER_DATA. |
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT |
Esse tipo de lista de usuários não é compatível com esta conta. |
INVALID_COMMERCE_PARTNER |
O campo commerce_partner é inválido. |
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE |
O provedor de dados não está na lista de permissões para criar públicos-alvo de comércio. |
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES |
Os tipos de chave de upload da lista de usuários não são compatíveis. |
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG |
A configuração de informações da lista de usuários ingerida não é compatível. |
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE |
Os tipos de conta não são compatíveis com o tipo de lista de usuários. |
UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK |
Os tipos de conta não são compatíveis com a vinculação de parceiro. |
Evento
Um evento que representa uma interação do usuário com o site ou app de um anunciante.
| Campos | |
|---|---|
destination_references[] |
Opcional. String de referência usada para determinar o destino. Se estiver vazio, o evento será enviado para todos os |
transaction_id |
Opcional. O identificador exclusivo do evento. Obrigatório para conversões que usam várias fontes de dados. |
event_timestamp |
Obrigatório. Hora em que o evento ocorreu |
last_updated_timestamp |
Opcional. A última vez que o evento foi atualizado. |
user_data |
Opcional. Partes de dados fornecidos pelo usuário, representando o usuário a que o evento está associado. |
consent |
Opcional. Informações sobre se o usuário associado deu diferentes tipos de consentimento. |
ad_identifiers |
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 |
Opcional. O código da moeda associado a todos os valores monetários neste evento. |
event_source |
Opcional. Indicador de onde o evento ocorreu (Web, app, loja física etc.). |
event_device_info |
Opcional. Informações coletadas sobre o dispositivo usado (se houver) quando o evento ocorreu. |
cart_data |
Opcional. Informações sobre a transação e os itens associados ao evento. |
custom_variables[] |
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[] |
Opcional. Uma lista de pares de chave-valor para campos experimentais que podem ser promovidos para fazer parte da API. |
user_properties |
Opcional. Informações avaliadas pelo anunciante sobre o usuário no momento em que o evento ocorreu. |
event_name |
Opcional. O nome do evento. Obrigatório para eventos do GA4. |
client_id |
Opcional. Um identificador exclusivo da instância de usuário de um cliente da Web para este fluxo da Web do GA4. |
user_id |
Opcional. Um identificador exclusivo de um usuário, conforme definido pelo anunciante. |
additional_event_parameters[] |
Opcional. Um agrupamento de qualquer parâmetro de evento a ser incluído no evento que ainda não foi especificado usando outros campos estruturados. |
conversion_value |
Opcional. O valor de conversão associado ao evento, para conversões com base no valor. |
EventParameter
Parâmetro de evento para eventos do GA4.
| Campos | |
|---|---|
parameter_name |
Obrigatório. O nome do parâmetro a ser usado. |
value |
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 |
Opcional. O nome do campo a ser usado. |
value |
Opcional. O valor do campo a ser definido. |
GcpWrappedKeyInfo
Informações sobre a chave encapsulada do Google Cloud Platform.
| Campos | |
|---|---|
key_type |
Obrigatório. O tipo de algoritmo usado para criptografar os dados. |
wip_provider |
Obrigatório. O provedor de pool de Identidade da carga de trabalho necessário para usar a KEK. |
kek_uri |
Obrigatório. ID do recurso do Cloud Key Management Service do Google Cloud Platform. Precisa estar no formato |
encrypted_dek |
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 |
Gênero
O tipo de gênero demográfico (por exemplo, feminino).
| Tipos enumerados | |
|---|---|
GENDER_UNSPECIFIED |
Não especificado. |
GENDER_UNKNOWN |
Desconhecido. |
GENDER_MALE |
Masculino. |
GENDER_FEMALE |
Feminino. |
GetUserListDirectLicenseRequest
Solicitação para receber um recurso UserListDirectLicense.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da licença direta da lista de usuários. |
GetUserListGlobalLicenseRequest
Solicitação para receber um recurso UserListGlobalLicense.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da licença global da lista de usuários. |
GetUserListRequest
Mensagem de solicitação para GetUserList.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da UserList a ser recuperada. Formato: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
IngestAudienceMembersRequest
Solicitação para fazer upload de participantes do público-alvo nos destinos fornecidos. Retorna um IngestAudienceMembersResponse.
| Campos | |
|---|---|
destinations[] |
Obrigatório. A lista de destinos para enviar os membros do público-alvo. |
audience_members[] |
Obrigatório. A lista de usuários para enviar aos destinos especificados. No máximo 10.000 recursos |
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 |
validate_only |
Opcional. Para fins de teste. Se |
encoding |
Opcional. Obrigatório para uploads de |
encryption_info |
Opcional. Informações de criptografia para uploads do |
terms_of_service |
Opcional. Os Termos de Serviço que o usuário aceitou/rejeitou. |
IngestAudienceMembersResponse
Resposta do IngestAudienceMembersRequest.
| Campos | |
|---|---|
request_id |
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[] |
Obrigatório. A lista de destinos para enviar os eventos. |
events[] |
Obrigatório. A lista de eventos a serem enviados aos destinos especificados. No máximo, 2.000 recursos |
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 |
validate_only |
Opcional. Para fins de teste. Se |
encoding |
Opcional. Obrigatório para uploads de |
encryption_info |
Opcional. Informações de criptografia para uploads do |
IngestEventsResponse
Resposta do IngestEventsRequest.
| Campos | |
|---|---|
request_id |
O ID gerado automaticamente da solicitação. |
IngestedUserListInfo
Representa uma lista de usuários preenchida com dados fornecidos pelo usuário.
| Campos | |
|---|---|
upload_key_types[] |
Obrigatório. Imutável. Tipos de chaves de upload dessa lista de usuários. |
contact_id_info |
Opcional. Informações adicionais quando |
mobile_id_info |
Opcional. Informações adicionais quando |
user_id_info |
Opcional. Informações adicionais quando |
pair_id_info |
Opcional. Informações adicionais quando Esse recurso está disponível apenas para parceiros de dados. |
pseudonymous_id_info |
Opcional. Informações adicionais para |
partner_audience_info |
Opcional. Informações adicionais para públicos-alvo de parceiros. Esse recurso está disponível apenas para parceiros de dados. |
UploadKeyType
Enumeração que contém os possíveis tipos de chave de upload de uma lista de usuários.
| Tipos enumerados | |
|---|---|
UPLOAD_KEY_TYPE_UNSPECIFIED |
Não especificado. |
CONTACT_ID |
Informações do cliente, como endereço de e-mail, número de telefone ou endereço físico. |
MOBILE_ID |
IDs de publicidade móvel. |
USER_ID |
IDs de usuários fornecidos por terceiros. |
PAIR_ID |
IDs de reconciliação de dados de identificação entre publishers e anunciantes. |
PSEUDONYMOUS_ID |
IDs da plataforma de gerenciamento de dados: - ID de usuário do Google - ID fornecido pelo parceiro - ID fornecido pelo editor - IDFA do iOS - ID de publicidade do Android - ID do Roku - ID do Amazon Fire TV - ID do Xbox ou da Microsoft |
Item
Representa um item no carrinho associado ao evento.
| Campos | |
|---|---|
merchant_product_id |
Opcional. O ID do produto na conta do Merchant Center. |
quantity |
Opcional. O número deste item associado ao evento. |
unit_price |
Opcional. O preço unitário, excluindo tributos, frete e descontos no nível da transação. |
item_id |
Opcional. Um identificador exclusivo para referenciar o item. |
additional_item_parameters[] |
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 |
Obrigatório. O nome do parâmetro a ser usado. |
value |
Obrigatório. A representação de string do valor do parâmetro a ser definido. |
ListUserListDirectLicensesRequest
Solicitação para listar todos os recursos UserListDirectLicense de uma determinada conta.
| Campos | |
|---|---|
parent |
Obrigatório. A conta cujas licenças estão sendo consultadas. Precisa estar no formato accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} |
filter |
Opcional. Filtros a serem aplicados à solicitação de lista. Todos os campos precisam estar à esquerda de cada condição (por exemplo: user_list_id = 123). Operações compatíveis:
Campos sem suporte:
|
page_size |
Opcional. O número máximo de licenças a serem retornadas por página. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 licenças serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. |
page_token |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
ListUserListDirectLicensesResponse
Resposta do ListUserListDirectLicensesRequest.
| Campos | |
|---|---|
user_list_direct_licenses[] |
As licenças da lista de usuários especificada na solicitação. |
next_page_token |
Um token, que pode ser enviado como |
ListUserListGlobalLicenseCustomerInfosRequest
Solicitação para listar todos os recursos UserListGlobalLicenseCustomerInfo de uma determinada licença global de lista de usuários.
| Campos | |
|---|---|
parent |
Obrigatório. A licença global cujas informações do cliente estão sendo consultadas. É necessário seguir este formato |
filter |
Opcional. Filtros a serem aplicados à solicitação de lista. Todos os campos precisam estar à esquerda de cada condição (por exemplo: user_list_id = 123). Operações compatíveis:
Campos sem suporte:
|
page_size |
Opcional. O número máximo de licenças a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 licenças serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. |
page_token |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
ListUserListGlobalLicenseCustomerInfosResponse
Resposta da [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].
| Campos | |
|---|---|
user_list_global_license_customer_infos[] |
As informações do cliente para a licença especificada na solicitação. |
next_page_token |
Um token, que pode ser enviado como |
ListUserListGlobalLicensesRequest
Solicitação para listar todos os recursos UserListGlobalLicense de uma determinada conta.
| Campos | |
|---|---|
parent |
Obrigatório. A conta cujas licenças estão sendo consultadas. Precisa estar no formato accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} |
filter |
Opcional. Filtros a serem aplicados à solicitação de lista. Todos os campos precisam estar à esquerda de cada condição (por exemplo: user_list_id = 123). Operações compatíveis:
Campos sem suporte:
|
page_size |
Opcional. O número máximo de licenças a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 licenças serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. |
page_token |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
ListUserListGlobalLicensesResponse
Resposta do ListUserListGlobalLicensesRequest.
| Campos | |
|---|---|
user_list_global_licenses[] |
As licenças da lista de usuários especificada na solicitação. |
next_page_token |
Um token, que pode ser enviado como |
ListUserListsRequest
Mensagem de solicitação para "ListUserLists".
| Campos | |
|---|---|
parent |
Obrigatório. A conta principal proprietária dessa coleção de listas de usuários. Formato: accountTypes/{account_type}/accounts/{account} |
page_size |
Opcional. O número máximo de listas de usuários a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 listas de usuários serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000. |
page_token |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
filter |
Opcional. Uma string de filtro. Todos os campos precisam estar à esquerda de cada condição (por exemplo, Operações compatíveis:
Campos compatíveis:
|
ListUserListsResponse
Mensagem de resposta para "ListUserLists".
| Campos | |
|---|---|
user_lists[] |
As listas de usuários da conta especificada. |
next_page_token |
Um token, que pode ser enviado como |
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 é 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 |
MobileData
IDs de dispositivos móveis do público-alvo. É necessário pelo menos um ID de dispositivo móvel.
| Campos | |
|---|---|
mobile_ids[] |
Obrigatório. A lista de IDs de dispositivos móveis (ID de publicidade/IDFA). No máximo, 10 |
MobileIdInfo
Informações adicionais quando MOBILE_ID é um dos upload_key_types.
| Campos | |
|---|---|
data_source_type |
Opcional. Imutável. Origem dos dados de upload. |
key_space |
Obrigatório. Imutável. O espaço de chaves dos IDs de dispositivos móveis. |
app_id |
Obrigatório. Imutável. Uma string que identifica de forma exclusiva um aplicativo para dispositivos móveis de onde os dados foram coletados. |
KeySpace
Espaço de chave para ID móvel.
| Tipos enumerados | |
|---|---|
KEY_SPACE_UNSPECIFIED |
Não especificado. |
IOS |
O espaço de chaves do iOS. |
ANDROID |
O keyspace do Android. |
PairData
IDs da PAIR para o público-alvo. É necessário ter pelo menos um ID de PAIR.
Esse recurso está disponível apenas para parceiros de dados.
| Campos | |
|---|---|
pair_ids[] |
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 |
PairIdInfo
Informações adicionais quando PAIR_ID é um dos upload_key_types.
Esse recurso está disponível apenas para parceiros de dados.
| Campos | |
|---|---|
match_rate_percentage |
Apenas saída. Esse campo indica a porcentagem de correspondência de associação dessa lista de usuários com os dados próprios do publisher correspondente. Precisa estar entre 0 e 100 (inclusive). |
advertiser_identifier_count |
Apenas saída. A contagem dos registros de dados próprios do anunciante que foram enviados para um provedor de data clean room. Isso não significa o tamanho de uma lista de usuários do PAIR. |
publisher_id |
Obrigatório. Imutável. Identifica o publisher com que a lista de usuários da reconciliação de dados de identificação entre publishers e anunciantes é reconciliada. Esse campo é fornecido pelo provedor da sala limpa e é exclusivo apenas no escopo dela. Ele não pode ser usado como um identificador global em várias cleanrooms. |
publisher_name |
Opcional. Nome descritivo do publisher a ser exibido na interface para uma melhor experiência de segmentação. |
clean_room_identifier |
Obrigatório. Imutável. Identifica uma relação exclusiva entre anunciante e editor com um ou vários provedores de data clean room. |
PartnerAudienceInfo
Informações adicionais para públicos-alvo de parceiros.
Esse recurso está disponível apenas para parceiros de dados.
| Campos | |
|---|---|
partner_audience_source |
Obrigatório. Imutável. A origem do público-alvo do parceiro. |
commerce_partner |
Opcional. O nome do parceiro comercial. Permitido apenas se |
PartnerAudienceSource
Origem de público-alvo do parceiro.
| Tipos enumerados | |
|---|---|
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED |
Não especificado. |
COMMERCE_AUDIENCE |
A origem de público-alvo do parceiro é um público-alvo de comércio. |
LINEAR_TV_AUDIENCE |
A origem de público-alvo do parceiro é o público-alvo de TV linear. |
AGENCY_PROVIDER_AUDIENCE |
A origem do público-alvo do parceiro é um público-alvo de agência/provedor. |
PartnerLink
Uma vinculação de parceiro entre uma conta proprietária e uma conta de parceiro.
| Campos | |
|---|---|
name |
Identificador. O nome do link de parceiro. Formato: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} |
partner_link_id |
Apenas saída. O ID do link do parceiro. |
owning_account |
Obrigatório. A conta proprietária que concede acesso à conta do parceiro. |
partner_account |
Obrigatório. A conta de parceiro que recebeu acesso da conta proprietária. |
PpidData
Dados de identificadores fornecidos pelo publisher que contêm os PPIDs. É necessário ter pelo menos um PPID.
Esse recurso está disponível apenas para parceiros de dados.
| Campos | |
|---|---|
ppids[] |
Obrigatório. A lista de identificadores fornecidos pelo editor para um usuário. |
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_DENIED_CONSENT |
Os dados do usuário de publicidade são negados pelo usuário ou nas configurações padrão do anunciante. |
PROCESSING_ERROR_REASON_NO_CONSENT |
O anunciante não deu consentimento de terceiros para os serviços principais da plataforma de anúncios. |
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT |
Não foi possível determinar o consentimento geral (determinado pelo consentimento no nível da linha, no nível da solicitação e nas configurações da conta) para este usuário. |
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
| 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 |
Obsoleto. Use |
account_id |
Obrigatório. O ID da conta. Por exemplo, o ID da sua conta do Google Ads. |
account_type |
Opcional. O tipo da conta. Por exemplo, |
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. |
GOOGLE_AD_MANAGER_AUDIENCE_LINK |
Vinculação de público-alvo do Google Ad Manager. |
PseudonymousIdInfo
Informações adicionais quando PSEUDONYMOUS_ID é um dos upload_key_types.
| Campos | |
|---|---|
sync_status |
Apenas saída. Status da sincronização da lista de usuários. |
billable_record_count |
Opcional. Imutável. O número de registros faturáveis (por exemplo, enviados ou correspondentes). |
SyncStatus
Status da sincronização da lista de usuários.
| Tipos enumerados | |
|---|---|
SYNC_STATUS_UNSPECIFIED |
Não especificado. |
CREATED |
A lista de usuários foi criada como um marcador de posição. O conteúdo e/ou os metadados da lista ainda estão sendo sincronizados. A lista de usuários não está pronta para uso. |
READY_FOR_USE |
A lista de usuários está pronta para uso. O conteúdo e os cookies foram sincronizados corretamente. |
FAILED |
Ocorreu um erro ao sincronizar o conteúdo e/ou os metadados da lista de usuários. Não é possível usar a lista de usuários. |
RemoveAudienceMembersRequest
Solicitação para remover usuários de um público-alvo nos destinos fornecidos. Retorna um RemoveAudienceMembersResponse.
| Campos | |
|---|---|
destinations[] |
Obrigatório. A lista de destinos de onde os usuários serão removidos. |
audience_members[] |
Obrigatório. A lista de usuários a serem removidos. |
validate_only |
Opcional. Para fins de teste. Se |
encoding |
Opcional. Obrigatório para uploads de |
encryption_info |
Opcional. Informações de criptografia para uploads do |
RemoveAudienceMembersResponse
Resposta do RemoveAudienceMembersRequest.
| Campos | |
|---|---|
request_id |
O ID gerado automaticamente da solicitação. |
RequestStatusPerDestination
Um status de solicitação por destino.
| Campos | |
|---|---|
destination |
Um destino em uma solicitação da API DM. |
request_status |
O status da solicitação do destino. |
error_info |
Um erro de informações que contém o motivo e as contagens de erros relacionados ao upload. |
warning_info |
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 |
O status da solicitação de inclusão de membros do público-alvo. |
events_ingestion_status |
O status da solicitação de eventos de ingestão. |
audience_members_removal_status |
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 |
O status da ingestão de dados do usuário no destino. |
mobile_data_ingestion_status |
O status da ingestão de dados móveis no destino. |
pair_data_ingestion_status |
O status da ingestão de dados do par no destino. |
user_id_data_ingestion_status |
O status da ingestão de dados de ID do usuário no destino. |
ppid_data_ingestion_status |
O status da ingestão de dados de PPID no destino. |
IngestEventsStatus
O status da ingestão de eventos no destino.
| Campos | |
|---|---|
record_count |
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 |
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, independente de terem sido ingeridos ou não. |
mobile_id_count |
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 |
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, independente de terem sido ingeridos ou não. |
pair_id_count |
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. |
IngestPpidDataStatus
O status da ingestão de dados de PPID no destino com estatísticas relacionadas a ela.
| Campos | |
|---|---|
record_count |
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, independente de terem sido ingeridos ou não. |
ppid_count |
A contagem total de PPIDs enviados na solicitação de upload para o destino. Inclui todos os PPIDs na solicitação, independentemente 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 |
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, independente de terem sido ingeridos ou não. |
user_identifier_count |
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 |
O intervalo da taxa de correspondência do upload. |
IngestUserIdDataStatus
O status da ingestão de dados de ID do usuário no destino com estatísticas relacionadas a ela.
| Campos | |
|---|---|
record_count |
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, independente de terem sido ingeridos ou não. |
user_id_count |
A contagem total de IDs de usuário enviados na solicitação de upload para o destino. Inclui todos os IDs de usuário na solicitação, independentemente de terem sido ingeridos ou não. |
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 |
O status da remoção dos dados do usuário do destino. |
mobile_data_removal_status |
O status da remoção de dados móveis do destino. |
pair_data_removal_status |
O status da remoção dos dados do par do destino. |
user_id_data_removal_status |
O status da remoção de dados de ID do usuário do destino. |
ppid_data_removal_status |
O status da remoção dos dados de PPID do destino. |
RemoveMobileDataStatus
O status da remoção de dados móveis do destino.
| Campos | |
|---|---|
record_count |
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 |
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 |
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 |
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. |
RemovePpidDataStatus
O status da remoção dos dados de PPID do destino.
| Campos | |
|---|---|
record_count |
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. |
ppid_count |
A contagem total de PPIDs enviados na solicitação de remoção. Inclui todos os PPIDs na solicitação, independentemente de terem sido removidos ou não. |
RemoveUserDataStatus
O status da remoção dos dados do usuário do destino.
| Campos | |
|---|---|
record_count |
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 |
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, independente de terem sido removidos ou não. |
RemoveUserIdDataStatus
O status da remoção de dados de ID do usuário do destino.
| Campos | |
|---|---|
record_count |
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_id_count |
A contagem total de IDs de usuário enviados na solicitação de remoção. Inclui todos os IDs de usuário na solicitação, independente 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. |
RetrieveInsightsRequest
Mensagem de solicitação para DM API MarketingDataInsightsService.RetrieveInsights
| Campos | |
|---|---|
parent |
Obrigatório. A conta principal proprietária da lista de usuários. Formato: |
baseline |
Obrigatório. Valor de referência para os insights solicitados. |
user_list_id |
Obrigatório. O ID da lista de usuários para que os insights são solicitados. |
RetrieveInsightsResponse
Mensagem de resposta para DM API MarketingDataInsightsService.RetrieveInsights
| Campos | |
|---|---|
marketing_data_insights[] |
Contém os insights dos dados de marketing. |
MarketingDataInsight
Insights para dados de marketing.
Esse recurso está disponível apenas para parceiros de dados.
| Campos | |
|---|---|
dimension |
A dimensão a que o insight pertence. |
attributes[] |
Insights para valores de uma determinada dimensão. |
AudienceInsightsDimension
Dimensões possíveis para uso na geração de insights.
| Tipos enumerados | |
|---|---|
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED |
Não especificado. |
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN |
O valor é desconhecido nesta versão. |
AFFINITY_USER_INTEREST |
Um UserInterest de afinidade. |
IN_MARKET_USER_INTEREST |
Um UserInterest no mercado. |
AGE_RANGE |
Uma faixa etária. |
GENDER |
Um gênero. |
MarketingDataInsightsAttribute
Insights para um conjunto de atributos relacionados da mesma dimensão.
| Campos | |
|---|---|
user_interest_id |
O ID do interesse do usuário. |
lift |
Medida do Lift que o público-alvo tem para o valor do atributo em comparação com o valor de referência. Intervalo [0-1]. |
age_range |
Faixa etária do público-alvo para o qual o Lift é fornecido. |
gender |
Gênero do público-alvo para o qual o Lift é fornecido. |
RetrieveRequestStatusRequest
Solicitação para receber o status da solicitação feita à API DM para um determinado ID de solicitação. Retorna um RetrieveRequestStatusResponse.
| Campos | |
|---|---|
request_id |
Obrigatório. Obrigatório. O ID da solicitação da API Data Manager. |
RetrieveRequestStatusResponse
Resposta do RetrieveRequestStatusRequest.
| Campos | |
|---|---|
request_status_per_destination[] |
Uma lista de status de solicitação por destino. A ordem dos status corresponde à ordem dos destinos na solicitação original. |
SearchPartnerLinksRequest
Solicitação para pesquisar recursos PartnerLink. Retorna um SearchPartnerLinksResponse.
| Campos | |
|---|---|
parent |
Obrigatório. Conta para pesquisar links de parceiros. Se nenhum Formato: |
page_size |
O número máximo de links de parceiros a serem retornados. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 10 links de parceiros serão retornados. O valor máximo é 100. Valores acima disso vão ser convertidos para 100. |
page_token |
Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
filter |
Opcional. Uma string de filtro. Todos os campos precisam estar à esquerda de cada condição (por exemplo, Operações compatíveis:
Campos compatíveis:
Exemplo: |
SearchPartnerLinksResponse
Resposta do SearchPartnerLinksRequest.
| Campos | |
|---|---|
partner_links[] |
Os links de parceiro da conta especificada. |
next_page_token |
Um token, que pode ser enviado como |
SizeInfo
Número estimado de membros nessa lista de usuários em diferentes redes de destino.
| Campos | |
|---|---|
display_network_members_count |
Apenas saída. Número estimado de membros nessa lista de usuários na Rede de Display do Google. |
search_network_members_count |
Apenas saída. Número estimado de membros nesta lista de usuários no domínio google.com. Estes são os membros disponíveis para segmentação em campanhas de pesquisa. |
TargetNetworkInfo
Informações de qualificação para diferentes redes de destino.
| Campos | |
|---|---|
eligible_for_display |
Apenas saída. Indica que esta lista de usuários está qualificada para a Rede de Display do Google. |
eligible_for_search |
Opcional. Indica se a lista de usuários está qualificada para a rede de pesquisa do Google. |
TermsOfService
Os Termos de Serviço que o usuário aceitou/rejeitou.
| Campos | |
|---|---|
customer_match_terms_of_service_status |
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 |
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. |
UpdateUserListDirectLicenseRequest
Solicitação para atualizar um recurso UserListDirectLicense.
| Campos | |
|---|---|
user_list_direct_license |
Obrigatório. O campo |
update_mask |
Opcional. Lista de campos a serem atualizados. O caractere especial |
UpdateUserListGlobalLicenseRequest
Solicitação para atualizar um recurso UserListGlobalLicense.
| Campos | |
|---|---|
user_list_global_license |
Obrigatório. O campo |
update_mask |
Opcional. Lista de campos a serem atualizados. O caractere especial |
UpdateUserListRequest
Mensagem de solicitação para UpdateUserList.
| Campos | |
|---|---|
user_list |
Obrigatório. A lista de usuários a ser atualizada. O campo |
update_mask |
Opcional. Lista de campos a serem atualizados. |
validate_only |
Opcional. Se for verdadeiro, a solicitação será validada, mas não executada. |
UserData
Dados que identificam o usuário. É necessário pelo menos um identificador.
| Campos | |
|---|---|
user_identifiers[] |
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 maior número possível de identificadores. No máximo, 10 |
UserIdData
Dados de ID do usuário que contêm o ID do usuário.
| Campos | |
|---|---|
user_id |
Obrigatório. Um identificador exclusivo de um usuário, conforme definido pelo anunciante. |
UserIdInfo
Informações adicionais quando USER_ID é um dos upload_key_types.
| Campos | |
|---|---|
data_source_type |
Opcional. Imutável. Origem dos dados de upload. |
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 |
Endereço de e-mail criptografado com hash usando a função de hash SHA-256 após a normalização. |
phone_number |
Número de telefone criptografado com hash usando a função hash SHA-256 após a normalização (padrão E164). |
address |
Os componentes conhecidos do endereço de um usuário. Contém um agrupamento de identificadores que são correspondidos de uma só vez. |
UserList
Um recurso de lista de usuários.
| Campos | |
|---|---|
name |
Identificador. O nome do recurso da lista de usuários. Formato: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} |
id |
Apenas saída. O ID exclusivo da lista de usuários. |
read_only |
Apenas saída. Uma opção que indica se um usuário pode editar uma lista. |
membership_duration |
Opcional. O período em que um usuário permanece na lista de usuários. As durações válidas são múltiplos exatos de 24 horas (86.400 segundos). Fornecer um valor que não seja um múltiplo exato de 24 horas vai resultar em um erro INVALID_ARGUMENT. |
access_reason |
Apenas saída. O motivo pelo qual essa conta recebeu acesso à lista. |
size_info |
Apenas saída. Número estimado de membros nessa lista de usuários em diferentes redes de destino. |
target_network_info |
Opcional. Informações de qualificação para diferentes redes de destino. |
display_name |
Obrigatório. O nome de exibição da lista de usuários. |
description |
Opcional. Uma descrição da lista de usuários. |
membership_status |
Opcional. Status de associação desta lista de usuários. |
integration_code |
Opcional. Um ID de um sistema externo. Usado por vendedores de listas de usuários para correlacionar IDs nos sistemas deles. |
closing_reason |
Apenas saída. O motivo de o status de associação à lista de usuários estar fechado. |
account_access_status |
Opcional. Indica se o compartilhamento ainda está ativado. Quando uma lista de usuários é compartilhada com a conta, esse campo é definido como |
Campo de união user_list_info. Informações adicionais sobre a lista de usuários. user_list_info pode ser apenas de um dos tipos a seguir: |
|
ingested_user_list_info |
Opcional. Representa uma lista de usuários preenchida com dados ingeridos pelo usuário. |
AccessReason
Enumeração que descreve possíveis motivos de acesso.
| Tipos enumerados | |
|---|---|
ACCESS_REASON_UNSPECIFIED |
Não especificado. |
OWNED |
O recurso pertence ao usuário. |
SHARED |
O recurso é compartilhado com o usuário. |
LICENSED |
O recurso está licenciado para o usuário. |
SUBSCRIBED |
O usuário se inscreveu no recurso. |
AFFILIATED |
O recurso está acessível ao usuário. |
AccessStatus
Indica se o cliente ainda tem acesso à lista.
| Tipos enumerados | |
|---|---|
ACCESS_STATUS_UNSPECIFIED |
Não especificado. |
ENABLED |
O acesso está ativado. |
DISABLED |
O acesso está desativado. |
ClosingReason
Indica o motivo do encerramento da lista de usuários. Essa enumeração só é usada quando uma lista é fechada automaticamente pelo sistema.
| Tipos enumerados | |
|---|---|
CLOSING_REASON_UNSPECIFIED |
Não especificado. |
UNUSED |
A lista de usuários foi encerrada porque não foi usada na segmentação recentemente. Consulte https://support.google.com/google-ads/answer/2472738 para mais detalhes. |
MembershipStatus
Status da lista de usuários.
| Tipos enumerados | |
|---|---|
MEMBERSHIP_STATUS_UNSPECIFIED |
Não especificado. |
OPEN |
Status aberto: a lista de usuários está acumulando membros e pode ser segmentada. |
CLOSED |
Status "Fechado": nenhum novo membro está sendo adicionado. |
UserListDirectLicense
Uma licença direta de lista de usuários.
Esse recurso está disponível apenas para parceiros de dados.
| Campos | |
|---|---|
name |
Identificador. O nome do recurso da licença direta da lista de usuários. |
user_list_display_name |
Apenas saída. Nome da lista de usuários que está recebendo a licença. Este campo é somente leitura. |
client_account_display_name |
Apenas saída. Nome do cliente do cliente para quem a lista de usuários está sendo licenciada. Este campo é somente leitura. |
pricing |
Opcional. Preços da UserListDirectLicense. |
historical_pricings[] |
Apenas saída. Histórico de preços da licença da lista de usuários. Este campo é somente leitura. |
metrics |
Apenas saída. Métricas relacionadas a esta licença Esse campo é somente leitura e só é preenchido se as datas de início e término forem definidas na chamada "ListUserListDirectLicenses". |
user_list_id |
Imutável. ID da lista de usuários que está sendo licenciada. |
client_account_type |
Imutável. Tipo de conta do cliente para quem a lista de usuários está sendo licenciada. |
client_account_id |
Imutável. ID do cliente que está recebendo a licença da lista de usuários. |
status |
Opcional. Status de UserListDirectLicense: ENABLED ou DISABLED. |
UserListGlobalLicense
Uma licença global de lista de usuários.
Esse recurso está disponível apenas para parceiros de dados.
| Campos | |
|---|---|
name |
Identificador. O nome do recurso da licença global da lista de usuários. |
user_list_display_name |
Apenas saída. Nome da lista de usuários que está recebendo a licença. Este campo é somente leitura. |
pricing |
Opcional. Preços da UserListGlobalLicense. |
historical_pricings[] |
Apenas saída. Histórico de preços da licença da lista de usuários. Este campo é somente leitura. |
metrics |
Apenas saída. Métricas relacionadas a esta licença Esse campo é somente leitura e só é preenchido se as datas de início e término forem definidas na chamada "ListUserListGlobalLicenses". |
user_list_id |
Imutável. ID da lista de usuários que está sendo licenciada. |
license_type |
Imutável. Tipo de produto do cliente para o qual a lista de usuários está sendo licenciada. |
status |
Opcional. Status de UserListGlobalLicense: ENABLED ou DISABLED. |
UserListGlobalLicenseCustomerInfo
Informações sobre um cliente de uma licença global de lista de usuários. Ele será criado automaticamente pelo sistema quando um cliente comprar uma licença global.
| Campos | |
|---|---|
name |
Identificador. O nome do recurso do cliente de licença global da lista de usuários. |
user_list_id |
Apenas saída. ID da lista de usuários que está sendo licenciada. |
user_list_display_name |
Apenas saída. Nome da lista de usuários que está recebendo a licença. |
license_type |
Apenas saída. Tipo de produto do cliente para o qual a lista de usuários está sendo licenciada. |
status |
Apenas saída. Status de UserListDirectLicense: ENABLED ou DISABLED. |
pricing |
Apenas saída. Preços da UserListDirectLicense. |
client_account_type |
Apenas saída. Tipo de produto do cliente para o qual a lista de usuários está sendo licenciada. |
client_account_id |
Apenas saída. ID do cliente que está recebendo a licença da lista de usuários. |
client_account_display_name |
Apenas saída. Nome do cliente do cliente para quem a lista de usuários está sendo licenciada. |
historical_pricings[] |
Apenas saída. Histórico de preços da licença da lista de usuários. |
metrics |
Apenas saída. Métricas relacionadas a esta licença Esse campo só será preenchido se as datas de início e término forem definidas na chamada "ListUserListGlobalLicenseCustomerInfos". |
UserListGlobalLicenseType
Tipos de licença global da lista de usuários.
| Tipos enumerados | |
|---|---|
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED |
UNSPECIFIED. |
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER |
Licença de revendedor. |
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE |
Licença do lado do vendedor do DataMart. |
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE |
Licença do lado comprador do DataMart. |
UserListLicenseClientAccountType
Possível produto de uma conta de cliente para uma licença de lista de usuários.
| Tipos enumerados | |
|---|---|
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN |
Desconhecido. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS |
Cliente do Google Ads. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER |
Parceiro do Display & Video 360. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER |
Anunciante do Display & Video 360. |
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK |
Vinculação de público-alvo do Google Ad Manager. |
UserListLicenseMetrics
Métricas relacionadas a uma licença de lista de usuários.
| Campos | |
|---|---|
click_count |
Apenas saída. O número de cliques para a licença da lista de usuários. |
impression_count |
Apenas saída. O número de impressões da licença da lista de usuários. |
revenue_usd_micros |
Apenas saída. A receita da licença da lista de usuários em micros (USD). |
start_date |
Apenas saída. A data de início (inclusiva) das métricas no formato AAAAMMDD. Por exemplo, 20260102 representa 2 de janeiro de 2026. Se |
end_date |
Apenas saída. A data de término (inclusiva) das métricas no formato AAAAMMDD. Por exemplo, 20260102 representa 2 de janeiro de 2026. Se |
UserListLicensePricing
Um preço de licença de lista de usuários.
| Campos | |
|---|---|
pricing_id |
Apenas saída. O ID desse preço. |
start_time |
Apenas saída. Horário de início do preço. |
end_time |
Opcional. Horário de término do preço. |
pricing_active |
Apenas saída. Indica se o preço está ativo. |
buyer_approval_state |
Apenas saída. O estado de aprovação do comprador para esse preço. Este campo é somente leitura. |
cost_micros |
Opcional. O custo associado ao modelo, em microunidades (10^-6), na moeda especificada pelo campo "currency_code". Por exemplo, 2000000 significa US $2 se |
currency_code |
Opcional. A moeda em que "cost" e "max_cost" são especificados. Precisa ser um código de moeda de três letras definido no ISO 4217. |
cost_type |
Imutável. O tipo de custo desse preço. Só pode ser definido na operação |
max_cost_micros |
Opcional. O CPM máximo que um público-alvo de comércio pode receber quando o tipo de custo MEDIA_SHARE é usado. O valor está em microunidades (10^-6) e na moeda especificada pelo campo "currency_code". Por exemplo, 2000000 significa US $2 se Isso só é relevante quando cost_type é MEDIA_SHARE. Quando "cost_type" não é MEDIA_SHARE e esse campo está definido, um erro MAX_COST_NOT_ALLOWED é retornado. Se não for definido ou for definido como |
UserListPricingBuyerApprovalState
Estado de aprovação do comprador para o preço da lista de usuários.
| Tipos enumerados | |
|---|---|
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED |
UNSPECIFIED. |
PENDING |
O cliente da lista de usuários ainda não aceitou os termos de preços definidos pelo proprietário da lista. |
APPROVED |
O cliente da lista de usuários aceitou os termos de preços definidos pelo proprietário da lista. |
REJECTED |
O cliente da lista de usuários rejeitou os termos de preços definidos pelo proprietário da lista de usuários. |
UserListPricingCostType
Tipo de custo de preço da lista de usuários.
| Tipos enumerados | |
|---|---|
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED |
Não especificado. |
CPC |
Custo por clique. |
CPM |
Custo por mil impressões. |
MEDIA_SHARE |
Cota de mídia. |
UserListLicenseStatus
Status da licença da lista de usuários.
| Tipos enumerados | |
|---|---|
USER_LIST_LICENSE_STATUS_UNSPECIFIED |
Desconhecido. |
USER_LIST_LICENSE_STATUS_ENABLED |
Status ativo: a lista de usuários ainda está sendo licenciada. |
USER_LIST_LICENSE_STATUS_DISABLED |
Status inativo: a lista de usuários não está mais licenciada. |
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 |
Opcional. Tipo do cliente associado ao evento. |
customer_value_bucket |
Opcional. O valor do cliente avaliado pelo anunciante. |
additional_user_properties[] |
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 |
Obrigatório. O nome da propriedade do usuário a ser usada. |
value |
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 |
A contagem de registros que têm um aviso. |
reason |
O motivo do aviso. |
WarningInfo
Contagens de avisos para cada tipo.
| Campos | |
|---|---|
warning_counts[] |
Uma lista de alertas e contagens por motivo de alerta. |