Package google.analytics.admin.v1alpha

Índice

AnalyticsAdminService

Interface de serviço para a API Admin do Google Analytics.

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

Confirma os termos de coleta de dados do usuário para a propriedade especificada.

Essa confirmação precisa ser concluída (na interface do Google Analytics ou por meio desta API) antes que os recursos MeasurementProtocolSecret possam ser criados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
ApproveDisplayVideo360AdvertiserLinkProposal

rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse)

Aprova uma DisplayVideo360AdvertiserLinkProposal. A DisplayVideo360AdvertiserLinkProposal será excluída, e uma nova DisplayVideo360AdvertiserLink será criada.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveAudience

rpc ArchiveAudience(ArchiveAudienceRequest) returns (Empty)

Arquiva um público-alvo em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomDimension

rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (Empty)

Arquiva uma CustomDimension em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomMetric

rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (Empty)

Arquiva uma CustomMetric em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
BatchCreateAccessBindings

rpc BatchCreateAccessBindings(BatchCreateAccessBindingsRequest) returns (BatchCreateAccessBindingsResponse)

Cria informações sobre várias vinculações de acesso a uma conta ou propriedade.

Esse método é transacional. Se não for possível criar uma AccessBinding, nenhuma delas será criada.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users
BatchDeleteAccessBindings

rpc BatchDeleteAccessBindings(BatchDeleteAccessBindingsRequest) returns (Empty)

Exclui informações sobre os links de vários usuários para uma conta ou propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users
BatchGetAccessBindings

rpc BatchGetAccessBindings(BatchGetAccessBindingsRequest) returns (BatchGetAccessBindingsResponse)

Recebe informações sobre várias vinculações de acesso a uma conta ou propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
BatchUpdateAccessBindings

rpc BatchUpdateAccessBindings(BatchUpdateAccessBindingsRequest) returns (BatchUpdateAccessBindingsResponse)

Atualiza informações sobre várias vinculações de acesso a uma conta ou propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users
CancelDisplayVideo360AdvertiserLinkProposal

rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Cancela uma DisplayVideo360AdvertiserLinkProposal. O cancelamento pode significar: - Recusar uma proposta iniciada no Display & Video 360 - Retirar uma proposta iniciada no Google Analytics Depois de cancelada, uma proposta será excluída automaticamente.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateAccessBinding

rpc CreateAccessBinding(CreateAccessBindingRequest) returns (AccessBinding)

Cria uma vinculação de acesso em uma conta ou propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users
CreateAudience

rpc CreateAudience(CreateAudienceRequest) returns (Audience)

Cria um público-alvo.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateCalculatedMetric

rpc CreateCalculatedMetric(CreateCalculatedMetricRequest) returns (CalculatedMetric)

Cria uma CalculatedMetric.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateChannelGroup

rpc CreateChannelGroup(CreateChannelGroupRequest) returns (ChannelGroup)

Cria um ChannelGroup.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateConversionEvent

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

Descontinuado: use CreateKeyEvent. Cria um evento de conversão com os atributos especificados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomDimension

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

Cria uma CustomDimension.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomMetric

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

Cria uma CustomMetric.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateDataStream

rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream)

Cria um DataStream.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateDisplayVideo360AdvertiserLinkProposal

rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Cria uma DisplayVideo360AdvertiserLinkProposal.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateEventCreateRule

rpc CreateEventCreateRule(CreateEventCreateRuleRequest) returns (EventCreateRule)

Cria um EventCreateRule.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateEventEditRule

rpc CreateEventEditRule(CreateEventEditRuleRequest) returns (EventEditRule)

Cria um EventEditRule.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateExpandedDataSet

rpc CreateExpandedDataSet(CreateExpandedDataSetRequest) returns (ExpandedDataSet)

Cria um ExpandedDataSet.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateKeyEvent

rpc CreateKeyEvent(CreateKeyEventRequest) returns (KeyEvent)

Cria um evento principal.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateMeasurementProtocolSecret

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Cria uma chave secreta do Measurement Protocol.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateProperty

rpc CreateProperty(CreatePropertyRequest) returns (Property)

Cria uma propriedade do Google Analytics com o local e os atributos especificados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateReportingDataAnnotation

rpc CreateReportingDataAnnotation(CreateReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

Cria uma anotação de dados de relatórios.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateRollupProperty

rpc CreateRollupProperty(CreateRollupPropertyRequest) returns (CreateRollupPropertyResponse)

Crie uma propriedade de visualização completa e todos os links de origem dela.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateSKAdNetworkConversionValueSchema

rpc CreateSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

Cria um SKAdNetworkConversionValueSchema.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
CreateSubpropertyEventFilter

rpc CreateSubpropertyEventFilter(CreateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

Cria um filtro de eventos da subpropriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteAccessBinding

rpc DeleteAccessBinding(DeleteAccessBindingRequest) returns (Empty)

Exclui uma vinculação de acesso em uma conta ou propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users
DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

Marca a conta de destino como excluída de forma reversível (ou seja, "enviada para a lixeira") e a retorna.

Essa API não tem um método para restaurar contas excluídas de forma reversível. No entanto, é possível restaurá-los usando a interface da lixeira.

Se as contas não forem restauradas antes do prazo de expiração, a conta e todos os recursos secundários (por exemplo, propriedades, GoogleAdsLinks, fluxos, AccessBindings) serão excluídos permanentemente. https://support.google.com/analytics/answer/6154772

Retorna um erro se o destino não for encontrado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteCalculatedMetric

rpc DeleteCalculatedMetric(DeleteCalculatedMetricRequest) returns (Empty)

Exclui uma CalculatedMetric em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteChannelGroup

rpc DeleteChannelGroup(DeleteChannelGroupRequest) returns (Empty)

Exclui um ChannelGroup em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteConversionEvent

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

Descontinuado: use DeleteKeyEvent. Exclui um evento de conversão em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteDataStream

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

Exclui um DataStream em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteDisplayVideo360AdvertiserLinkProposal

rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (Empty)

Exclui uma DisplayVideo360AdvertiserLinkProposal em uma propriedade. Isso só pode ser usado em propostas canceladas.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteEventCreateRule

rpc DeleteEventCreateRule(DeleteEventCreateRuleRequest) returns (Empty)

Exclui uma EventCreateRule.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteEventEditRule

rpc DeleteEventEditRule(DeleteEventEditRuleRequest) returns (Empty)

Exclui uma EventEditRule.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteExpandedDataSet

rpc DeleteExpandedDataSet(DeleteExpandedDataSetRequest) returns (Empty)

Exclui um ExpandedDataSet de uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteKeyEvent

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

Exclui um evento principal.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteMeasurementProtocolSecret

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

Exclui o MeasurementProtocolSecret de destino.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteProperty

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

Marca a propriedade de destino como excluída de maneira reversível (ou seja, "movida para a lixeira") e a retorna.

Essa API não tem um método para restaurar propriedades excluídas de maneira reversível. No entanto, é possível restaurá-los usando a interface da lixeira.

Se as propriedades não forem restauradas antes do prazo de expiração, a propriedade e todos os recursos filhos (por exemplo, GoogleAdsLinks, Streams, AccessBindings) serão excluídos permanentemente. https://support.google.com/analytics/answer/6154772

Retorna um erro se o destino não for encontrado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteReportingDataAnnotation

rpc DeleteReportingDataAnnotation(DeleteReportingDataAnnotationRequest) returns (Empty)

Exclui uma anotação de dados de relatórios.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteSKAdNetworkConversionValueSchema

rpc DeleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest) returns (Empty)

Exclui o SKAdNetworkConversionValueSchema de destino.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
DeleteSubpropertyEventFilter

rpc DeleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest) returns (Empty)

Exclui um filtro de eventos da subpropriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
GetAccessBinding

rpc GetAccessBinding(GetAccessBindingRequest) returns (AccessBinding)

Recebe informações sobre uma vinculação de acesso.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Pesquisa de uma única conta.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetAttributionSettings

rpc GetAttributionSettings(GetAttributionSettingsRequest) returns (AttributionSettings)

Pesquisa por um singleton AttributionSettings.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetAudience

rpc GetAudience(GetAudienceRequest) returns (Audience)

Pesquisa por um único público-alvo. Os públicos-alvo criados antes de 2020 podem não ser compatíveis. Os públicos-alvo padrão não mostram definições de filtro.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCalculatedMetric

rpc GetCalculatedMetric(GetCalculatedMetricRequest) returns (CalculatedMetric)

Pesquisa por uma única CalculatedMetric.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetChannelGroup

rpc GetChannelGroup(GetChannelGroupRequest) returns (ChannelGroup)

Pesquisa um único ChannelGroup.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetConversionEvent

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

Descontinuado: use GetKeyEvent. Recupera um único evento de conversão.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomDimension

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

Pesquisa por uma única CustomDimension.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomMetric

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

Pesquisa por uma única CustomMetric.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataRedactionSettings

rpc GetDataRedactionSettings(GetDataRedactionSettingsRequest) returns (DataRedactionSettings)

Pesquisa uma única DataRedactionSettings.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataRetentionSettings

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

Retorna as configurações de retenção de dados singleton para esta propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataSharingSettings

rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings)

Recebe as configurações de compartilhamento de dados de uma conta. As configurações de compartilhamento de dados são singletons.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataStream

rpc GetDataStream(GetDataStreamRequest) returns (DataStream)

Pesquisa por um único DataStream.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDisplayVideo360AdvertiserLinkProposal

rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

Pesquisa de uma única DisplayVideo360AdvertiserLinkProposal.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEnhancedMeasurementSettings

rpc GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

Retorna as configurações de medição otimizada para esse fluxo de dados. O fluxo precisa ativar a medição otimizada para que essas configurações entrem em vigor.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEventCreateRule

rpc GetEventCreateRule(GetEventCreateRuleRequest) returns (EventCreateRule)

Pesquisa por uma única EventCreateRule.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEventEditRule

rpc GetEventEditRule(GetEventEditRuleRequest) returns (EventEditRule)

Pesquisa por uma única EventEditRule.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetExpandedDataSet

rpc GetExpandedDataSet(GetExpandedDataSetRequest) returns (ExpandedDataSet)

Pesquisa por um único ExpandedDataSet.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetGlobalSiteTag

rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag)

Retorna a tag do site para o fluxo da Web especificado. As tags do site são singletons imutáveis.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetGoogleSignalsSettings

rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

Pesquisa as configurações dos Indicadores do Google para uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetKeyEvent

rpc GetKeyEvent(GetKeyEventRequest) returns (KeyEvent)

Recupera um único evento principal.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetMeasurementProtocolSecret

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Pesquisa por um único MeasurementProtocolSecret.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetProperty

rpc GetProperty(GetPropertyRequest) returns (Property)

Pesquisa por uma única propriedade do GA.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetReportingDataAnnotation

rpc GetReportingDataAnnotation(GetReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

Pesquisa uma única anotação de dados de relatórios.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetReportingIdentitySettings

rpc GetReportingIdentitySettings(GetReportingIdentitySettingsRequest) returns (ReportingIdentitySettings)

Retorna as configurações de identidade de relatórios para essa propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSKAdNetworkConversionValueSchema

rpc GetSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

Procura um único SKAdNetworkConversionValueSchema.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSubpropertyEventFilter

rpc GetSubpropertyEventFilter(GetSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

Pesquisa de um único filtro de eventos da subpropriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSubpropertySyncConfig

rpc GetSubpropertySyncConfig(GetSubpropertySyncConfigRequest) returns (SubpropertySyncConfig)

Pesquisa por um único SubpropertySyncConfig.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccessBindings

rpc ListAccessBindings(ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

Lista todas as vinculações de acesso em uma conta ou propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
ListAccountSummaries

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

Retorna resumos de todas as contas acessíveis ao autor da chamada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Retorna todas as contas acessíveis ao autor da chamada.

Essas contas podem não ter propriedades do GA no momento. As contas excluídas de forma reversível (ou seja, "enviadas para a lixeira") são excluídas por padrão. Retorna uma lista vazia se nenhuma conta relevante for encontrada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAudiences

rpc ListAudiences(ListAudiencesRequest) returns (ListAudiencesResponse)

Lista os públicos-alvo em uma propriedade. Os públicos-alvo criados antes de 2020 podem não ser compatíveis. Os públicos-alvo padrão não mostram definições de filtro.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCalculatedMetrics

rpc ListCalculatedMetrics(ListCalculatedMetricsRequest) returns (ListCalculatedMetricsResponse)

Lista CalculatedMetrics em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListChannelGroups

rpc ListChannelGroups(ListChannelGroupsRequest) returns (ListChannelGroupsResponse)

Lista os ChannelGroups em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListConversionEvents

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

Descontinuado: use ListKeyEvents. Retorna uma lista de eventos de conversão na propriedade mãe especificada.

Retorna uma lista vazia se nenhum evento de conversão for encontrado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomDimensions

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

Lista CustomDimensions em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomMetrics

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

Lista CustomMetrics em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListDataStreams

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

Lista DataStreams em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListDisplayVideo360AdvertiserLinkProposals

rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse)

Lista as propostas de vinculação de anunciante do DisplayVideo360 em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListEventCreateRules

rpc ListEventCreateRules(ListEventCreateRulesRequest) returns (ListEventCreateRulesResponse)

Lista EventCreateRules em um fluxo de dados da Web.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListEventEditRules

rpc ListEventEditRules(ListEventEditRulesRequest) returns (ListEventEditRulesResponse)

Lista EventEditRules em um fluxo de dados da Web.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListExpandedDataSets

rpc ListExpandedDataSets(ListExpandedDataSetsRequest) returns (ListExpandedDataSetsResponse)

Lista ExpandedDataSets em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListKeyEvents

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

Retorna uma lista de eventos principais na propriedade mãe especificada. Retorna uma lista vazia se nenhum evento principal for encontrado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListMeasurementProtocolSecrets

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

Retorna MeasurementProtocolSecrets filhos na propriedade pai especificada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListProperties

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

Retorna as propriedades filhas na conta principal especificada.

As propriedades serão excluídas se o autor da chamada não tiver acesso. As propriedades excluídas de maneira reversível (ou seja, "enviadas para a lixeira") são excluídas por padrão. Retorna uma lista vazia se nenhuma propriedade relevante for encontrada.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListReportingDataAnnotations

rpc ListReportingDataAnnotations(ListReportingDataAnnotationsRequest) returns (ListReportingDataAnnotationsResponse)

Liste todas as anotações de dados de relatórios em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSKAdNetworkConversionValueSchemas

rpc ListSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest) returns (ListSKAdNetworkConversionValueSchemasResponse)

Lista SKAdNetworkConversionValueSchema em um fluxo. As propriedades podem ter no máximo um SKAdNetworkConversionValueSchema.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSubpropertyEventFilters

rpc ListSubpropertyEventFilters(ListSubpropertyEventFiltersRequest) returns (ListSubpropertyEventFiltersResponse)

Lista todos os filtros de eventos da subpropriedade em uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSubpropertySyncConfigs

rpc ListSubpropertySyncConfigs(ListSubpropertySyncConfigsRequest) returns (ListSubpropertySyncConfigsResponse)

Lista todos os recursos SubpropertySyncConfig de uma propriedade.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ProvisionAccountTicket

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

Solicita um tíquete para criar uma conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
ProvisionSubproperty

rpc ProvisionSubproperty(ProvisionSubpropertyRequest) returns (ProvisionSubpropertyResponse)

Crie uma subpropriedade e um filtro de eventos que se aplique a ela.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
ReorderEventEditRules

rpc ReorderEventEditRules(ReorderEventEditRulesRequest) returns (Empty)

Muda a ordem de processamento das regras de edição de eventos no fluxo especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
RunAccessReport

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

Retorna um relatório personalizado de registros de acesso a dados. O relatório fornece registros de cada vez que um usuário lê dados de relatórios do Google Analytics. Os registros de acesso são mantidos por até dois anos.

Os relatórios de acesso aos dados podem ser solicitados para uma propriedade. Os relatórios podem ser solicitados para qualquer propriedade, mas as dimensões que não estão relacionadas à cota só podem ser solicitadas em propriedades do Google Analytics 360. Esse método está disponível apenas para administradores.

Esses registros incluem relatórios da interface do GA, análises detalhadas da interface do GA, API de dados do GA e outros produtos, como Firebase e AdMob, que podem recuperar dados do Google Analytics por uma vinculação. Esses registros não incluem mudanças na configuração da propriedade, como adicionar um fluxo ou mudar o fuso horário dela. Para ver o histórico de mudanças de configuração, consulte searchChangeHistoryEvents.

Para enviar seu feedback sobre essa API, preencha o formulário Feedback sobre relatórios de acesso do Google Analytics.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
SearchChangeHistoryEvents

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

Pesquisa todas as mudanças em uma conta ou nos filhos dela com base no conjunto de filtros especificado.

Retorna apenas o subconjunto de mudanças compatíveis com a API. A interface pode retornar outras mudanças.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
SubmitUserDeletion

rpc SubmitUserDeletion(SubmitUserDeletionRequest) returns (SubmitUserDeletionResponse)

Envia uma solicitação de exclusão de usuário para uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAccessBinding

rpc UpdateAccessBinding(UpdateAccessBindingRequest) returns (AccessBinding)

Atualiza uma vinculação de acesso em uma conta ou propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.manage.users
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Atualiza uma conta.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAttributionSettings

rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest) returns (AttributionSettings)

Atualiza as configurações de atribuição em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateAudience

rpc UpdateAudience(UpdateAudienceRequest) returns (Audience)

Atualiza um público-alvo em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCalculatedMetric

rpc UpdateCalculatedMetric(UpdateCalculatedMetricRequest) returns (CalculatedMetric)

Atualiza uma CalculatedMetric em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateChannelGroup

rpc UpdateChannelGroup(UpdateChannelGroupRequest) returns (ChannelGroup)

Atualiza um ChannelGroup.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateConversionEvent

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

Descontinuado: use UpdateKeyEvent. Atualiza um evento de conversão com os atributos especificados.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomDimension

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

Atualiza uma CustomDimension em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomMetric

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

Atualiza uma CustomMetric em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRedactionSettings

rpc UpdateDataRedactionSettings(UpdateDataRedactionSettingsRequest) returns (DataRedactionSettings)

Atualiza um DataRedactionSettings em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRetentionSettings

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

Atualiza as configurações de retenção de dados singleton para esta propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataStream

rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream)

Atualiza um DataStream em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateEnhancedMeasurementSettings

rpc UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

Atualiza as configurações da medição otimizada para esse fluxo de dados. O fluxo precisa ativar a medição otimizada para que essas configurações entrem em vigor.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateEventCreateRule

rpc UpdateEventCreateRule(UpdateEventCreateRuleRequest) returns (EventCreateRule)

Atualiza um EventCreateRule.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateEventEditRule

rpc UpdateEventEditRule(UpdateEventEditRuleRequest) returns (EventEditRule)

Atualiza uma EventEditRule.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateExpandedDataSet

rpc UpdateExpandedDataSet(UpdateExpandedDataSetRequest) returns (ExpandedDataSet)

Atualiza um ExpandedDataSet em uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateGoogleSignalsSettings

rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

Atualiza as configurações dos Indicadores do Google para uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateKeyEvent

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

Atualiza um evento principal.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateMeasurementProtocolSecret

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Atualiza uma chave secreta do Measurement Protocol.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateProperty

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

Atualiza uma propriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateReportingDataAnnotation

rpc UpdateReportingDataAnnotation(UpdateReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

Atualiza uma anotação de dados de relatórios.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateSKAdNetworkConversionValueSchema

rpc UpdateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

Atualiza um SKAdNetworkConversionValueSchema.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateSubpropertyEventFilter

rpc UpdateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

Atualiza um filtro de eventos da subpropriedade.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit
UpdateSubpropertySyncConfig

rpc UpdateSubpropertySyncConfig(UpdateSubpropertySyncConfigRequest) returns (SubpropertySyncConfig)

Atualiza um SubpropertySyncConfig.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/analytics.edit

AccessBetweenFilter

Para expressar que o resultado precisa estar entre dois números (inclusive).

Campos
from_value

NumericValue

Começa com este número.

to_value

NumericValue

Termina com este número.

AccessBinding

Uma vinculação de um usuário a um conjunto de papéis.

Campos
name

string

Apenas saída. Nome do recurso desta vinculação.

Formato: accounts/{account}/accessBindings/{access_binding} ou properties/{property}/accessBindings/{access_binding}

Exemplo: "accounts/100/accessBindings/200"

roles[]

string

Uma lista de papéis a serem concedidos ao recurso pai.

Valores válidos: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data

Para usuários, se uma lista vazia de papéis for definida, esse AccessBinding será excluído.

Campo de união access_target. O destino para definir papéis. access_target pode ser apenas de um dos tipos a seguir:
user

string

Se definido, o endereço de e-mail do usuário para definir funções. Formato: "someuser@gmail.com"

AccessDateRange

Um intervalo contíguo de dias: startDate, startDate + 1, ..., endDate.

Campos
start_date

string

A data de início inclusiva da consulta no formato YYYY-MM-DD. Não pode ser posterior a endDate. O formato NdaysAgo, yesterday ou today também é aceito. Nesse caso, a data é inferida com base na hora atual no fuso horário da solicitação.

end_date

string

A data de término inclusiva da consulta no formato YYYY-MM-DD. Não pode ser anterior a startDate. O formato NdaysAgo, yesterday ou today também é aceito. Nesse caso, a data é inferida com base na hora atual no fuso horário da solicitação.

AccessDimension

As dimensões são atributos dos seus dados. Por exemplo, a dimensão userEmail indica o e-mail do usuário que acessou os dados de relatórios. Os valores de dimensão nas respostas de relatórios são strings.

Campos
dimension_name

string

O nome da API da dimensão. Consulte Esquema de acesso a dados para conferir a lista de dimensões compatíveis com essa API.

As dimensões são referenciadas por nome em dimensionFilter e orderBys.

AccessDimensionHeader

Descreve uma coluna de dimensão no relatório. As dimensões solicitadas em um relatório produzem entradas de coluna em linhas e DimensionHeaders. No entanto, as dimensões usadas exclusivamente em filtros ou expressões não produzem colunas em um relatório e, portanto, não geram cabeçalhos.

Campos
dimension_name

string

O nome da dimensão, por exemplo, "userEmail".

AccessDimensionValue

O valor de uma dimensão.

Campos
value

string

O valor da dimensão. Por exemplo, esse valor pode ser "França" para a dimensão "país".

AccessFilter

Uma expressão para filtrar valores de dimensão ou métrica.

Campos
field_name

string

O nome da dimensão ou da métrica.

Campo de união one_filter. Especifique um tipo de filtro para Filter. one_filter pode ser apenas de um dos tipos a seguir:
string_filter

AccessStringFilter

Filtro relacionado a strings.

in_list_filter

AccessInListFilter

Um filtro para valores na lista.

numeric_filter

AccessNumericFilter

Um filtro para valores numéricos ou de data.

between_filter

AccessBetweenFilter

Um filtro para dois valores.

AccessFilterExpression

Expressa filtros de dimensão ou métrica. Os campos na mesma expressão precisam ser todos dimensões ou todas métricas.

Campos
Campo de união one_expression. Especifique um tipo de expressão de filtro para FilterExpression. one_expression pode ser apenas de um dos tipos a seguir:
and_group

AccessFilterExpressionList

Cada uma das FilterExpressions no and_group tem uma relação AND.

or_group

AccessFilterExpressionList

Cada FilterExpression no or_group tem uma relação OR.

not_expression

AccessFilterExpression

A FilterExpression NÃO é not_expression.

access_filter

AccessFilter

Um filtro primitivo. Na mesma FilterExpression, todos os nomes de campo do filtro precisam ser todas as dimensões ou todas as métricas.

AccessFilterExpressionList

Uma lista de expressões de filtro.

Campos
expressions[]

AccessFilterExpression

Uma lista de expressões de filtro.

AccessInListFilter

O resultado precisa estar em uma lista de valores de string.

Campos
values[]

string

A lista de valores de string. Não pode estar vazio.

case_sensitive

bool

Se for "true", o valor da string vai diferenciar maiúsculas de minúsculas.

AccessMetric

As medições quantitativas de um relatório. Por exemplo, a métrica accessCount é o número total de registros de acesso a dados.

Campos
metric_name

string

O nome da API da métrica. Consulte Esquema de acesso a dados para ver a lista de métricas compatíveis com essa API.

As métricas são referenciadas por nome em metricFilter e orderBys.

AccessMetricHeader

Descreve uma coluna de métrica no relatório. As métricas visíveis solicitadas em um relatório produzem entradas de coluna em linhas e MetricHeaders. No entanto, as métricas usadas exclusivamente em filtros ou expressões não geram colunas em um relatório e, portanto, não geram cabeçalhos.

Campos
metric_name

string

O nome da métrica, por exemplo, "accessCount".

AccessMetricValue

O valor de uma métrica.

Campos
value

string

O valor da medição. Por exemplo, esse valor pode ser "13".

AccessNumericFilter

Filtra valores numéricos ou de data.

Campos
operation

Operation

O tipo de operação para este filtro.

value

NumericValue

Um valor numérico ou de data.

Operação

A operação aplicada a um filtro numérico.

Enums
OPERATION_UNSPECIFIED Não especificado.
EQUAL Igual
LESS_THAN Menor que
LESS_THAN_OR_EQUAL menor ou igual a
GREATER_THAN maior que
GREATER_THAN_OR_EQUAL maior ou igual a

AccessOrderBy

As cláusulas "ORDER BY" definem como as linhas serão classificadas na resposta. Por exemplo, ordenar as linhas por contagem de acesso decrescente é uma ordenação, e ordenar as linhas pela string do país é outra.

Campos
desc

bool

Se for verdadeiro, a classificação será feita em ordem decrescente. Se for "false" ou não especificado, a classificação será em ordem crescente.

Campo de união one_order_by. Especifique um tipo de ordenação para OrderBy. one_order_by pode ser apenas de um dos tipos a seguir:
metric

MetricOrderBy

Classifica os resultados pelos valores de uma métrica.

dimension

DimensionOrderBy

Classifica os resultados pelos valores de uma dimensão.

DimensionOrderBy

Ordena por valores de dimensão.

Campos
dimension_name

string

Um nome de dimensão na solicitação para ordenar por.

order_type

OrderType

Controla a regra para ordenação de valores de dimensão.

OrderType

Regra para ordenar os valores da dimensão de string.

Enums
ORDER_TYPE_UNSPECIFIED Não especificado.
ALPHANUMERIC Ordenação alfanumérica por ponto de código Unicode. Por exemplo, "2" < "A" < "X" < "b" < "z".
CASE_INSENSITIVE_ALPHANUMERIC Classificação alfanumérica que não diferencia maiúsculas de minúsculas por ponto de código Unicode minúsculo. Por exemplo, "2" < "A" < "b" < "X" < "z".
NUMERIC Os valores de dimensão são convertidos em números antes da classificação. Por exemplo, na classificação NUMÉRICA, "25" < "100", e na classificação ALPHANUMERIC, "100" < "25". Os valores de dimensão não numéricos têm o mesmo valor de ordenação abaixo de todos os valores numéricos.

MetricOrderBy

Ordena por valores de métrica.

Campos
metric_name

string

Um nome de métrica na solicitação para ordenar por.

AccessQuota

Estado atual de todas as cotas para essa propriedade do Google Analytics. Se uma cota de uma propriedade for esgotada, todas as solicitações para essa propriedade vão retornar erros de "Recurso esgotado".

Campos
tokens_per_day

AccessQuotaStatus

As propriedades podem usar 250.000 tokens por dia. A maioria das solicitações consome menos de 10 tokens.

tokens_per_hour

AccessQuotaStatus

As propriedades podem usar 50.000 tokens por hora. Uma solicitação de API consome um único número de tokens, que é deduzido de todas as cotas horárias, diárias e por projeto.

concurrent_requests

AccessQuotaStatus

As propriedades podem usar até 50 solicitações simultâneas.

server_errors_per_project_per_hour

AccessQuotaStatus

Pares de propriedades e projetos do Cloud podem ter até 50 erros de servidor por hora.

tokens_per_project_per_hour

AccessQuotaStatus

As propriedades podem usar até 25% dos tokens por projeto e hora. Isso significa que as propriedades do Analytics 360 podem usar 12.500 tokens por projeto e hora. Uma solicitação de API consome um único número de tokens, que é deduzido de todas as cotas horárias, diárias e por projeto.

AccessQuotaStatus

Estado atual de um grupo de cotas específico.

Campos
consumed

int32

Cota consumida por esta solicitação.

remaining

int32

Cota restante após esta solicitação.

AccessRow

Acesse os dados de relatório de cada linha.

Campos
dimension_values[]

AccessDimensionValue

Lista de valores de dimensão. Esses valores estão na mesma ordem especificada na solicitação.

metric_values[]

AccessMetricValue

Lista de valores de métricas. Esses valores estão na mesma ordem especificada na solicitação.

AccessStringFilter

O filtro para strings.

Campos
match_type

MatchType

O tipo de correspondência para este filtro.

value

string

O valor de string usado para a correspondência.

case_sensitive

bool

Se for "true", o valor da string vai diferenciar maiúsculas de minúsculas.

MatchType

O tipo de correspondência de um filtro de string.

Enums
MATCH_TYPE_UNSPECIFIED Não especificado
EXACT Correspondência exata do valor da string.
BEGINS_WITH Começa com o valor da string.
ENDS_WITH Termina com o valor da string.
CONTAINS Contém o valor da string.
FULL_REGEXP Correspondência completa da expressão regular com o valor da string.
PARTIAL_REGEXP Correspondência parcial da expressão regular com o valor da string.

Conta

Uma mensagem de recurso que representa uma conta do Google Analytics.

Campos
name

string

Apenas saída. Nome do recurso desta conta. Formato: accounts/{account}. Exemplo: "accounts/100"

create_time

Timestamp

Apenas saída. Data e hora em que esta conta foi criada originalmente.

update_time

Timestamp

Apenas saída. Hora em que os campos de payload da conta foram atualizados pela última vez.

display_name

string

Obrigatório. Nome de exibição legível para esta conta.

region_code

string

País da empresa. Precisa ser um código de região Unicode CLDR.

deleted

bool

Apenas saída. Indica se a conta foi excluída de forma temporária ou não. As contas excluídas são excluídas dos resultados da lista, a menos que sejam especificamente solicitadas.

gmp_organization

string

Apenas saída. O URI de um recurso de organização do Google Marketing Platform. Definido apenas quando esta conta está conectada a uma organização do GMP. Formato: marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

Um recurso virtual que representa uma visão geral de uma conta e todas as propriedades filhas do Google Analytics.

Campos
name

string

Nome do recurso para este resumo da conta. Formato: accountSummaries/{account_id}. Exemplo: "accountSummaries/1000"

account

string

Nome do recurso da conta referida por este resumo. Formato: accounts/{account_id}. Exemplo: "accounts/1000"

display_name

string

Nome de exibição da conta referida neste resumo.

property_summaries[]

PropertySummary

Lista de resumos das contas secundárias desta conta.

AcknowledgeUserDataCollectionRequest

Mensagem de solicitação para o RPC AcknowledgeUserDataCollection.

Campos
property

string

Obrigatório. A propriedade para confirmar a coleta de dados do usuário.

acknowledgement

string

Obrigatório. Uma confirmação de que o autor da chamada deste método entende os termos da coleta de dados do usuário.

Esse campo precisa conter o valor exato: "Confirmo que tenho as declarações e os direitos de privacidade necessários dos meus usuários finais para coleta e tratamento dos dados deles, incluindo a associação de tais dados com as informações de visitas que o Google Analytics coleta da minha propriedade de site e/ou app".

AcknowledgeUserDataCollectionResponse

Esse tipo não tem campos.

Mensagem de resposta para o RPC "AcknowledgeUserDataCollection".

ActionType

Tipos de ações que podem mudar um recurso.

Enums
ACTION_TYPE_UNSPECIFIED Tipo de ação desconhecido ou não especificado.
CREATED O recurso foi criado nesta mudança.
UPDATED O recurso foi atualizado nesta mudança.
DELETED O recurso foi excluído nesta mudança.

ActorType

Diferentes tipos de atores que podem fazer mudanças nos recursos do Google Analytics.

Enums
ACTOR_TYPE_UNSPECIFIED Tipo de ator desconhecido ou não especificado.
USER Mudanças feitas pelo usuário especificado em actor_email.
SYSTEM Mudanças feitas pelo sistema do Google Analytics.
SUPPORT Mudanças feitas pela equipe de suporte do Google Analytics.

ApproveDisplayVideo360AdvertiserLinkProposalRequest

Mensagem de solicitação para o RPC ApproveDisplayVideo360AdvertiserLinkProposal.

Campos
name

string

Obrigatório. O nome do DisplayVideo360AdvertiserLinkProposal a ser aprovado. Exemplo de formato: properties/1234/displayVideo360AdvertiserLinkProposals/5678

ApproveDisplayVideo360AdvertiserLinkProposalResponse

Mensagem de resposta para o RPC ApproveDisplayVideo360AdvertiserLinkProposal.

Campos

ArchiveAudienceRequest

Mensagem de solicitação para o RPC ArchiveAudience.

Campos
name

string

Obrigatório. Exemplo de formato: properties/1234/audiences/5678

ArchiveCustomDimensionRequest

Mensagem de solicitação para o RPC ArchiveCustomDimension.

Campos
name

string

Obrigatório. O nome da CustomDimension a ser arquivada. Exemplo de formato: properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

Mensagem de solicitação para a RPC ArchiveCustomMetric.

Campos
name

string

Obrigatório. O nome da CustomMetric a ser arquivada. Exemplo de formato: properties/1234/customMetrics/5678

AttributionSettings

As configurações de atribuição usadas para uma determinada propriedade. Esse é um recurso singleton.

Campos
name

string

Apenas saída. Nome do recurso das configurações de atribuição. Formato: properties/{property_id}/attributionSettings. Exemplo: "properties/1000/attributionSettings"

acquisition_conversion_event_lookback_window

AcquisitionConversionEventLookbackWindow

Obrigatório. A configuração da janela de lookback para eventos de conversão de aquisição. O tamanho padrão da janela é de 30 dias.

other_conversion_event_lookback_window

OtherConversionEventLookbackWindow

Obrigatório. A janela de lookback para todos os outros eventos de conversão que não são de aquisição. O tamanho padrão da janela é de 90 dias.

reporting_attribution_model

ReportingAttributionModel

Obrigatório. O modelo de atribuição de relatórios usado para calcular o crédito pela conversão nos relatórios desta propriedade.

As mudanças nessa configuração se aplicam a dados históricos e futuros. Essas mudanças vão aparecer nos relatórios com dados de conversão e receita. Os dados sobre usuários e sessões não serão afetados.

ads_web_conversion_data_export_scope

AdsWebConversionDataExportScope

Obrigatório. O escopo da exportação de conversões para dados exportados para contas vinculadas do Google Ads.

AcquisitionConversionEventLookbackWindow

Até quando os eventos devem ser considerados para inclusão em um caminho de conversão que leva à primeira instalação de um app ou à primeira visita a um site.

Enums
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED Tamanho da janela de lookback não especificado.
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS Janela de lookback de sete dias.
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS Janela de lookback de 30 dias.

AdsWebConversionDataExportScope

O escopo da exportação de conversões para dados exportados para contas vinculadas do Google Ads.

Enums
ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED Valor padrão. Esse valor não é usado.
NOT_SELECTED_YET Nenhum escopo de exportação de dados selecionado ainda. O escopo de exportação nunca pode ser alterado de volta para esse valor.
PAID_AND_ORGANIC_CHANNELS Os canais pagos e orgânicos podem receber crédito pela conversão, mas somente o crédito atribuído a canais do Google Ads vai aparecer nas suas contas do Google Ads. Para saber mais, consulte Canais pagos e orgânicos.
GOOGLE_PAID_CHANNELS Somente canais pagos do Google Ads estão qualificados para receber crédito pela conversão. Para saber mais, consulte Canais pagos do Google.

OtherConversionEventLookbackWindow

Até quando os eventos devem ser considerados para inclusão em um caminho de conversão para todas as conversões, exceto a primeira instalação do app/primeira visita ao site.

Enums
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED Tamanho da janela de lookback não especificado.
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS Janela de lookback de 30 dias.
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS Janela de lookback de 60 dias.
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS Janela de lookback de 90 dias.

ReportingAttributionModel

O modelo de atribuição de relatórios usado para calcular o crédito pela conversão nos relatórios desta propriedade.

Enums
REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED Modelo de atribuição de relatórios não especificado.
PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN A atribuição baseada em dados distribui o crédito pela conversão com base nos dados de cada evento de conversão. Cada modelo com base em dados é específico para o anunciante e o evento de conversão. Antes era CROSS_CHANNEL_DATA_DRIVEN
PAID_AND_ORGANIC_CHANNELS_LAST_CLICK Ignora o tráfego direto e atribui 100% do valor da conversão ao último canal em que o cliente clicou (ou teve a visualização engajada para o YouTube) antes de fazer a conversão. Antes era CROSS_CHANNEL_LAST_CLICK
GOOGLE_PAID_CHANNELS_LAST_CLICK Atribui 100% do valor da conversão ao último canal pago do Google em que o cliente clicou antes da conversão. Antes era ADS_PREFERRED_LAST_CLICK

Público-alvo

Uma mensagem de recurso que representa um público-alvo.

Campos
name

string

Apenas saída. O nome do recurso de público-alvo. Formato: properties/{propertyId}/audiences/{audienceId}

display_name

string

Obrigatório. O nome de exibição do público-alvo.

description

string

Obrigatório. A descrição do público-alvo.

membership_duration_days

int32

Obrigatório. Imutável. O período em que um usuário deve permanecer em um público-alvo. Não é possível definir um período maior que 540 dias.

ads_personalization_enabled

bool

Apenas saída. Ele é definido automaticamente como "false" pelo GA se for um público-alvo de NPA e estiver excluído da personalização de anúncios.

event_trigger

AudienceEventTrigger

Opcional. Especifica um evento a ser registrado quando um usuário entra no público-alvo. Se não for definido, nenhum evento será registrado quando um usuário entrar no público-alvo.

exclusion_duration_mode

AudienceExclusionDurationMode

Imutável. Especifica por quanto tempo uma exclusão dura para usuários que atendem ao filtro de exclusão. Ele é aplicado a todas as cláusulas de filtro EXCLUIR e é ignorado quando não há uma cláusula de filtro EXCLUIR no público-alvo.

filter_clauses[]

AudienceFilterClause

Obrigatório. Imutável. Lista não ordenada. Cláusulas de filtro que definem o público-alvo. Todas as cláusulas serão unidas por AND.

create_time

Timestamp

Apenas saída. Data e hora em que o público-alvo foi criado.

AudienceExclusionDurationMode

Especifica por quanto tempo uma exclusão dura para usuários que atendem ao filtro de exclusão.

Enums
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Não especificado.
EXCLUDE_TEMPORARILY Exclua usuários do público-alvo durante os períodos em que eles atendem à cláusula de filtro.
EXCLUDE_PERMANENTLY Exclua usuários do público-alvo se eles já atenderam à cláusula de filtro.

AudienceDimensionOrMetricFilter

Um filtro específico para uma única dimensão ou métrica.

Campos
field_name

string

Obrigatório. Imutável. O nome da dimensão ou da métrica que será filtrada. Se o nome do campo se referir a uma dimensão ou métrica personalizada, um prefixo de escopo será adicionado ao início do nome da dimensão ou métrica personalizada. Para mais informações sobre prefixos de escopo ou dimensões/métricas personalizadas, consulte a documentação da API Google Analytics Data.

at_any_point_in_time

bool

Opcional. Indica se este filtro precisa de avaliação dinâmica ou não. Se definida como "true", os usuários vão entrar no público-alvo se já atenderam à condição (avaliação estática). Se não estiver definida ou estiver definida como "false", a avaliação de usuários para um público-alvo será dinâmica. Os usuários serão adicionados a um público-alvo quando atenderem às condições e removidos quando deixarem de atender.

Isso só pode ser definido quando o escopo de público-alvo é ACROSS_ALL_SESSIONS.

in_any_n_day_period

int32

Opcional. Se definido, especifica o período para avaliar os dados em número de dias. Se não for definido, os dados de público-alvo serão avaliados em relação aos dados de ciclo de vida (por exemplo, período infinito).

Por exemplo, se definido como "1 dia", apenas os dados do dia atual serão avaliados. O ponto de referência é o dia atual quando "at_any_point_in_time" não está definido ou é falso.

Só pode ser definido quando o escopo de público-alvo é ACROSS_ALL_SESSIONS e não pode ser maior que 60 dias.

Campo de união one_filter. Um dos filtros acima. one_filter pode ser apenas de um dos tipos a seguir:
string_filter

StringFilter

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.

in_list_filter

InListFilter

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções.

numeric_filter

NumericFilter

Um filtro para valores numéricos ou de data em uma dimensão ou métrica.

between_filter

BetweenFilter

Um filtro para valores numéricos ou de data entre determinados valores em uma dimensão ou métrica.

BetweenFilter

Um filtro para valores numéricos ou de data entre determinados valores em uma dimensão ou métrica.

Campos
from_value

NumericValue

Obrigatório. Começa com esse número, inclusive.

to_value

NumericValue

Obrigatório. Termina com este número, inclusive.

InListFilter

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções.

Campos
values[]

string

Obrigatório. A lista de possíveis valores de string para correspondência. Não pode estar vazio.

case_sensitive

bool

Opcional. Se for "true", a correspondência vai diferenciar maiúsculas de minúsculas. Se for "false", a correspondência não vai diferenciar maiúsculas de minúsculas.

NumericFilter

Um filtro para valores numéricos ou de data em uma dimensão ou métrica.

Campos
operation

Operation

Obrigatório. A operação aplicada a um filtro numérico.

value

NumericValue

Obrigatório. O valor numérico ou de data a ser correspondido.

Operação

A operação aplicada a um filtro numérico.

Enums
OPERATION_UNSPECIFIED Não especificado.
EQUAL Igual.
LESS_THAN Menor que.
GREATER_THAN Maior que

NumericValue

Para representar um número.

Campos
Campo de união one_value. Um valor numérico. one_value pode ser apenas de um dos tipos a seguir:
int64_value

int64

Número inteiro.

double_value

double

Valor duplo.

StringFilter

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.

Campos
match_type

MatchType

Obrigatório. O tipo de correspondência do filtro de string.

value

string

Obrigatório. O valor da string a ser comparado.

case_sensitive

bool

Opcional. Se for "true", a correspondência vai diferenciar maiúsculas de minúsculas. Se for "false", a correspondência não vai diferenciar maiúsculas de minúsculas.

MatchType

O tipo de correspondência do filtro de string.

Enums
MATCH_TYPE_UNSPECIFIED Não especificado
EXACT Correspondência exata do valor da string.
BEGINS_WITH Começa com o valor da string.
ENDS_WITH Termina com o valor da string.
CONTAINS Contém o valor da string.
FULL_REGEXP A expressão regular completa corresponde ao valor da string.

AudienceEventFilter

Um filtro que corresponde a eventos de um único nome de evento. Se um parâmetro de evento for especificado, apenas o subconjunto de eventos que corresponderem ao nome do evento único e às expressões de filtro de parâmetro vai corresponder a esse filtro de evento.

Campos
event_name

string

Obrigatório. Imutável. O nome do evento a ser comparado.

event_parameter_filter_expression

AudienceFilterExpression

Opcional. Se especificado, esse filtro vai corresponder a eventos que correspondem ao nome do evento único e às expressões de filtro de parâmetro. Não é possível definir AudienceEventFilter na expressão de filtro de parâmetro. Por exemplo, filtros de eventos aninhados não são aceitos. Precisa ser um único and_group de dimension_or_metric_filter ou not_expression. Não há suporte para ANDs de ORs. Além disso, se ele incluir um filtro para "eventCount", apenas esse será considerado. Todos os outros serão ignorados.

AudienceEventTrigger

Especifica um evento a ser registrado quando um usuário entra no público-alvo.

Campos
event_name

string

Obrigatório. O nome do evento que será registrado.

log_condition

LogCondition

Obrigatório. Quando registrar o evento.

LogCondition

Determina quando registrar o evento.

Enums
LOG_CONDITION_UNSPECIFIED A condição de registro não foi especificada.
AUDIENCE_JOINED O evento só deve ser registrado quando um usuário entra.
AUDIENCE_MEMBERSHIP_RENEWED O evento precisa ser registrado sempre que a condição do público-alvo for atendida, mesmo que o usuário já seja membro dele.

AudienceFilterClause

Uma cláusula para definir um filtro simples ou de sequência. Um filtro pode ser inclusivo (por exemplo, usuários que atendem à cláusula de filtro são incluídos no público-alvo) ou exclusivo (por exemplo, usuários que atendem à cláusula de filtro são excluídos do público-alvo).

Campos
clause_type

AudienceClauseType

Obrigatório. Especifica se esta é uma cláusula de filtro de inclusão ou exclusão.

Campo de união filter.

filter pode ser apenas de um dos tipos a seguir:

simple_filter

AudienceSimpleFilter

Um filtro simples que um usuário precisa atender para ser membro do público-alvo.

sequence_filter

AudienceSequenceFilter

Filtros que precisam ocorrer em uma ordem específica para que o usuário seja membro do público-alvo.

AudienceClauseType

Especifica se esta é uma cláusula de filtro de inclusão ou exclusão.

Enums
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Tipo de cláusula não especificado.
INCLUDE Os usuários serão incluídos no público-alvo se a cláusula de filtro for atendida.
EXCLUDE Os usuários serão excluídos do público-alvo se a cláusula de filtro for atendida.

AudienceFilterExpression

Uma expressão lógica de filtros de dimensão, métrica ou evento de público-alvo.

Campos
Campo de união expr. A expressão aplicada a um filtro. expr pode ser apenas de um dos tipos a seguir:
and_group

AudienceFilterExpressionList

Uma lista de expressões a serem combinadas com AND. Ele só pode conter AudienceFilterExpressions com or_group. Isso precisa ser definido para o AudienceFilterExpression de nível superior.

or_group

AudienceFilterExpressionList

Uma lista de expressões combinadas com "OR". Não pode conter AudienceFilterExpressions com and_group ou or_group.

not_expression

AudienceFilterExpression

Uma expressão de filtro a ser NOT'ed (por exemplo, invertida, complementada). Ele só pode incluir um dimension_or_metric_filter. Isso não pode ser definido na AudienceFilterExpression de nível superior.

dimension_or_metric_filter

AudienceDimensionOrMetricFilter

Um filtro em uma única dimensão ou métrica. Isso não pode ser definido na AudienceFilterExpression de nível superior.

event_filter

AudienceEventFilter

Cria um filtro que corresponde a um evento específico. Isso não pode ser definido na AudienceFilterExpression de nível superior.

AudienceFilterExpressionList

Uma lista de expressões de filtro de público-alvo.

Campos
filter_expressions[]

AudienceFilterExpression

Uma lista de expressões de filtro de público-alvo.

AudienceFilterScope

Especifica como avaliar os usuários para que eles entrem em um público-alvo.

Enums
AUDIENCE_FILTER_SCOPE_UNSPECIFIED O escopo não foi especificado.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT O usuário entra no público-alvo se a condição do filtro for atendida em um evento.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION O usuário entra no público-alvo se a condição do filtro for atendida em uma sessão.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS O usuário entra no público-alvo se a condição do filtro for atendida por qualquer evento em qualquer sessão.

AudienceSequenceFilter

Define filtros que precisam ocorrer em uma ordem específica para que o usuário seja membro do público-alvo.

Campos
scope

AudienceFilterScope

Obrigatório. Imutável. Especifica o escopo deste filtro.

sequence_maximum_duration

Duration

Opcional. Define o período em que toda a sequência precisa ocorrer.

sequence_steps[]

AudienceSequenceStep

Obrigatório. Uma sequência ordenada de etapas. Um usuário precisa concluir cada etapa para participar do filtro de sequência.

AudienceSequenceStep

Uma condição que precisa ocorrer na ordem de etapa especificada para que o usuário corresponda à sequência.

Campos
scope

AudienceFilterScope

Obrigatório. Imutável. Especifica o escopo desta etapa.

immediately_follows

bool

Opcional. Se for verdadeiro, o evento que satisfaz esta etapa precisa ser o próximo evento após o evento que satisfaz a última etapa. Se não estiver definido ou for "false", essa etapa vai seguir indiretamente a anterior. Por exemplo, pode haver eventos entre a etapa anterior e esta. Ele é ignorado na primeira etapa.

constraint_duration

Duration

Opcional. Quando definida, essa etapa precisa ser concluída dentro da constraint_duration da etapa anterior (por exemplo, t[i] - t[i-1] <= constraint_duration). Se não for definido, não haverá requisito de duração (a duração será ilimitada). Ele é ignorado na primeira etapa.

filter_expression

AudienceFilterExpression

Obrigatório. Imutável. Uma expressão lógica de filtros de dimensão, métrica ou evento de público-alvo em cada etapa.

AudienceSimpleFilter

Define um filtro simples que um usuário precisa atender para ser membro do público-alvo.

Campos
scope

AudienceFilterScope

Obrigatório. Imutável. Especifica o escopo deste filtro.

filter_expression

AudienceFilterExpression

Obrigatório. Imutável. Uma expressão lógica de filtros de dimensão, métrica ou evento de público-alvo.

BatchCreateAccessBindingsRequest

Mensagem de solicitação para o RPC BatchCreateAccessBindings.

Campos
parent

string

Obrigatório. A conta ou propriedade proprietária das vinculações de acesso. O campo "parent" nas mensagens CreateAccessBindingRequest precisa estar vazio ou corresponder a este campo. Formatos: - accounts/{account} - properties/{property}

requests[]

CreateAccessBindingRequest

Obrigatório. As solicitações que especificam as vinculações de acesso a serem criadas. É possível criar no máximo 1.000 vinculações de acesso em um lote.

BatchCreateAccessBindingsResponse

Mensagem da resposta para o RPC "BatchCreateAccessBindings".

Campos
access_bindings[]

AccessBinding

As vinculações de acesso criadas.

BatchDeleteAccessBindingsRequest

Mensagem de solicitação para o RPC BatchDeleteAccessBindings.

Campos
parent

string

Obrigatório. A conta ou propriedade proprietária das vinculações de acesso. O elemento principal de todos os valores fornecidos para o campo "names" nas mensagens DeleteAccessBindingRequest precisa corresponder a este campo. Formatos: - accounts/{account} - properties/{property}

requests[]

DeleteAccessBindingRequest

Obrigatório. As solicitações que especificam as vinculações de acesso a serem excluídas. É possível excluir no máximo 1.000 vinculações de acesso em um lote.

BatchGetAccessBindingsRequest

Mensagem de solicitação para o RPC BatchGetAccessBindings.

Campos
parent

string

Obrigatório. A conta ou propriedade proprietária das vinculações de acesso. O elemento pai de todos os valores fornecidos para o campo "names" precisa corresponder a este campo. Formatos: - accounts/{account} - properties/{property}

names[]

string

Obrigatório. Os nomes das vinculações de acesso a serem recuperadas. É possível recuperar no máximo 1.000 vinculações de acesso em um lote. Formatos: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

BatchGetAccessBindingsResponse

Mensagem da resposta para o RPC "BatchGetAccessBindings".

Campos
access_bindings[]

AccessBinding

As vinculações de acesso solicitadas.

BatchUpdateAccessBindingsRequest

Mensagem de solicitação para o RPC "BatchUpdateAccessBindings".

Campos
parent

string

Obrigatório. A conta ou propriedade proprietária das vinculações de acesso. O pai de todas as AccessBinding fornecidas nas mensagens UpdateAccessBindingRequest precisa corresponder a este campo. Formatos: - accounts/{account} - properties/{property}

requests[]

UpdateAccessBindingRequest

Obrigatório. As solicitações que especificam as vinculações de acesso a serem atualizadas. É possível atualizar até 1.000 vinculações de acesso em um lote.

BatchUpdateAccessBindingsResponse

Mensagem da resposta para o RPC "BatchUpdateAccessBindings".

Campos
access_bindings[]

AccessBinding

As vinculações de acesso foram atualizadas.

CalculatedMetric

Uma definição para uma métrica calculada.

Campos
name

string

Apenas saída. Nome do recurso para CalculatedMetric. Formato: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'

description

string

Opcional. Descrição para essa métrica calculada. No máximo 4.096 caracteres.

display_name

string

Obrigatório. Nome de exibição dessa métrica calculada, conforme mostrado na interface do Google Analytics. O tamanho máximo é de 82 caracteres.

calculated_metric_id

string

Apenas saída. O ID a ser usado para a métrica calculada. Na interface, isso é chamado de "Nome da API".

O calculated_metric_id é usado ao fazer referência a essa métrica calculada de APIs externas. Por exemplo, "calcMetric:{calculated_metric_id}".

metric_unit

MetricUnit

Obrigatório. O tipo do valor da métrica calculada.

restricted_metric_type[]

RestrictedMetricType

Apenas saída. Tipos de dados restritos que essa métrica contém.

formula

string

Obrigatório. A definição da métrica calculada. O número máximo de métricas personalizadas referenciadas exclusivas é 5. As fórmulas são compatíveis com as seguintes operações: + (adição), - (subtração), - (negativo), * (multiplicação), / (divisão), () (parênteses). Qualquer número real válido que se encaixe em um Long (inteiro de 64 bits) ou um Double (número de ponto flutuante de 64 bits) é aceito. Exemplo de fórmula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"

invalid_metric_reference

bool

Apenas saída. Se for "true", essa métrica calculada terá uma referência de métrica inválida. Qualquer coisa que use uma métrica calculada com invalid_metric_reference definido como "true" pode falhar, gerar avisos ou produzir resultados inesperados.

MetricUnit

Tipos possíveis de representação do valor da métrica calculada.

Enums
METRIC_UNIT_UNSPECIFIED MetricUnit não especificado ou ausente.
STANDARD Essa métrica usa unidades padrão.
CURRENCY Essa métrica mede uma moeda.
FEET Essa métrica mede pés.
MILES Essa métrica mede milhas.
METERS Essa métrica mede metros.
KILOMETERS Essa métrica mede quilômetros.
MILLISECONDS Essa métrica mede milissegundos.
SECONDS Essa métrica mede segundos.
MINUTES Essa métrica mede minutos.
HOURS Essa métrica mede horas.

RestrictedMetricType

Rótulos que marcam os dados na métrica calculada usada em conjunto com funções de usuário que restringem o acesso a métricas de custo e/ou receita.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo desconhecido ou não especificado.
COST_DATA Os relatórios de métricas mostram dados de custo.
REVENUE_DATA A métrica informa dados de receita.

CancelDisplayVideo360AdvertiserLinkProposalRequest

Mensagem de solicitação para o RPC CancelDisplayVideo360AdvertiserLinkProposal.

Campos
name

string

Obrigatório. O nome da DisplayVideo360AdvertiserLinkProposal a ser cancelada. Exemplo de formato: properties/1234/displayVideo360AdvertiserLinkProposals/5678

ChangeHistoryChange

Uma descrição de uma mudança em um único recurso do Google Analytics.

Campos
resource

string

Nome do recurso cujas mudanças são descritas por esta entrada.

action

ActionType

O tipo de ação que mudou esse recurso.

resource_before_change

ChangeHistoryResource

Conteúdo do recurso antes da mudança. Se o recurso foi criado nessa mudança, esse campo não vai aparecer.

resource_after_change

ChangeHistoryResource

Conteúdo do recurso após a mudança. Se o recurso foi excluído nessa mudança, esse campo vai estar ausente.

ChangeHistoryResource

Um snapshot de um recurso antes ou depois do resultado de uma mudança no histórico de alterações.

Campos

Campo de união resource.

resource pode ser apenas de um dos tipos a seguir:

account

Account

Um snapshot de um recurso "Account" no histórico de alterações.

property

Property

Um snapshot de um recurso de propriedade no histórico de alterações.

google_signals_settings

GoogleSignalsSettings

Um instantâneo de um recurso "GoogleSignalsSettings" no histórico de alterações.

conversion_event

ConversionEvent

Um snapshot de um recurso "ConversionEvent" no histórico de mudanças.

measurement_protocol_secret

MeasurementProtocolSecret

Um snapshot de um recurso MeasurementProtocolSecret no histórico de alterações.

custom_dimension

CustomDimension

Um snapshot de um recurso CustomDimension no histórico de alterações.

custom_metric

CustomMetric

Um snapshot de um recurso "CustomMetric" no histórico de mudanças.

data_retention_settings

DataRetentionSettings

Um snapshot de um recurso de configurações de retenção de dados no histórico de mudanças.

data_stream

DataStream

Um snapshot de um recurso do DataStream no histórico de alterações.

attribution_settings

AttributionSettings

Um snapshot do recurso "AttributionSettings" no histórico de alterações.

expanded_data_set

ExpandedDataSet

Um instantâneo de um recurso ExpandedDataSet no histórico de alterações.

channel_group

ChannelGroup

Um snapshot de um recurso ChannelGroup no histórico de mudanças.

enhanced_measurement_settings

EnhancedMeasurementSettings

Um snapshot do recurso EnhancedMeasurementSettings no histórico de alterações.

data_redaction_settings

DataRedactionSettings

Um snapshot do recurso "DataRedactionSettings" no histórico de alterações.

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

Um snapshot do recurso "SKAdNetworkConversionValueSchema" no histórico de alterações.

audience

Audience

Um snapshot de um recurso de público-alvo no histórico de alterações.

event_create_rule

EventCreateRule

Um snapshot de um recurso "EventCreateRule" no histórico de alterações.

key_event

KeyEvent

Um snapshot de um recurso KeyEvent no histórico de alterações.

calculated_metric

CalculatedMetric

Um snapshot de um recurso "CalculatedMetric" no histórico de alterações.

reporting_data_annotation

ReportingDataAnnotation

Um snapshot de um recurso "ReportingDataAnnotation" no histórico de alterações.

subproperty_sync_config

SubpropertySyncConfig

Um instantâneo de um recurso "SubpropertySyncConfig" no histórico de alterações.

reporting_identity_settings

ReportingIdentitySettings

Um snapshot de um recurso ReportingIdentitySettings no histórico de alterações.

ChangeHistoryEvent

Um conjunto de mudanças em uma conta do Google Analytics ou nas propriedades filhas dela que resultaram da mesma causa. As causas comuns são atualizações feitas na interface do usuário do Google Analytics, mudanças do suporte ao cliente ou alterações automáticas do sistema do Google Analytics.

Campos
id

string

ID deste evento do histórico de mudanças. Esse ID é exclusivo no Google Analytics.

change_time

Timestamp

Horário em que a mudança foi feita.

actor_type

ActorType

O tipo de ator que fez essa mudança.

user_actor_email

string

Endereço de e-mail da Conta do Google que fez a mudança. Será um endereço de e-mail válido se o campo "ator" estiver definido como "USER", e vazio caso contrário. Contas do Google excluídas causam um erro.

changes_filtered

bool

Se for "true", a lista de mudanças retornada foi filtrada e não representa todas as mudanças que ocorreram nesse evento.

changes[]

ChangeHistoryChange

Uma lista de mudanças feitas neste evento do histórico de alterações que se encaixam nos filtros especificados em "SearchChangeHistoryEventsRequest".

ChangeHistoryResourceType

Tipos de recursos cujas mudanças podem ser retornadas do histórico de alterações.

Enums
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED Tipo de recurso desconhecido ou não especificado.
ACCOUNT Recurso da conta
PROPERTY Recurso de propriedade
GOOGLE_SIGNALS_SETTINGS Recurso GoogleSignalsSettings
CONVERSION_EVENT Recurso ConversionEvent
MEASUREMENT_PROTOCOL_SECRET Recurso MeasurementProtocolSecret
CUSTOM_DIMENSION Recurso CustomDimension
CUSTOM_METRIC Recurso CustomMetric
DATA_RETENTION_SETTINGS Recurso DataRetentionSettings
DATA_STREAM Recurso DataStream
ATTRIBUTION_SETTINGS Recurso AttributionSettings
EXPANDED_DATA_SET Recurso ExpandedDataSet
CHANNEL_GROUP Recurso ChannelGroup
ENHANCED_MEASUREMENT_SETTINGS Recurso EnhancedMeasurementSettings
DATA_REDACTION_SETTINGS Recurso DataRedactionSettings
SKADNETWORK_CONVERSION_VALUE_SCHEMA Recurso SKAdNetworkConversionValueSchema
AUDIENCE Recurso de público-alvo
EVENT_CREATE_RULE Recurso EventCreateRule
KEY_EVENT Recurso KeyEvent
CALCULATED_METRIC Recurso CalculatedMetric
REPORTING_DATA_ANNOTATION Recurso ReportingDataAnnotation
SUBPROPERTY_SYNC_CONFIG Recurso SubpropertySyncConfig
REPORTING_IDENTITY_SETTINGS Recurso ReportingIdentitySettings

ChannelGroup

Uma mensagem de recurso que representa um grupo de canais.

Campos
name

string

Apenas saída. O nome do recurso para este recurso de grupo de canais. Formato: properties/{property}/channelGroups/{channel_group}

display_name

string

Obrigatório. O nome de exibição do grupo de canais. Comprimento máximo de 80 caracteres.

description

string

A descrição do grupo de canais. O comprimento máximo é de 256 caracteres.

grouping_rule[]

GroupingRule

Obrigatório. As regras de agrupamento de canais. O número máximo de regras é 50.

system_defined

bool

Apenas saída. Se for "true", esse grupo de canais será o grupo de canais padrão predefinido pelo Google Analytics. Não é possível atualizar o nome de exibição e as regras de agrupamento deste grupo de canais.

primary

bool

Opcional. Se for "true", esse grupo de canais será usado como o grupo de canais padrão para relatórios. Só é possível definir um grupo de canais como primary por vez. Se o campo primary for definido em um grupo de canais, ele será cancelado no grupo de canais principal anterior.

O grupo de canais predefinido do Google Analytics é o principal por padrão.

ChannelGroupFilter

Um filtro específico para uma única dimensão.

Campos
field_name

string

Obrigatório. Imutável. O nome da dimensão a ser filtrada.

Campo de união value_filter. Um StringFilter ou InListFilter que define o comportamento desses filtros. value_filter pode ser apenas de um dos tipos a seguir:
string_filter

StringFilter

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.

in_list_filter

InListFilter

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções.

InListFilter

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções. A correspondência não diferencia maiúsculas e minúsculas.

Campos
values[]

string

Obrigatório. A lista de possíveis valores de string para correspondência. Não pode estar vazio.

StringFilter

Filtro em que o valor do campo é uma string. A correspondência não diferencia maiúsculas e minúsculas.

Campos
match_type

MatchType

Obrigatório. O tipo de correspondência do filtro de string.

value

string

Obrigatório. O valor da string a ser comparado.

MatchType

Como o filtro será usado para determinar uma correspondência.

Enums
MATCH_TYPE_UNSPECIFIED Tipo de correspondência padrão.
EXACT Correspondência exata do valor da string.
BEGINS_WITH Começa com o valor da string.
ENDS_WITH Termina com o valor da string.
CONTAINS Contém o valor da string.
FULL_REGEXP Correspondência completa de expressão regular com o valor da string.
PARTIAL_REGEXP Correspondência parcial de expressão regular com o valor da string.

ChannelGroupFilterExpression

Uma expressão lógica de filtros de dimensão de grupo de canais.

Campos
Campo de união expr. A expressão aplicada a um filtro. expr pode ser apenas de um dos tipos a seguir:
and_group

ChannelGroupFilterExpressionList

Uma lista de expressões a serem combinadas com AND. Ele só pode conter ChannelGroupFilterExpressions com or_group. Isso precisa ser definido para o ChannelGroupFilterExpression de nível superior.

or_group

ChannelGroupFilterExpressionList

Uma lista de expressões combinadas com "OR". Não pode conter ChannelGroupFilterExpressions com and_group ou or_group.

not_expression

ChannelGroupFilterExpression

Uma expressão de filtro a ser NOT'ed (ou seja, invertida, complementada). Ele só pode incluir um dimension_or_metric_filter. Não pode ser definido na ChannelGroupFilterExpression de nível superior.

filter

ChannelGroupFilter

Um filtro em uma única dimensão. Não pode ser definido na ChannelGroupFilterExpression de nível superior.

ChannelGroupFilterExpressionList

Uma lista de expressões de filtro de grupo de canais.

Campos
filter_expressions[]

ChannelGroupFilterExpression

Uma lista de expressões de filtro de grupo de canais.

CoarseValue

O valor de conversão aproximado definido na chamada do SDK updatePostbackConversionValue quando as condições de ConversionValues.event_mappings são atendidas. Para mais informações, consulte SKAdNetwork.CoarseConversionValue.

Enums
COARSE_VALUE_UNSPECIFIED Valor aproximado não especificado.
COARSE_VALUE_LOW Valor aproximado de "baixo".
COARSE_VALUE_MEDIUM Valor aproximado da mídia.
COARSE_VALUE_HIGH Valor aproximado de "alto".

ConversionEvent

Um evento de conversão em uma propriedade do Google Analytics.

Campos
name

string

Apenas saída. Nome do recurso deste evento de conversão. Formato: properties/{property}/conversionEvents/{conversion_event}

event_name

string

Imutável. O nome do evento de conversão. Exemplos: "click", "purchase"

create_time

Timestamp

Apenas saída. Horário em que esse evento de conversão foi criado na propriedade.

deletable

bool

Apenas saída. Se definido, este evento poderá ser excluído com DeleteConversionEvent.

custom

bool

Apenas saída. Se definido como "true", esse evento de conversão se refere a um evento personalizado. Se definido como "false", esse evento de conversão se refere a um evento padrão no GA. Os eventos padrão geralmente têm um significado especial no GA e são criados para você pelo sistema do GA, mas, em alguns casos, podem ser criados por administradores da propriedade. Os eventos personalizados contam para o número máximo de eventos de conversão personalizada que podem ser criados por propriedade.

counting_method

ConversionCountingMethod

Opcional. O método pelo qual as conversões serão contadas em vários eventos em uma sessão. Se esse valor não for fornecido, ele será definido como ONCE_PER_EVENT.

default_conversion_value

DefaultConversionValue

Opcional. Define um valor/moeda padrão para um evento de conversão.

ConversionCountingMethod

O método pelo qual as conversões serão contadas em vários eventos em uma sessão.

Enums
CONVERSION_COUNTING_METHOD_UNSPECIFIED O método de contagem não foi especificado.
ONCE_PER_EVENT Cada instância de evento é considerada uma conversão.
ONCE_PER_SESSION Uma instância de evento é considerada uma conversão no máximo uma vez por sessão por usuário.

DefaultConversionValue

Define um valor/moeda padrão para um evento de conversão. É necessário informar o valor e a moeda.

Campos
value

double

Esse valor será usado para preencher todas as conversões do event_name especificado em que o parâmetro "value" do evento não estiver definido.

currency_code

string

Quando um evento de conversão para esse event_name não tem uma moeda definida, essa moeda é aplicada como padrão. Precisa estar no formato de código de moeda ISO 4217. Consulte https://en.wikipedia.org/wiki/ISO_4217 para mais informações.

ConversionValues

Configurações de valor da conversão para uma janela de postback do esquema de valor da conversão da SKAdNetwork.

Campos
display_name

string

Nome de exibição do valor da conversão da SKAdNetwork. O comprimento máximo permitido para o nome de exibição é de 50 unidades de código UTF-16.

coarse_value

CoarseValue

Obrigatório. Um valor de conversão geral.

Não há garantia de que esse valor seja exclusivo.

event_mappings[]

EventMapping

Condições de evento que precisam ser atendidas para que esse valor da conversão seja alcançado. As condições nesta lista são combinadas com o operador AND. Ela precisa ter de uma a três entradas se a janela de postback estiver ativada.

lock_enabled

bool

Se for "true", o SDK vai bloquear esse valor de conversão para o período de postback atual.

fine_value

int32

O valor de conversão refinado. Isso se aplica apenas à primeira janela de postback. Os valores válidos são [0,63], incluindo os dois. Ele precisa ser definido para o intervalo de postback 1 e não pode ser definido para os intervalos 2 e 3. Não há garantia de que esse valor seja exclusivo.

Se a configuração da primeira janela de postback for reutilizada para a segunda ou terceira, esse campo não terá efeito.

CreateAccessBindingRequest

Mensagem de solicitação para o RPC CreateAccessBinding.

Campos
parent

string

Obrigatório. Formatos: - accounts/{account} - properties/{property}

access_binding

AccessBinding

Obrigatório. A vinculação de acesso a ser criada.

CreateAdSenseLinkRequest

Mensagem de solicitação a ser transmitida ao método "CreateAdSenseLink".

Campos
parent

string

Obrigatório. A propriedade para criar uma vinculação do Google AdSense. Formato: properties/{propertyId}. Exemplo: properties/1234

CreateAudienceRequest

Mensagem de solicitação para a RPC CreateAudience.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

audience

Audience

Obrigatório. O público-alvo a ser criado.

CreateBigQueryLinkRequest

Mensagem de solicitação para a RPC CreateBigQueryLink.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

CreateCalculatedMetricRequest

Mensagem de solicitação para a RPC CreateCalculatedMetric.

Campos
parent

string

Obrigatório. Formato: properties/{property_id}. Exemplo: properties/1234

calculated_metric_id

string

Obrigatório. O ID a ser usado na métrica calculada, que se tornará o componente final do nome do recurso da métrica calculada.

Esse valor precisa ter de 1 a 80 caracteres, e os caracteres válidos são /[a-zA-Z0-9_]/, sem espaços. O calculated_metric_id precisa ser exclusivo entre todas as métricas calculadas de uma propriedade. O calculated_metric_id é usado ao referenciar essa métrica calculada de APIs externas, por exemplo, "calcMetric:{calculated_metric_id}".

calculated_metric

CalculatedMetric

Obrigatório. A CalculatedMetric a ser criada.

CreateChannelGroupRequest

Mensagem de solicitação para a RPC CreateChannelGroup.

Campos
parent

string

Obrigatório. A propriedade para criar um ChannelGroup. Exemplo de formato: properties/1234

channel_group

ChannelGroup

Obrigatório. O ChannelGroup a ser criado.

CreateConversionEventRequest

Mensagem de solicitação para o RPC CreateConversionEvent

Campos
conversion_event

ConversionEvent

Obrigatório. O evento de conversão a ser criado.

parent

string

Obrigatório. O nome do recurso da propriedade principal em que esse evento de conversão será criado. Formato: properties/123

CreateCustomDimensionRequest

Mensagem de solicitação para RPC CreateCustomDimension.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

custom_dimension

CustomDimension

Obrigatório. A CustomDimension a ser criada.

CreateCustomMetricRequest

Mensagem de solicitação para o RPC CreateCustomMetric.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

custom_metric

CustomMetric

Obrigatório. A CustomMetric a ser criada.

CreateDataStreamRequest

Mensagem de solicitação para o RPC CreateDataStream.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

data_stream

DataStream

Obrigatório. O DataStream a ser criado.

CreateDisplayVideo360AdvertiserLinkProposalRequest

Mensagem de solicitação para a RPC "CreateDisplayVideo360AdvertiserLinkProposal".

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

CreateDisplayVideo360AdvertiserLinkRequest

Mensagem de solicitação para a RPC CreateDisplayVideo360AdvertiserLink.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

CreateEventCreateRuleRequest

Mensagem de solicitação para o RPC CreateEventCreateRule.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/123/dataStreams/456

event_create_rule

EventCreateRule

Obrigatório. O EventCreateRule a ser criado.

CreateEventEditRuleRequest

Mensagem de solicitação para o RPC CreateEventEditRule.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/123/dataStreams/456

event_edit_rule

EventEditRule

Obrigatório. O EventEditRule a ser criado.

CreateExpandedDataSetRequest

Mensagem de solicitação para a RPC CreateExpandedDataSet.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

expanded_data_set

ExpandedDataSet

Obrigatório. O ExpandedDataSet a ser criado.

CreateFirebaseLinkRequest

Mensagem de solicitação para o RPC CreateFirebaseLink

Campos
parent

string

Obrigatório. Formato: properties/{property_id}

Exemplo: properties/1234

CreateGoogleAdsLinkRequest

Mensagem de solicitação para o RPC CreateGoogleAdsLink

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

CreateKeyEventRequest

Mensagem de solicitação para RPC CreateKeyEvent

Campos
key_event

KeyEvent

Obrigatório. O evento principal a ser criado.

parent

string

Obrigatório. O nome do recurso da propriedade principal em que esse evento principal será criado. Formato: properties/123

CreateMeasurementProtocolSecretRequest

Mensagem de solicitação para o RPC CreateMeasurementProtocolSecret

Campos
parent

string

Obrigatório. O recurso pai em que o secret será criado. Formato: properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

Obrigatório. A chave secreta do Measurement Protocol a ser criada.

CreatePropertyRequest

Mensagem de solicitação para o RPC CreateProperty.

Campos
property

Property

Obrigatório. A propriedade a ser criada. Observação: a propriedade fornecida precisa especificar o elemento pai.

CreateReportingDataAnnotationRequest

Mensagem de solicitação para a RPC CreateReportingDataAnnotation.

Campos
parent

string

Obrigatório. A propriedade para criar uma anotação de dados de relatórios. Formato: properties/property_id. Exemplo: properties/123

reporting_data_annotation

ReportingDataAnnotation

Obrigatório. A anotação de dados de relatórios a ser criada.

CreateRollupPropertyRequest

Mensagem de solicitação para o RPC CreateRollupProperty.

Campos
rollup_property

Property

Obrigatório. A propriedade de visualização completa a ser criada.

source_properties[]

string

Opcional. Os nomes de recursos das propriedades que serão origens da propriedade de visualização completa criada.

CreateRollupPropertyResponse

Mensagem de resposta para o RPC "CreateRollupProperty".

Campos
rollup_property

Property

A propriedade de visualização completa criada.

CreateRollupPropertySourceLinkRequest

Mensagem de solicitação para a RPC CreateRollupPropertySourceLink.

Campos
parent

string

Obrigatório. Formato: properties/{property_id}. Exemplo: properties/1234

CreateSKAdNetworkConversionValueSchemaRequest

Mensagem de solicitação para o RPC CreateSKAdNetworkConversionValueSchema.

Campos
parent

string

Obrigatório. O recurso pai em que esse esquema será criado. Formato: properties/{property}/dataStreams/{dataStream}

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

Obrigatório. Esquema de valor da conversão da SKAdNetwork a ser criado.

CreateSearchAds360LinkRequest

Mensagem de solicitação para a RPC CreateSearchAds360Link.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

CreateSubpropertyEventFilterRequest

Mensagem de solicitação para o RPC CreateSubpropertyEventFilter.

Campos
parent

string

Obrigatório. A propriedade comum para a qual criar um filtro de eventos de subpropriedade. Formato: properties/property_id. Exemplo: properties/123

subproperty_event_filter

SubpropertyEventFilter

Obrigatório. O filtro de eventos da subpropriedade a ser criado.

CustomDimension

Uma definição para um CustomDimension.

Campos
name

string

Apenas saída. Nome do recurso para este recurso "CustomDimension". Formato: properties/{property}/customDimensions/{customDimension}

parameter_name

string

Obrigatório. Imutável. Nome do parâmetro de inclusão de tag para essa dimensão personalizada.

Se for uma dimensão com escopo do usuário, esse será o nome da propriedade do usuário. Se for uma dimensão no escopo do evento, esse será o nome do parâmetro de evento.

Se for uma dimensão no escopo do item, esse será o nome do parâmetro encontrado na matriz de itens de e-commerce.

Pode conter apenas caracteres alfanuméricos e sublinhados, começando com uma letra. Comprimento máximo de 24 caracteres para dimensões no escopo do usuário e 40 caracteres para dimensões no escopo do evento.

display_name

string

Obrigatório. Nome de exibição dessa dimensão personalizada, conforme mostrado na interface do Google Analytics. Comprimento máximo de 82 caracteres, alfanumérico mais espaço e sublinhado começando com uma letra. Os nomes de exibição legados gerados pelo sistema podem conter colchetes, mas as atualizações desse campo nunca vão permitir colchetes.

description

string

Opcional. Descrição para essa dimensão personalizada. No máximo 150 caracteres.

scope

DimensionScope

Obrigatório. Imutável. O escopo dessa dimensão.

disallow_ads_personalization

bool

Opcional. Se definido como "true", define essa dimensão como NPA e a exclui da personalização de anúncios.

No momento, isso só é compatível com dimensões personalizadas no escopo do usuário.

DimensionScope

Valores válidos para o escopo dessa dimensão.

Enums
DIMENSION_SCOPE_UNSPECIFIED Escopo desconhecido ou não especificado.
EVENT Dimensão no escopo de um evento.
USER Dimensão no escopo de um usuário.
ITEM Dimensão no escopo de itens de e-commerce

CustomMetric

Uma definição para uma métrica personalizada.

Campos
name

string

Apenas saída. Nome do recurso para este recurso CustomMetric. Formato: properties/{property}/customMetrics/{customMetric}

parameter_name

string

Obrigatório. Imutável. Nome da tag para essa métrica personalizada.

Se for uma métrica no escopo do evento, este será o nome do parâmetro do evento.

Pode conter apenas caracteres alfanuméricos e sublinhados, começando com uma letra. O comprimento máximo é de 40 caracteres para métricas no escopo do evento.

display_name

string

Obrigatório. Nome de exibição dessa métrica personalizada, conforme mostrado na interface do Google Analytics. Comprimento máximo de 82 caracteres, alfanumérico mais espaço e sublinhado começando com uma letra. Os nomes de exibição legados gerados pelo sistema podem conter colchetes, mas as atualizações desse campo nunca vão permitir colchetes.

description

string

Opcional. Descrição para essa dimensão personalizada. No máximo 150 caracteres.

measurement_unit

MeasurementUnit

Obrigatório. O tipo do valor da métrica personalizada.

scope

MetricScope

Obrigatório. Imutável. O escopo dessa métrica personalizada.

restricted_metric_type[]

RestrictedMetricType

Opcional. Tipos de dados restritos que essa métrica pode conter. Obrigatório para métricas com unidade de medida CURRENCY. Precisa estar vazio para métricas com uma unidade de medida que não seja CURRENCY.

MeasurementUnit

Tipos possíveis de representação do valor da métrica personalizada.

A representação da moeda pode mudar no futuro, exigindo uma mudança importante na API.

Enums
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit não especificado ou ausente.
STANDARD Essa métrica usa unidades padrão.
CURRENCY Essa métrica mede uma moeda.
FEET Essa métrica mede pés.
METERS Essa métrica mede metros.
KILOMETERS Essa métrica mede quilômetros.
MILES Essa métrica mede milhas.
MILLISECONDS Essa métrica mede milissegundos.
SECONDS Essa métrica mede segundos.
MINUTES Essa métrica mede minutos.
HOURS Essa métrica mede horas.

MetricScope

O escopo dessa métrica.

Enums
METRIC_SCOPE_UNSPECIFIED Escopo desconhecido ou não especificado.
EVENT Métrica no escopo de um evento.

RestrictedMetricType

Rótulos que marcam os dados nessa métrica personalizada como dados que devem ser restritos a usuários específicos.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo desconhecido ou não especificado.
COST_DATA Os relatórios de métricas mostram dados de custo.
REVENUE_DATA A métrica informa dados de receita.

DataRedactionSettings

Configurações para edição de dados do lado do cliente. Recurso singleton em um fluxo da Web.

Campos
name

string

Apenas saída. Nome deste recurso de configurações de redação de dados. Formato: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Exemplo: "properties/1000/dataStreams/2000/dataRedactionSettings"

email_redaction_enabled

bool

Se ativada, qualquer parâmetro de evento ou valor de propriedade do usuário que pareça um e-mail será editado.

query_parameter_redaction_enabled

bool

A remoção de informações sensíveis de parâmetros de consulta remove as partes de chave e valor de um parâmetro de consulta se ele estiver no conjunto configurado de parâmetros de consulta.

Se ativada, a lógica de substituição de consultas de URL será executada para o fluxo. Todos os parâmetros de consulta definidos em "query_parameter_keys" serão omitidos.

query_parameter_keys[]

string

As chaves do parâmetro de consulta a que a lógica de redação será aplicada se estiverem presentes no URL. A correspondência de parâmetros de consulta não diferencia maiúsculas de minúsculas.

Precisa conter pelo menos um elemento se "query_parameter_replacement_enabled" for verdadeiro. As chaves não podem conter vírgulas.

DataRetentionSettings

Define valores para retenção de dados. Esse é um recurso singleton.

Campos
name

string

Apenas saída. Nome do recurso DataRetentionSetting. Formato: properties/{property}/dataRetentionSettings

event_data_retention

RetentionDuration

Obrigatório. O período em que os dados no nível do evento são retidos.

user_data_retention

RetentionDuration

Obrigatório. O período em que os dados no nível do usuário são retidos.

reset_user_data_on_new_activity

bool

Se for verdadeiro, o período de retenção do identificador do usuário será redefinido a cada evento dele.

RetentionDuration

Valores válidos para a duração da retenção de dados.

Enums
RETENTION_DURATION_UNSPECIFIED A duração do período de retenção de dados não foi especificada.
TWO_MONTHS O período de retenção de dados é de dois meses.
FOURTEEN_MONTHS O período de retenção de dados é de 14 meses.
TWENTY_SIX_MONTHS O período de retenção de dados é de 26 meses. Disponível apenas para propriedades do 360. Disponível apenas para dados de eventos.
THIRTY_EIGHT_MONTHS O período de retenção de dados é de 38 meses. Disponível apenas para propriedades do 360. Disponível apenas para dados de eventos.
FIFTY_MONTHS O período de retenção de dados é de 50 meses. Disponível apenas para propriedades do 360. Disponível apenas para dados de eventos.

DataSharingSettings

Uma mensagem de recurso que representa as configurações de compartilhamento de dados de uma conta do Google Analytics.

Campos
name

string

Apenas saída. Nome do recurso. Formato: accounts/{account}/dataSharingSettings. Exemplo: "accounts/1000/dataSharingSettings"

sharing_with_google_support_enabled

bool

Permite que os representantes de suporte técnico do Google acessem seus dados e sua conta do Google Analytics, quando necessário, para prestar serviços e encontrar soluções para questões técnicas.

Esse campo é mapeado para o campo "Suporte técnico" na interface do administrador do Google Analytics.

sharing_with_google_assigned_sales_enabled

bool

Permite que o Google acesse os dados da sua conta do Google Analytics, incluindo dados de configuração e uso da conta, gastos com produtos e usuários associados a ela. Assim, o Google pode ajudar você a aproveitar ao máximo os produtos dele, oferecendo insights, ofertas, recomendações e dicas de otimização no Google Analytics e em outros produtos do Google para empresas.

Esse campo é mapeado para o campo "Recomendações para sua empresa" na interface do administrador do Google Analytics.

sharing_with_google_any_sales_enabled
(deprecated)

bool

Obsoleto. Este campo não é mais usado e sempre retorna "false".

sharing_with_google_products_enabled

bool

Permite que o Google use os dados para melhorar outros produtos ou serviços.

Esses campos são mapeados para o campo "Produtos e serviços do Google" na interface de administrador do Google Analytics.

sharing_with_others_enabled

bool

Ative recursos como previsões, dados estimados e comparativos de mercado que oferecem insights mais detalhados sobre negócios quando você contribui com dados agregados de medição. As informações que você compartilha (incluindo detalhes sobre a propriedade de origem) são agregadas e desidentificadas antes de serem usadas para gerar insights de negócios.

Esse campo é mapeado para o campo "Contribuições de estimativas e insights de negócios" na interface do administrador do Google Analytics.

DataStream

Uma mensagem de recurso que representa um fluxo de dados.

Campos
name

string

Apenas saída. Nome do recurso deste fluxo de dados. Formato: properties/{property_id}/dataStreams/{stream_id}. Exemplo: "properties/1000/dataStreams/2000"

type

DataStreamType

Obrigatório. Imutável. O tipo deste recurso DataStream.

display_name

string

Nome de exibição legível para humanos do fluxo de dados.

Obrigatório para fluxos de dados da Web.

O comprimento máximo permitido para o nome de exibição é de 255 unidades de código UTF-16.

create_time

Timestamp

Apenas saída. Hora em que este stream foi criado originalmente.

update_time

Timestamp

Apenas saída. Hora em que os campos de payload do stream foram atualizados pela última vez.

Campo de união stream_data. Dados para tipos específicos de fluxos de dados. A mensagem que será definida corresponde ao tipo desse fluxo. stream_data pode ser apenas de um dos tipos a seguir:
web_stream_data

WebStreamData

Dados específicos para fluxos da Web. Precisa ser preenchido se o tipo for WEB_DATA_STREAM.

android_app_stream_data

AndroidAppStreamData

Dados específicos dos fluxos de apps Android. Precisa ser preenchido se o tipo for ANDROID_APP_DATA_STREAM.

ios_app_stream_data

IosAppStreamData

Dados específicos dos fluxos de apps iOS. Precisa ser preenchido se o tipo for IOS_APP_DATA_STREAM.

AndroidAppStreamData

Dados específicos dos fluxos de apps Android.

Campos
firebase_app_id

string

Apenas saída. ID do app Android correspondente no Firebase, se houver. Esse ID pode mudar se o app Android for excluído e recriado.

package_name

string

Imutável. O nome do pacote do app que está sendo medido. Exemplo: "com.example.myandroidapp"

DataStreamType

O tipo do fluxo de dados.

Enums
DATA_STREAM_TYPE_UNSPECIFIED Tipo desconhecido ou não especificado.
WEB_DATA_STREAM Fluxo de dados da Web.
ANDROID_APP_DATA_STREAM Fluxo de dados do app Android.
IOS_APP_DATA_STREAM Fluxo de dados do app iOS.

IosAppStreamData

Dados específicos dos fluxos de apps iOS.

Campos
firebase_app_id

string

Apenas saída. ID do app iOS correspondente no Firebase, se houver. Esse ID pode mudar se o app iOS for excluído e recriado.

bundle_id

string

Obrigatório. Imutável. O ID do pacote da Apple App Store para o app. Exemplo: "com.example.myiosapp"

WebStreamData

Dados específicos para fluxos da Web.

Campos
measurement_id

string

Apenas saída. ID de métricas do Google Analytics.

Exemplo: "G-1A2BCD345E"

firebase_app_id

string

Apenas saída. ID do app da Web correspondente no Firebase, se houver. Esse ID pode mudar se o web app for excluído e recriado.

default_uri

string

Nome de domínio do web app que está sendo medido ou vazio. Exemplo: "http://www.google.com", "https://www.google.com"

DeleteAccessBindingRequest

Mensagem de solicitação para a RPC DeleteAccessBinding.

Campos
name

string

Obrigatório. Formatos: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

DeleteAccountRequest

Mensagem de solicitação para a RPC DeleteAccount.

Campos
name

string

Obrigatório. O nome da conta a ser excluída de forma reversível. Formato: accounts/{account}. Exemplo: "accounts/100"

DeleteAdSenseLinkRequest

Mensagem de solicitação a ser transmitida ao método "DeleteAdSenseLink".

Campos
name

string

Obrigatório. Identificador exclusivo da vinculação do Google AdSense a ser excluída. Formato: properties/{propertyId}/adSenseLinks/{linkId} Exemplo: properties/1234/adSenseLinks/5678

DeleteBigQueryLinkRequest

Mensagem de solicitação para a RPC DeleteBigQueryLink.

Campos
name

string

Obrigatório. O BigQueryLink a ser excluído. Exemplo de formato: properties/1234/bigQueryLinks/5678

DeleteCalculatedMetricRequest

Mensagem de solicitação para o RPC DeleteCalculatedMetric.

Campos
name

string

Obrigatório. O nome da CalculatedMetric a ser excluída. Formato: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Exemplo: properties/1234/calculatedMetrics/Metric01

DeleteChannelGroupRequest

Mensagem de solicitação para a RPC DeleteChannelGroup.

Campos
name

string

Obrigatório. O ChannelGroup a ser excluído. Exemplo de formato: properties/1234/channelGroups/5678

DeleteConversionEventRequest

Mensagem de solicitação para o RPC DeleteConversionEvent.

Campos
name

string

Obrigatório. O nome do recurso do evento de conversão a ser excluído. Formato: properties/{property}/conversionEvents/{conversion_event}. Exemplo: "properties/123/conversionEvents/456"

DeleteDataStreamRequest

Mensagem de solicitação para o RPC DeleteDataStream.

Campos
name

string

Obrigatório. O nome do DataStream a ser excluído. Exemplo de formato: properties/1234/dataStreams/5678

DeleteDisplayVideo360AdvertiserLinkProposalRequest

Mensagem de solicitação para a RPC DeleteDisplayVideo360AdvertiserLinkProposal.

Campos
name

string

Obrigatório. O nome do "DisplayVideo360AdvertiserLinkProposal" a ser excluído. Exemplo de formato: properties/1234/displayVideo360AdvertiserLinkProposals/5678

DeleteDisplayVideo360AdvertiserLinkRequest

Mensagem de solicitação para a RPC "DeleteDisplayVideo360AdvertiserLink".

Campos
name

string

Obrigatório. O nome do DisplayVideo360AdvertiserLink a ser excluído. Exemplo de formato: properties/1234/displayVideo360AdvertiserLinks/5678

DeleteEventCreateRuleRequest

Mensagem de solicitação para o RPC DeleteEventCreateRule.

Campos
name

string

Obrigatório. Exemplo de formato: properties/123/dataStreams/456/eventCreateRules/789

DeleteEventEditRuleRequest

Mensagem de solicitação para o RPC DeleteEventEditRule.

Campos
name

string

Obrigatório. Exemplo de formato: properties/123/dataStreams/456/eventEditRules/789

DeleteExpandedDataSetRequest

Mensagem de solicitação para a RPC DeleteExpandedDataSet.

Campos
name

string

Obrigatório. Exemplo de formato: properties/1234/expandedDataSets/5678

DeleteFirebaseLinkRequest

Mensagem de solicitação para o RPC DeleteFirebaseLink.

Campos
name

string

Obrigatório. Formato: properties/{property_id}/firebaseLinks/{firebase_link_id}

Exemplo: properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

Mensagem de solicitação para a RPC DeleteGoogleAdsLink.

Campos
name

string

Obrigatório. Exemplo de formato: properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

Mensagem de solicitação para o RPC DeleteKeyEvent.

Campos
name

string

Obrigatório. O nome do recurso do evento principal a ser excluído. Formato: properties/{property}/keyEvents/{key_event} Exemplo: "properties/123/keyEvents/456"

DeleteMeasurementProtocolSecretRequest

Mensagem de solicitação para a RPC DeleteMeasurementProtocolSecret.

Campos
name

string

Obrigatório. O nome do MeasurementProtocolSecret a ser excluído. Formato: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

Mensagem de solicitação para a RPC DeleteProperty.

Campos
name

string

Obrigatório. O nome da propriedade a ser excluída de forma reversível. Formato: properties/{property_id}. Exemplo: "properties/1000"

DeleteReportingDataAnnotationRequest

Mensagem de solicitação para a RPC DeleteReportingDataAnnotation.

Campos
name

string

Obrigatório. Nome do recurso da anotação de dados de relatórios a ser excluída. Formato: properties/property_id/reportingDataAnnotations/reporting_data_annotation Exemplo: properties/123/reportingDataAnnotations/456

DeleteRollupPropertySourceLinkRequest

Mensagem de solicitação para a RPC DeleteRollupPropertySourceLink.

Campos
name

string

Obrigatório. Formato: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Exemplo: properties/1234/rollupPropertySourceLinks/5678

DeleteSKAdNetworkConversionValueSchemaRequest

Mensagem de solicitação para o RPC DeleteSKAdNetworkConversionValueSchema.

Campos
name

string

Obrigatório. O nome do SKAdNetworkConversionValueSchema a ser excluído. Formato: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

DeleteSearchAds360LinkRequest

Mensagem de solicitação para a RPC DeleteSearchAds360Link.

Campos
name

string

Obrigatório. O nome do SearchAds360Link a ser excluído. Exemplo de formato: properties/1234/SearchAds360Links/5678

DeleteSubpropertyEventFilterRequest

Mensagem de solicitação para o RPC DeleteSubpropertyEventFilter.

Campos
name

string

Obrigatório. Nome do recurso do filtro de eventos da subpropriedade a ser excluído. Formato: properties/property_id/subpropertyEventFilters/subproperty_event_filter Exemplo: properties/123/subpropertyEventFilters/456

DisplayVideo360AdvertiserLinkProposal

Uma proposta de vinculação entre uma propriedade do Google Analytics e um anunciante do Display & Video 360.

Uma proposta é convertida em um "DisplayVideo360AdvertiserLink" quando aprovada. Os administradores do Google Analytics aprovam propostas de entrada, enquanto os administradores do Display & Video 360 aprovam propostas de saída.

Campos
name

string

Apenas saída. O nome do recurso para este recurso "DisplayVideo360AdvertiserLinkProposal". Formato: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}

Observação: "proposalId" não é o ID do anunciante do Display & Video 360.

advertiser_id

string

Imutável. O ID do anunciante do Display & Video 360.

advertiser_display_name

string

Apenas saída. O nome de exibição do anunciante do Display & Video. Só é preenchido para propostas originadas no Display & Video 360.

validation_email

string

Somente entrada. Em uma proposta enviada ao Display & Video 360, esse campo precisa ser definido como o endereço de e-mail de um administrador no anunciante de destino. Isso é usado para verificar se o administrador do Google Analytics conhece pelo menos um administrador no anunciante do Display & Video 360. Isso não restringe a aprovação da proposta a um único usuário. Qualquer administrador do anunciante do Display & Video 360 pode aprovar a proposta.

ads_personalization_enabled

BoolValue

Imutável. Ativa recursos de publicidade personalizada com essa integração. Se esse campo não for definido na criação, o padrão será "true".

campaign_data_sharing_enabled

BoolValue

Imutável. Permite a importação de dados de campanha do Display & Video 360. Se esse campo não for definido na criação, o padrão será "true".

cost_data_sharing_enabled

BoolValue

Imutável. Permite a importação de dados de custo do Display & Video 360. Isso só pode ser ativado se "campaign_data_sharing_enabled" estiver ativado. Se esse campo não for definido na criação, o padrão será "true".

EnhancedMeasurementSettings

Recurso singleton em um fluxo de dados da Web, que configura a medição de interações e conteúdo adicionais do site.

Campos
name

string

Apenas saída. Nome do recurso das configurações de medição otimizada. Formato: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings. Exemplo: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

stream_enabled

bool

Indica se as configurações de medição otimizada serão usadas para medir automaticamente as interações e o conteúdo nesse fluxo da Web.

Mudar esse valor não afeta as configurações em si, mas determina se elas são respeitadas.

scrolls_enabled

bool

Se ativado, capture eventos de rolagem sempre que um visitante chegar ao fim de uma página.

outbound_clicks_enabled

bool

Se ativada, capture um evento de clique de saída sempre que um visitante clicar em um link que não direciona para seu domínio.

site_search_enabled

bool

Se ativada, capture um evento de resultados da pesquisa de visualização sempre que um visitante fizer uma pesquisa no site (com base em um parâmetro de consulta).

video_engagement_enabled

bool

Se ativada, capture eventos de reprodução, andamento e conclusão de vídeo quando os visitantes assistirem vídeos incorporados no seu site.

file_downloads_enabled

bool

Se ativada, capture um evento de download de arquivo sempre que alguém clicar em um link que tenha um documento comum, arquivo compactado, aplicativo, vídeo ou extensão de áudio.

page_changes_enabled

bool

Se ativada, capture um evento de visualização de página sempre que o site mudar o estado do histórico de navegação.

form_interactions_enabled

bool

Se ativado, capture um evento de interação com o formulário sempre que um visitante interagir com um formulário no seu site. O padrão é "falso".

search_query_parameter

string

Obrigatório. Parâmetros de consulta de URL a serem interpretados como parâmetros de pesquisa no site. O comprimento máximo é de 1.024 caracteres. Não pode estar vazio.

uri_query_parameter

string

Outros parâmetros de consulta de URL. O comprimento máximo é de 1.024 caracteres.

EventCreateRule

Uma regra de criação de evento define condições que vão acionar a criação de um evento totalmente novo com base nos critérios correspondentes de um evento de origem. Outras mutações dos parâmetros do evento de origem podem ser definidas.

Ao contrário das regras de edição de eventos, as regras de criação de eventos não têm uma ordem definida. Todos serão executados de forma independente.

As regras de edição e criação de eventos não podem ser usadas para modificar um evento criado com uma regra de criação de eventos.

Campos
name

string

Apenas saída. Nome do recurso para este recurso EventCreateRule. Formato: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

destination_event

string

Obrigatório. O nome do novo evento a ser criado.

Esse valor precisa: * ter menos de 40 caracteres * consistir apenas em letras, dígitos ou _ (sublinhados) * começar com uma letra

event_conditions[]

MatchingCondition

Obrigatório. Precisa ter pelo menos uma condição e pode ter até 10. As condições no evento de origem precisam corresponder para que essa regra seja aplicada.

source_copy_parameters

bool

Se for "verdadeiro", os parâmetros de origem serão copiados para o novo evento. Se for "false" ou não estiver definido, todos os parâmetros não internos não serão copiados do evento de origem. As mutações de parâmetro são aplicadas depois que os parâmetros são copiados.

parameter_mutations[]

ParameterMutation

As mutações de parâmetro definem o comportamento do parâmetro no novo evento e são aplicadas em ordem. É possível aplicar no máximo 20 mutações.

EventEditRule

Uma regra de edição de evento define condições que vão acionar a criação de um evento totalmente novo com base nos critérios correspondentes de um evento de origem. Outras mutações dos parâmetros do evento de origem podem ser definidas.

Ao contrário das regras de criação de eventos, as regras de edição de eventos são aplicadas na ordem definida.

As regras de edição de eventos não podem ser usadas para modificar um evento criado com uma regra de criação de eventos.

Campos
name

string

Identificador. Nome do recurso para este recurso EventEditRule. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}

display_name

string

Obrigatório. O nome de exibição desta regra de edição de evento. Máximo de 255 caracteres.

event_conditions[]

MatchingCondition

Obrigatório. As condições do evento de origem precisam corresponder para que essa regra seja aplicada. Precisa ter pelo menos uma condição e pode ter até 10.

parameter_mutations[]

ParameterMutation

Obrigatório. As mutações de parâmetro definem o comportamento do parâmetro no novo evento e são aplicadas em ordem. É possível aplicar no máximo 20 mutações.

processing_order

int64

Apenas saída. O pedido para o qual esta regra será processada. As regras com um valor de pedido menor que esse serão processadas antes, e as regras com um valor de pedido maior serão processadas depois. As novas regras de edição de eventos vão receber um valor de pedido no final do pedido.

Esse valor não se aplica a regras de criação de eventos.

EventMapping

Condições de configuração de evento para corresponder a um evento.

Campos
event_name

string

Obrigatório. Nome do evento do Google Analytics. Ele precisa ser sempre definido. O comprimento máximo permitido para o nome de exibição é de 40 unidades de código UTF-16.

min_event_count

int64

Pelo menos um dos quatro valores mínimos/máximos a seguir precisa ser definido. Os valores definidos serão combinados com um operador AND para qualificar um evento. O número mínimo de vezes que o evento ocorreu. Se não for definido, a contagem mínima de eventos não será verificada.

max_event_count

int64

O número máximo de vezes que o evento ocorreu. Se não for definido, a contagem máxima de eventos não será verificada.

min_event_value

double

A receita mínima gerada devido ao evento. A moeda da receita será definida no nível da propriedade. Se não for definido, o valor mínimo do evento não será verificado.

max_event_value

double

A receita máxima gerada devido ao evento. A moeda da receita será definida no nível da propriedade. Se não for definido, o valor máximo do evento não será verificado.

ExpandedDataSet

Uma mensagem de recurso que representa um ExpandedDataSet.

Campos
name

string

Apenas saída. O nome do recurso para este recurso ExpandedDataSet. Formato: properties/{property_id}/expandedDataSets/{expanded_data_set}

display_name

string

Obrigatório. O nome de exibição do ExpandedDataSet. Máximo de 200 caracteres.

description

string

Opcional. A descrição do ExpandedDataSet. Máximo de 50 caracteres.

dimension_names[]

string

Imutável. A lista de dimensões incluídas no ExpandedDataSet. Consulte as dimensões da API para ver a lista de nomes de dimensões.

metric_names[]

string

Imutável. A lista de métricas incluídas no ExpandedDataSet. Consulte as métricas da API para ver a lista de nomes de dimensões.

dimension_filter_expression

ExpandedDataSetFilterExpression

Imutável. Uma expressão lógica de filtros ExpandedDataSet aplicada à dimensão incluída no ExpandedDataSet. Esse filtro é usado para reduzir o número de linhas e, portanto, a chance de encontrar a linha other.

data_collection_start_time

Timestamp

Apenas saída. Hora em que o conjunto de dados expandido começou (ou vai começar) a coletar dados.

ExpandedDataSetFilter

Um filtro específico para uma única dimensão

Campos
field_name

string

Obrigatório. O nome da dimensão a ser filtrada.

Campo de união one_filter. Um dos filtros acima. one_filter pode ser apenas de um dos tipos a seguir:
string_filter

StringFilter

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.

in_list_filter

InListFilter

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções.

InListFilter

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções.

Campos
values[]

string

Obrigatório. A lista de possíveis valores de string para correspondência. Não pode estar vazio.

case_sensitive

bool

Opcional. Se for "true", a correspondência vai diferenciar maiúsculas de minúsculas. Se for "false", a correspondência não vai diferenciar maiúsculas de minúsculas. Precisa ser verdadeiro.

StringFilter

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.

Campos
match_type

MatchType

Obrigatório. O tipo de correspondência do filtro de string.

value

string

Obrigatório. O valor da string a ser comparado.

case_sensitive

bool

Opcional. Se for "true", a correspondência vai diferenciar maiúsculas de minúsculas. Se for "false", a correspondência não vai diferenciar maiúsculas de minúsculas. Precisa ser verdadeiro quando "match_type" for "EXACT". Precisa ser "false" quando "match_type" for "CONTAINS".

MatchType

O tipo de correspondência do filtro de string.

Enums
MATCH_TYPE_UNSPECIFIED Não especificado
EXACT Correspondência exata do valor da string.
CONTAINS Contém o valor da string.

ExpandedDataSetFilterExpression

Uma expressão lógica de filtros de dimensão EnhancedDataSet.

Campos
Campo de união expr. A expressão aplicada a um filtro. expr pode ser apenas de um dos tipos a seguir:
and_group

ExpandedDataSetFilterExpressionList

Uma lista de expressões a serem combinadas com AND. Ela precisa conter uma ExpandedDataSetFilterExpression com not_expression ou dimension_filter. Isso precisa ser definido para o ExpandedDataSetFilterExpression de nível superior.

not_expression

ExpandedDataSetFilterExpression

Uma expressão de filtro a ser NOT'ed (ou seja, invertida, complementada). Ele precisa incluir um dimension_filter. Isso não pode ser definido na ExpandedDataSetFilterExpression de nível superior.

filter

ExpandedDataSetFilter

Um filtro em uma única dimensão. Isso não pode ser definido na ExpandedDataSetFilterExpression de nível superior.

ExpandedDataSetFilterExpressionList

Uma lista de expressões de filtro "ExpandedDataSet".

Campos
filter_expressions[]

ExpandedDataSetFilterExpression

Uma lista de expressões de filtro "ExpandedDataSet".

GetAccessBindingRequest

Mensagem de solicitação para a RPC GetAccessBinding.

Campos
name

string

Obrigatório. O nome da vinculação de acesso a ser recuperada. Formatos: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

GetAccountRequest

Mensagem de solicitação para a RPC GetAccount.

Campos
name

string

Obrigatório. O nome da conta a ser pesquisada. Formato: accounts/{account}. Exemplo: "accounts/100"

GetAdSenseLinkRequest

Mensagem de solicitação a ser transmitida ao método "GetAdSenseLink".

Campos
name

string

Obrigatório. Identificador exclusivo da vinculação do Google AdSense solicitada. Formato: properties/{propertyId}/adSenseLinks/{linkId} Exemplo: properties/1234/adSenseLinks/5678

GetAttributionSettingsRequest

Mensagem de solicitação para o RPC GetAttributionSettings.

Campos
name

string

Obrigatório. O nome das configurações de atribuição a serem recuperadas. Formato: properties/{property}/attributionSettings

GetAudienceRequest

Mensagem de solicitação para o RPC GetAudience.

Campos
name

string

Obrigatório. O nome do público-alvo a ser recebido. Exemplo de formato: properties/1234/audiences/5678

GetBigQueryLinkRequest

Mensagem de solicitação para a RPC GetBigQueryLink.

Campos
name

string

Obrigatório. O nome da vinculação do BigQuery a ser pesquisada. Formato: properties/{property_id}/bigQueryLinks/{bigquery_link_id}. Exemplo: properties/123/bigQueryLinks/456

GetCalculatedMetricRequest

Mensagem de solicitação para a RPC GetCalculatedMetric.

Campos
name

string

Obrigatório. O nome da CalculatedMetric a ser recebida. Formato: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Exemplo: properties/1234/calculatedMetrics/Metric01

GetChannelGroupRequest

Mensagem de solicitação para o RPC GetChannelGroup.

Campos
name

string

Obrigatório. O ChannelGroup a ser recebido. Exemplo de formato: properties/1234/channelGroups/5678

GetConversionEventRequest

Mensagem de solicitação para o RPC GetConversionEvent

Campos
name

string

Obrigatório. O nome do recurso do evento de conversão a ser recuperado. Formato: properties/{property}/conversionEvents/{conversion_event}. Exemplo: "properties/123/conversionEvents/456"

GetCustomDimensionRequest

Mensagem de solicitação para a RPC GetCustomDimension.

Campos
name

string

Obrigatório. O nome da CustomDimension a ser recebida. Exemplo de formato: properties/1234/customDimensions/5678

GetCustomMetricRequest

Mensagem de solicitação para a RPC GetCustomMetric.

Campos
name

string

Obrigatório. O nome da CustomMetric a ser recebida. Exemplo de formato: properties/1234/customMetrics/5678

GetDataRedactionSettingsRequest

Mensagem de solicitação para o RPC GetDataRedactionSettings.

Campos
name

string

Obrigatório. O nome das configurações a serem pesquisadas. Formato: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Exemplo: "properties/1000/dataStreams/2000/dataRedactionSettings"

GetDataRetentionSettingsRequest

Mensagem de solicitação para a RPC "GetDataRetentionSettings".

Campos
name

string

Obrigatório. O nome das configurações a serem pesquisadas. Formato: properties/{property}/dataRetentionSettings. Exemplo: "properties/1000/dataRetentionSettings"

GetDataSharingSettingsRequest

Mensagem de solicitação para a RPC GetDataSharingSettings.

Campos
name

string

Obrigatório. O nome das configurações a serem pesquisadas. Formato: accounts/{account}/dataSharingSettings

Exemplo: accounts/1000/dataSharingSettings

GetDataStreamRequest

Mensagem de solicitação para a RPC "GetDataStream".

Campos
name

string

Obrigatório. O nome do DataStream a ser recebido. Exemplo de formato: properties/1234/dataStreams/5678

GetDisplayVideo360AdvertiserLinkProposalRequest

Mensagem de solicitação para o RPC GetDisplayVideo360AdvertiserLinkProposal.

Campos
name

string

Obrigatório. O nome do DisplayVideo360AdvertiserLinkProposal a ser recebido. Exemplo de formato: properties/1234/displayVideo360AdvertiserLinkProposals/5678

GetDisplayVideo360AdvertiserLinkRequest

Mensagem de solicitação para a RPC "GetDisplayVideo360AdvertiserLink".

Campos
name

string

Obrigatório. O nome do DisplayVideo360AdvertiserLink a ser recebido. Exemplo de formato: properties/1234/displayVideo360AdvertiserLink/5678

GetEnhancedMeasurementSettingsRequest

Mensagem de solicitação para o RPC GetEnhancedMeasurementSettings.

Campos
name

string

Obrigatório. O nome das configurações a serem pesquisadas. Formato: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Exemplo: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

GetEventCreateRuleRequest

Mensagem de solicitação para o RPC GetEventCreateRule.

Campos
name

string

Obrigatório. O nome do EventCreateRule a ser recebido. Exemplo de formato: properties/123/dataStreams/456/eventCreateRules/789

GetEventEditRuleRequest

Mensagem de solicitação para o RPC GetEventEditRule.

Campos
name

string

Obrigatório. O nome do EventEditRule a ser recebido. Exemplo de formato: properties/123/dataStreams/456/eventEditRules/789

GetExpandedDataSetRequest

Mensagem de solicitação para a RPC GetExpandedDataSet.

Campos
name

string

Obrigatório. O nome do ExpandedDataSet a ser recebido. Exemplo de formato: properties/1234/expandedDataSets/5678

GetGlobalSiteTagRequest

Mensagem de solicitação para o RPC GetGlobalSiteTag.

Campos
name

string

Obrigatório. O nome da tag do site a ser pesquisada. As tags de site são singletons e não têm IDs exclusivos. Formato: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag

Exemplo: properties/123/dataStreams/456/globalSiteTag

GetGoogleSignalsSettingsRequest

Mensagem de solicitação para o RPC GetGoogleSignalsSettings

Campos
name

string

Obrigatório. O nome das configurações do Google Signals a serem recuperadas. Formato: properties/{property}/googleSignalsSettings

GetKeyEventRequest

Mensagem de solicitação para o RPC GetKeyEvent.

Campos
name

string

Obrigatório. O nome do recurso do evento principal a ser recuperado. Formato: properties/{property}/keyEvents/{key_event} Exemplo: "properties/123/keyEvents/456"

GetMeasurementProtocolSecretRequest

Mensagem de solicitação para a RPC GetMeasurementProtocolSecret.

Campos
name

string

Obrigatório. O nome do secret do protocolo de medição a ser pesquisado. Formato: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

Mensagem de solicitação para o RPC GetProperty.

Campos
name

string

Obrigatório. O nome da propriedade a ser pesquisada. Formato: properties/{property_id}. Exemplo: "properties/1000"

GetReportingDataAnnotationRequest

Mensagem de solicitação para a RPC GetReportingDataAnnotation.

Campos
name

string

Obrigatório. Nome do recurso da anotação de dados de relatórios a ser pesquisada. Formato: properties/property_id/reportingDataAnnotations/reportingDataAnnotation Exemplo: properties/123/reportingDataAnnotations/456

GetReportingIdentitySettingsRequest

Mensagem de solicitação para o RPC GetReportingIdentitySettings.

Campos
name

string

Obrigatório. O nome das configurações a serem pesquisadas. Formato: properties/{property}/reportingIdentitySettings. Exemplo: "properties/1000/reportingIdentitySettings"

GetRollupPropertySourceLinkRequest

Mensagem de solicitação para a RPC GetRollupPropertySourceLink.

Campos
name

string

Obrigatório. O nome do link de origem da propriedade de visualização completa a ser pesquisado. Formato: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id}. Exemplo: properties/123/rollupPropertySourceLinks/456

GetSKAdNetworkConversionValueSchemaRequest

Mensagem de solicitação para o RPC GetSKAdNetworkConversionValueSchema.

Campos
name

string

Obrigatório. O nome do recurso do esquema de valor da conversão da SKAdNetwork a ser pesquisado. Formato: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

GetSearchAds360LinkRequest

Mensagem de solicitação para a RPC GetSearchAds360Link.

Campos
name

string

Obrigatório. O nome do SearchAds360Link a ser recebido. Exemplo de formato: properties/1234/SearchAds360Link/5678

GetSubpropertyEventFilterRequest

Mensagem de solicitação para o RPC GetSubpropertyEventFilter.

Campos
name

string

Obrigatório. Nome do recurso do filtro de eventos da subpropriedade a ser pesquisado. Formato: properties/property_id/subpropertyEventFilters/subproperty_event_filter Exemplo: properties/123/subpropertyEventFilters/456

GetSubpropertySyncConfigRequest

Mensagem de solicitação para o RPC GetSubpropertySyncConfig.

Campos
name

string

Obrigatório. Nome do recurso do SubpropertySyncConfig a ser pesquisado. Formato: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Exemplo: properties/1234/subpropertySyncConfigs/5678

GlobalSiteTag

Recurso somente leitura com a tag para enviar dados de um site para um DataStream. Presente apenas para recursos do DataStream da Web.

Campos
name

string

Apenas saída. Nome do recurso para esse recurso GlobalSiteTag. Formato: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Exemplo: "properties/123/dataStreams/456/globalSiteTag"

snippet

string

Imutável. Snippet de código JavaScript a ser colado como o primeiro item na tag "head" de cada página da Web para medir.

GoogleSignalsConsent

Campo de consentimento das configurações do Google Signals.

Enums

GoogleSignalsSettings

Definir valores para os indicadores do Google. Esse é um recurso singleton.

Campos
name

string

Apenas saída. Nome do recurso dessa configuração. Formato: properties/{property_id}/googleSignalsSettings Exemplo: "properties/1000/googleSignalsSettings"

state

GoogleSignalsState

Status dessa configuração.

consent

GoogleSignalsConsent

Apenas saída. Aceitação dos Termos de Serviço.

GoogleSignalsState

Status das configurações dos Indicadores do Google.

Enums
GOOGLE_SIGNALS_STATE_UNSPECIFIED O status do Google Signals é definido como GOOGLE_SIGNALS_STATE_UNSPECIFIED por padrão para representar que o usuário não fez uma escolha explícita.
GOOGLE_SIGNALS_ENABLED Os Indicadores do Google estão ativados.
GOOGLE_SIGNALS_DISABLED Os Indicadores do Google estão desativados.

GroupingRule

As regras que regem como o tráfego é agrupado em um canal.

Campos
display_name

string

Obrigatório. Nome de exibição definido pelo cliente para o canal.

expression

ChannelGroupFilterExpression

Obrigatório. A expressão de filtro que define a regra de agrupamento.

IndustryCategory

A categoria selecionada para essa propriedade, usada para comparativos de mercado do setor.

Enums
INDUSTRY_CATEGORY_UNSPECIFIED Categoria do setor não especificada
AUTOMOTIVE Automóveis
BUSINESS_AND_INDUSTRIAL_MARKETS Mercados comercial e industrial
FINANCE Finanças
HEALTHCARE Saúde
TECHNOLOGY Tecnologia
TRAVEL Viagem
OTHER Outro
ARTS_AND_ENTERTAINMENT Artes e entretenimento
BEAUTY_AND_FITNESS Beleza e bem-estar
BOOKS_AND_LITERATURE Livros e literatura
FOOD_AND_DRINK Alimentos e bebidas
GAMES Jogos
HOBBIES_AND_LEISURE Hobbies e lazer
HOME_AND_GARDEN Casa e jardim
INTERNET_AND_TELECOM Internet e telecomunicações
LAW_AND_GOVERNMENT Legislação e governo
NEWS Notícias
ONLINE_COMMUNITIES Comunidades on-line
PEOPLE_AND_SOCIETY Pessoas e sociedade
PETS_AND_ANIMALS Animais de estimação e outros animais
REAL_ESTATE Imóveis
REFERENCE Referência
SCIENCE Ciência
SPORTS Esportes
JOBS_AND_EDUCATION Empregos e educação
SHOPPING Shopping

Evento de tecla

Um evento principal em uma propriedade do Google Analytics.

Campos
name

string

Apenas saída. Nome do recurso deste evento principal. Formato: properties/{property}/keyEvents/{key_event}

event_name

string

Imutável. O nome do evento principal. Exemplos: "click", "purchase"

create_time

Timestamp

Apenas saída. O horário em que esse evento principal foi criado na propriedade.

deletable

bool

Apenas saída. Se definido como "true", esse evento poderá ser excluído.

custom

bool

Apenas saída. Se for definido como "true", esse evento principal vai se referir a um evento personalizado. Se for definido como "false", esse evento principal vai se referir a um evento padrão no GA. Os eventos padrão geralmente têm um significado especial no GA e são criados para você pelo sistema do GA, mas, em alguns casos, podem ser criados por administradores da propriedade. Os eventos personalizados contam para o número máximo de eventos principais personalizados que podem ser criados por propriedade.

counting_method

CountingMethod

Obrigatório. O método de contagem de eventos principais em vários eventos em uma sessão.

default_value

DefaultValue

Opcional. Define um valor/moeda padrão para um evento principal.

CountingMethod

O método de contagem de eventos principais em vários eventos em uma sessão.

Enums
COUNTING_METHOD_UNSPECIFIED O método de contagem não foi especificado.
ONCE_PER_EVENT Cada instância de evento é considerada um evento principal.
ONCE_PER_SESSION Uma instância de evento é considerada um evento principal no máximo uma vez por sessão e por usuário.

DefaultValue

Define um valor/moeda padrão para um evento principal.

Campos
numeric_value

double

Obrigatório. Isso será usado para preencher o parâmetro "value" em todas as ocorrências desse evento principal (especificado por event_name) em que o parâmetro não estiver definido.

currency_code

string

Obrigatório. Quando uma ocorrência desse evento principal (especificado por event_name) não tem uma moeda definida, essa moeda é aplicada como padrão. Precisa estar no formato de código de moeda ISO 4217.

Consulte https://en.wikipedia.org/wiki/ISO_4217 para mais informações.

LinkProposalInitiatingProduct

Uma indicação de qual produto o usuário iniciou uma proposta de link.

Enums
GOOGLE_ANALYTICS Esta proposta foi criada por um usuário do Google Analytics.
LINKED_PRODUCT Essa proposta foi criada por um usuário de um produto vinculado (não o Google Analytics).

LinkProposalState

O estado de um recurso de proposta de vinculação.

Enums
AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS Essa proposta está aguardando análise de um usuário do Google Analytics. Essa proposta vai expirar automaticamente depois de algum tempo.
AWAITING_REVIEW_FROM_LINKED_PRODUCT Essa proposta está aguardando a revisão de um usuário de um produto vinculado. Essa proposta vai expirar automaticamente depois de algum tempo.
WITHDRAWN Esta proposta foi cancelada por um administrador no produto inicial. Ela será excluída automaticamente depois de um tempo.
DECLINED Esta proposta foi recusada por um administrador no produto de recebimento. Ela será excluída automaticamente depois de um tempo.
EXPIRED Essa proposta expirou devido à falta de resposta de um administrador no produto de recebimento. Ela será excluída automaticamente depois de um tempo.
OBSOLETE Essa proposta ficou obsoleta porque um link foi criado diretamente para o mesmo recurso de produto externo especificado nela. Ela será excluída automaticamente depois de um tempo.

LinkProposalStatusDetails

Informações de status para uma proposta de vinculação.

Campos
requestor_email

string

Apenas saída. O endereço de e-mail do usuário que propôs essa vinculação.

ListAccessBindingsRequest

Mensagem de solicitação para a RPC ListAccessBindings.

Campos
parent

string

Obrigatório. Formatos: - accounts/{account} - properties/{property}

page_size

int32

O número máximo de vinculações de acesso a serem retornadas. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 200 vinculações de acesso serão retornadas. O valor máximo é 500. Valores maiores serão convertidos para 500.

page_token

string

Um token de página recebido de uma chamada ListAccessBindings anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListAccessBindings precisam corresponder à chamada que forneceu o token da página.

ListAccessBindingsResponse

Mensagem de resposta para RPC "ListAccessBindings".

Campos
access_bindings[]

AccessBinding

Lista de AccessBindings. Eles serão ordenados de forma estável, mas em uma ordem arbitrária.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListAccountSummariesRequest

Mensagem de solicitação para a RPC ListAccountSummaries.

Campos
page_size

int32

O número máximo de recursos "AccountSummary" a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListAccountSummaries anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListAccountSummaries precisam corresponder à chamada que forneceu o token da página.

ListAccountSummariesResponse

Mensagem de resposta para a RPC "ListAccountSummaries".

Campos
account_summaries[]

AccountSummary

Resumos de todas as contas a que o autor da chamada tem acesso.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListAccountsRequest

Mensagem de solicitação para a RPC ListAccounts.

Campos
page_size

int32

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListAccounts anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListAccounts precisam corresponder à chamada que forneceu o token da página.

show_deleted

bool

Determina se as contas excluídas de forma reversível (ou seja, "movidas para a lixeira") devem ser incluídas nos resultados. As contas podem ser inspecionadas para determinar se foram excluídas ou não.

ListAccountsResponse

Mensagem de solicitação para a RPC ListAccounts.

Campos
accounts[]

Account

Resultados que estavam acessíveis ao autor da chamada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListAdSenseLinksRequest

Mensagem de solicitação a ser transmitida ao método "ListAdSenseLinks".

Campos
parent

string

Obrigatório. Nome do recurso da propriedade principal. Formato: properties/{propertyId}. Exemplo: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListAdSenseLinks anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListAdSenseLinks precisam corresponder à chamada que forneceu o token da página.

ListAdSenseLinksResponse

Mensagem de resposta para o método "ListAdSenseLinks".

Campos
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListAudiencesRequest

Mensagem de solicitação para a RPC ListAudiences.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListAudiences anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListAudiences precisam corresponder à chamada que forneceu o token da página.

ListAudiencesResponse

Mensagem de resposta para a RPC "ListAudiences".

Campos
audiences[]

Audience

Lista de públicos-alvo.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListBigQueryLinksRequest

Mensagem de solicitação para a RPC "ListBigQueryLinks".

Campos
parent

string

Obrigatório. O nome da propriedade em que as vinculações do BigQuery serão listadas. Formato: properties/{property_id}. Exemplo: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListBigQueryLinks anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListBigQueryLinks precisam corresponder à chamada que forneceu o token da página.

ListBigQueryLinksResponse

Mensagem de resposta para a RPC ListBigQueryLinks.

Campos
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListCalculatedMetricsRequest

Mensagem de solicitação para a RPC ListCalculatedMetrics.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

Opcional. O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Opcional. Um token de página recebido de uma chamada ListCalculatedMetrics anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListCalculatedMetrics precisam corresponder à chamada que forneceu o token da página.

ListCalculatedMetricsResponse

Mensagem de resposta para a RPC "ListCalculatedMetrics".

Campos
calculated_metrics[]

CalculatedMetric

Lista de CalculatedMetrics.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListChannelGroupsRequest

Mensagem de solicitação para a RPC ListChannelGroups.

Campos
parent

string

Obrigatório. A propriedade para listar ChannelGroups. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListChannelGroups anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListChannelGroups precisam corresponder à chamada que forneceu o token da página.

ListChannelGroupsResponse

Mensagem de resposta para a RPC ListChannelGroups.

Campos
channel_groups[]

ChannelGroup

Lista de ChannelGroup. Eles serão ordenados de forma estável, mas em uma ordem arbitrária.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListConversionEventsRequest

Mensagem de solicitação para o RPC ListConversionEvents.

Campos
parent

string

Obrigatório. O nome do recurso da propriedade principal. Exemplo: "properties/123"

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListConversionEvents anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListConversionEvents precisam corresponder à chamada que forneceu o token da página.

ListConversionEventsResponse

Mensagem de resposta para a RPC ListConversionEvents.

Campos
conversion_events[]

ConversionEvent

Os eventos de conversão solicitados

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListCustomDimensionsRequest

Mensagem de solicitação para a RPC ListCustomDimensions.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListCustomDimensions anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListCustomDimensions precisam corresponder à chamada que forneceu o token da página.

ListCustomDimensionsResponse

Mensagem de resposta para a RPC ListCustomDimensions.

Campos
custom_dimensions[]

CustomDimension

Lista de CustomDimensions.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListCustomMetricsRequest

Mensagem de solicitação para a RPC ListCustomMetrics.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListCustomMetrics anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListCustomMetrics precisam corresponder à chamada que forneceu o token da página.

ListCustomMetricsResponse

Mensagem de resposta para a RPC ListCustomMetrics.

Campos
custom_metrics[]

CustomMetric

Lista de CustomMetrics.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListDataStreamsRequest

Mensagem de solicitação para a RPC ListDataStreams.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListDataStreams anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListDataStreams precisam corresponder à chamada que forneceu o token da página.

ListDataStreamsResponse

Mensagem de resposta para a RPC ListDataStreams.

Campos
data_streams[]

DataStream

Lista de DataStreams.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListDisplayVideo360AdvertiserLinkProposalsRequest

Mensagem de solicitação para a RPC "ListDisplayVideo360AdvertiserLinkProposals".

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListDisplayVideo360AdvertiserLinkProposals anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListDisplayVideo360AdvertiserLinkProposals precisam corresponder à chamada que forneceu o token da página.

ListDisplayVideo360AdvertiserLinkProposalsResponse

Mensagem de resposta para a RPC "ListDisplayVideo360AdvertiserLinkProposals".

Campos
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListDisplayVideo360AdvertiserLinksRequest

Mensagem de solicitação para a RPC "ListDisplayVideo360AdvertiserLinks".

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListDisplayVideo360AdvertiserLinks anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListDisplayVideo360AdvertiserLinks precisam corresponder à chamada que forneceu o token da página.

ListDisplayVideo360AdvertiserLinksResponse

Mensagem de resposta para a RPC ListDisplayVideo360AdvertiserLinks.

Campos
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListEventCreateRulesRequest

Mensagem de solicitação para o RPC ListEventCreateRules.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/123/dataStreams/456

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListEventCreateRules anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListEventCreateRules precisam corresponder à chamada que forneceu o token da página.

ListEventCreateRulesResponse

Mensagem de resposta para o RPC ListEventCreateRules.

Campos
event_create_rules[]

EventCreateRule

Lista de EventCreateRules. Eles serão ordenados de forma estável, mas em uma ordem arbitrária.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListEventEditRulesRequest

Mensagem de solicitação para o RPC ListEventEditRules.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/123/dataStreams/456

page_size

int32

Opcional. O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Opcional. Um token de página recebido de uma chamada ListEventEditRules anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListEventEditRules precisam corresponder à chamada que forneceu o token da página.

ListEventEditRulesResponse

Mensagem de resposta para a RPC ListEventEditRules.

Campos
event_edit_rules[]

EventEditRule

Lista de EventEditRules. Eles serão ordenados de forma estável, mas em uma ordem arbitrária.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListExpandedDataSetsRequest

Mensagem de solicitação para a RPC "ListExpandedDataSets".

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListExpandedDataSets anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListExpandedDataSet precisam corresponder à chamada que forneceu o token da página.

ListExpandedDataSetsResponse

Mensagem de resposta para a RPC ListExpandedDataSets.

Campos
expanded_data_sets[]

ExpandedDataSet

Lista de ExpandedDataSet. Eles serão ordenados de forma estável, mas em uma ordem arbitrária.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListFirebaseLinksRequest

Mensagem de solicitação para o RPC ListFirebaseLinks.

Campos
parent

string

Obrigatório. Formato: properties/{property_id}

Exemplo: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListFirebaseLinks anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListFirebaseLinks precisam corresponder à chamada que forneceu o token da página.

ListFirebaseLinksResponse

Mensagem de resposta para a RPC ListFirebaseLinks.

Campos
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes. No momento, o Google Analytics só aceita um FirebaseLink por propriedade, então esse campo nunca será preenchido.

ListGoogleAdsLinksRequest

Mensagem de solicitação para a RPC "ListGoogleAdsLinks".

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListGoogleAdsLinks anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListGoogleAdsLinks precisam corresponder à chamada que forneceu o token da página.

ListGoogleAdsLinksResponse

Mensagem de resposta para a RPC ListGoogleAdsLinks.

Campos
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListKeyEventsRequest

Mensagem de solicitação para RPC ListKeyEvents.

Campos
parent

string

Obrigatório. O nome do recurso da propriedade principal. Exemplo: "properties/123"

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListKeyEvents anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListKeyEvents precisam corresponder à chamada que forneceu o token da página.

ListKeyEventsResponse

Mensagem de resposta para a RPC ListKeyEvents.

Campos
key_events[]

KeyEvent

Os eventos principais solicitados

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListMeasurementProtocolSecretsRequest

Mensagem de solicitação para o RPC ListMeasurementProtocolSecret.

Campos
parent

string

Obrigatório. O nome do recurso da transmissão principal. Formato: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 10 recursos serão retornados. O valor máximo é 10. Valores mais altos serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListMeasurementProtocolSecrets anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListMeasurementProtocolSecrets precisam corresponder à chamada que forneceu o token da página.

ListMeasurementProtocolSecretsResponse

Mensagem de resposta para a RPC "ListMeasurementProtocolSecret".

Campos
measurement_protocol_secrets[]

MeasurementProtocolSecret

Uma lista de secrets para o fluxo principal especificado na solicitação.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListPropertiesRequest

Mensagem de solicitação para a RPC ListProperties.

Campos
filter

string

Obrigatório. Uma expressão para filtrar os resultados da solicitação. Os campos qualificados para filtragem são: parent:(o nome do recurso da conta/propriedade principal), ancestor:(o nome do recurso da conta principal) ou firebase_project:(o ID ou número do projeto do Firebase vinculado). Alguns exemplos de filtros:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
page_size

int32

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListProperties anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListProperties precisam corresponder à chamada que forneceu o token da página.

show_deleted

bool

Se as propriedades excluídas de forma reversível (ou seja, "movidas para a lixeira") devem ser incluídas nos resultados. As propriedades podem ser inspecionadas para determinar se foram excluídas ou não.

ListPropertiesResponse

Mensagem de resposta para o RPC ListProperties.

Campos
properties[]

Property

Resultados que corresponderam aos critérios de filtro e estavam acessíveis ao autor da chamada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListReportingDataAnnotationsRequest

Mensagem de solicitação para a RPC ListReportingDataAnnotation.

Campos
parent

string

Obrigatório. Nome do recurso da propriedade. Formato: properties/property_id. Exemplo: properties/123

filter

string

Opcional. Filtro que restringe quais anotações de dados de relatórios na propriedade mãe são listadas.

Os campos aceitos são:

  • 'name'
  • title
  • description
  • annotation_date
  • annotation_date_range
  • color

Além disso, essa API oferece as seguintes funções auxiliares:

  • annotation_duration() : a duração que esta anotação marca, durations. espera uma representação numérica de segundos seguida por um sufixo s.
  • is_annotation_in_range(start_date, end_date) : se a anotação estiver no intervalo especificado por start_date e end_date. As datas estão no formato ISO-8601, por exemplo, 2031-06-28.

Operações compatíveis:

  • = : igual a
  • != : não é igual a
  • < : menor que
  • > : maior que
  • <= : menor que ou igual a
  • >= : maior que ou igual a
  • : : operador "tem"
  • =~ : correspondência de expressão regular
  • !~ : a expressão regular não corresponde
  • NOT : negação lógica
  • AND: "E" lógico
  • OR : OR lógico

Exemplos:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
page_size

int32

Opcional. O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Opcional. Um token de página recebido de uma chamada ListReportingDataAnnotations anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListReportingDataAnnotations precisam corresponder à chamada que forneceu o token da página.

ListReportingDataAnnotationsResponse

Mensagem de resposta para a RPC ListReportingDataAnnotation.

Campos
reporting_data_annotations[]

ReportingDataAnnotation

Lista de anotações de dados de relatórios.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListRollupPropertySourceLinksRequest

Mensagem de solicitação para o RPC ListRollupPropertySourceLinks.

Campos
parent

string

Obrigatório. O nome da propriedade de visualização completa em que os links de origem serão listados. Formato: properties/{property_id}. Exemplo: properties/1234

page_size

int32

Opcional. O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Opcional. Um token de página recebido de uma chamada ListRollupPropertySourceLinks anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListRollupPropertySourceLinks precisam corresponder à chamada que forneceu o token da página.

ListRollupPropertySourceLinksResponse

Mensagem de resposta para o RPC ListRollupPropertySourceLinks.

Campos
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSKAdNetworkConversionValueSchemasRequest

Mensagem de solicitação para o RPC ListSKAdNetworkConversionValueSchemas.

Campos
parent

string

Obrigatório. O recurso do DataStream para listar esquemas. Formato: properties/{property_id}/dataStreams/{dataStream} Exemplo: properties/1234/dataStreams/5678

page_size

int32

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListSKAdNetworkConversionValueSchemas anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListSKAdNetworkConversionValueSchema precisam corresponder à chamada que forneceu o token da página.

ListSKAdNetworkConversionValueSchemasResponse

Mensagem de resposta para o RPC ListSKAdNetworkConversionValueSchemas

Campos
skadnetwork_conversion_value_schemas[]

SKAdNetworkConversionValueSchema

Lista de SKAdNetworkConversionValueSchemas. Ele terá no máximo um valor.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes. No momento, o Google Analytics aceita apenas um SKAdNetworkConversionValueSchema por dataStream, então isso nunca será preenchido.

ListSearchAds360LinksRequest

Mensagem de solicitação para a RPC "ListSearchAds360Links".

Campos
parent

string

Obrigatório. Exemplo de formato: properties/1234

page_size

int32

O número máximo de recursos a serem retornados. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Um token de página recebido de uma chamada ListSearchAds360Links anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListSearchAds360Links precisam corresponder à chamada que forneceu o token da página.

ListSearchAds360LinksResponse

Mensagem de resposta para a RPC ListSearchAds360Links.

Campos
next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSubpropertyEventFiltersRequest

Mensagem de solicitação para a RPC ListSubpropertyEventFilters.

Campos
parent

string

Obrigatório. Nome do recurso da propriedade comum. Formato: properties/property_id. Exemplo: properties/123

page_size

int32

Opcional. O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Opcional. Um token de página recebido de uma chamada ListSubpropertyEventFilters anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListSubpropertyEventFilters precisam corresponder à chamada que forneceu o token da página.

ListSubpropertyEventFiltersResponse

Mensagem de resposta para o RPC ListSubpropertyEventFilter.

Campos
subproperty_event_filters[]

SubpropertyEventFilter

Lista de filtros de eventos da subpropriedade.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSubpropertySyncConfigsRequest

Mensagem de solicitação para o RPC ListSubpropertySyncConfigs.

Campos
parent

string

Obrigatório. Nome do recurso da propriedade. Formato: properties/property_id. Exemplo: properties/123

page_size

int32

Opcional. O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo que haja mais páginas. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

page_token

string

Opcional. Um token de página recebido de uma chamada ListSubpropertySyncConfig anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para ListSubpropertySyncConfig precisam corresponder à chamada que forneceu o token da página.

ListSubpropertySyncConfigsResponse

Mensagem de resposta para o RPC ListSubpropertySyncConfigs.

Campos
subproperty_sync_configs[]

SubpropertySyncConfig

Lista de recursos SubpropertySyncConfig.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

MatchingCondition

Define uma condição para quando uma regra de edição ou criação de evento se aplica a um evento.

Campos
field

string

Obrigatório. O nome do campo que é comparado na condição. Se "event_name" for especificado, essa condição será aplicada ao nome do evento. Caso contrário, a condição será aplicada a um parâmetro com o nome especificado.

Esse valor não pode conter espaços.

comparison_type

ComparisonType

Obrigatório. O tipo de comparação a ser aplicada ao valor.

value

string

Obrigatório. O valor comparado para esta condição. A implementação de tempo de execução pode realizar coerção de tipo desse valor para avaliar essa condição com base no tipo do valor do parâmetro.

negated

bool

Indica se o resultado da comparação deve ser negado. Por exemplo, se negated for verdadeiro, as comparações "equals" vão funcionar como "not equals".

ComparisonType

Tipo de comparação para condição de correspondência

Enums
COMPARISON_TYPE_UNSPECIFIED Desconhecido
EQUALS Igual a, diferencia maiúsculas de minúsculas
EQUALS_CASE_INSENSITIVE Igual a, sem diferenciação de maiúsculas e minúsculas
CONTAINS Contém, diferencia maiúsculas de minúsculas
CONTAINS_CASE_INSENSITIVE Contém, sem diferenciação de maiúsculas e minúsculas
STARTS_WITH Começa com, diferencia maiúsculas de minúsculas
STARTS_WITH_CASE_INSENSITIVE Começa com, sem diferenciar maiúsculas de minúsculas
ENDS_WITH Termina com, diferencia maiúsculas de minúsculas
ENDS_WITH_CASE_INSENSITIVE Termina com, sem diferenciar maiúsculas e minúsculas
GREATER_THAN Maior que
GREATER_THAN_OR_EQUAL maior ou igual a
LESS_THAN Menor que
LESS_THAN_OR_EQUAL menor ou igual a
REGULAR_EXPRESSION expressão regular. Disponível apenas para fluxos da Web.
REGULAR_EXPRESSION_CASE_INSENSITIVE expressão regular, sem diferenciação de maiúsculas e minúsculas. Disponível apenas para fluxos da Web.

MeasurementProtocolSecret

Um valor secreto usado para enviar hits ao Measurement Protocol.

Campos
name

string

Apenas saída. Nome do recurso deste secret. Esse secret pode ser filho de qualquer tipo de fluxo. Formato: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

Obrigatório. Nome de exibição legível para este secret.

secret_value

string

Apenas saída. O valor secreto do Measurement Protocol. Transmita esse valor para o campo "api_secret" da API Measurement Protocol ao enviar hits para a propriedade mãe dessa chave secreta.

NumericValue

Para representar um número.

Campos
Campo de união one_value. Um valor numérico one_value pode ser apenas um dos seguintes:
int64_value

int64

Número inteiro

double_value

double

Valor duplo

ParameterMutation

Define um parâmetro de evento a ser alterado.

Campos
parameter

string

Obrigatório. O nome do parâmetro a ser alterado. Esse valor precisa: * ter menos de 40 caracteres. * ser exclusivo em todas as mutações na regra; * consistir apenas em letras, dígitos ou _ (sublinhados). Para regras de edição de eventos, o nome também pode ser definido como "event_name" para modificar o event_name no lugar.

parameter_value

string

Obrigatório. A mutação de valor a ser realizada. * Precisa ter menos de 100 caracteres. * Para especificar um valor constante para o parâmetro, use a string do valor. * Para copiar o valor de outro parâmetro, use uma sintaxe como "[[other_parameter]]". Para mais detalhes, consulte este artigo da Central de Ajuda.

PostbackWindow

Configurações de uma janela de postback de conversão da SKAdNetwork.

Campos
conversion_values[]

ConversionValues

A ordenação do campo repetido será usada para priorizar as configurações de valor de conversão. As entradas com índices mais baixos têm maior prioridade. A primeira configuração de valor de conversão avaliada como verdadeira será selecionada. Ele precisa ter pelo menos uma entrada se "enable_postback_window_settings" estiver definido como "true". Ele pode ter no máximo 128 entradas.

postback_window_settings_enabled

bool

Se enable_postback_window_settings for verdadeiro, conversion_values precisará ser preenchido e será usado para determinar quando e como definir o valor de conversão em um dispositivo cliente e exportar o esquema para contas vinculadas do Google Ads. Se for "false", as configurações não serão usadas, mas serão mantidas caso possam ser usadas no futuro. Isso precisa ser sempre verdadeiro para postback_window_one.

Propriedade

Uma mensagem de recurso que representa uma propriedade do Google Analytics.

Campos
name

string

Apenas saída. Nome do recurso dessa propriedade. Formato: properties/{property_id}. Exemplo: "properties/1000"

property_type

PropertyType

Imutável. O tipo de propriedade para este recurso "Property". Ao criar uma propriedade, se o tipo for "PROPERTY_TYPE_UNSPECIFIED", "ORDINARY_PROPERTY" será implícito.

create_time

Timestamp

Apenas saída. Hora em que a entidade foi criada originalmente.

update_time

Timestamp

Apenas saída. Hora em que os campos de payload da entidade foram atualizados pela última vez.

parent

string

Imutável. Nome do recurso do pai lógico desta propriedade.

Observação: a interface de movimentação de propriedades pode ser usada para mudar o pai. Formato: accounts/{account}, properties/{property}. Exemplo: "accounts/100", "properties/101"

display_name

string

Obrigatório. Nome de exibição legível para essa propriedade.

O comprimento máximo permitido do nome de exibição é de 100 unidades de código UTF-16.

industry_category

IndustryCategory

Setor associado a esta propriedade. Exemplo: AUTOMOTIVE, FOOD_AND_DRINK

time_zone

string

Obrigatório. Fuso horário dos relatórios, usado como o limite do dia para os relatórios, seja qual for a origem dos dados. Se o fuso horário seguir o horário de verão, o Google Analytics fará os ajustes automaticamente.

OBSERVAÇÃO: a mudança do fuso horário só afeta dados posteriores, não sendo aplicada de forma retroativa.

Formato: https://www.iana.org/time-zones Exemplo: "America/Los_Angeles"

currency_code

string

O tipo de moeda usado em relatórios que envolvem valores monetários.

Formato: https://en.wikipedia.org/wiki/ISO_4217. Exemplos: "USD", "EUR", "JPY"

service_level

ServiceLevel

Apenas saída. O nível de serviço do Google Analytics que se aplica a essa propriedade.

delete_time

Timestamp

Apenas saída. Se definido, o horário em que essa propriedade foi movida para a lixeira. Se não estiver definido, a propriedade não estará na lixeira.

expire_time

Timestamp

Apenas saída. Se definido, o horário em que essa propriedade na lixeira será excluída permanentemente. Se não estiver definido, a propriedade não estará na lixeira e não será excluída.

account

string

Imutável. O nome do recurso da conta principal. Formato: accounts/{account_id}. Exemplo: "accounts/123"

PropertySummary

Um recurso virtual que representa metadados de uma propriedade do Google Analytics.

Campos
property

string

Nome do recurso da propriedade referenciada por este resumo de propriedade. Formato: properties/{property_id}. Exemplo: "properties/1000"

display_name

string

Nome de exibição da propriedade referida neste resumo.

property_type

PropertyType

O tipo de propriedade da propriedade.

parent

string

Nome do recurso do pai lógico desta propriedade.

Observação: a interface de movimentação de propriedades pode ser usada para mudar o pai. Formato: accounts/{account}, properties/{property}. Exemplo: "accounts/100", "properties/200"

PropertyType

Tipos de recursos do Property.

Enums
PROPERTY_TYPE_UNSPECIFIED Tipo de propriedade desconhecido ou não especificado
PROPERTY_TYPE_ORDINARY Propriedade comum do Google Analytics
PROPERTY_TYPE_SUBPROPERTY Subpropriedade do Google Analytics
PROPERTY_TYPE_ROLLUP Propriedade de visualização completa do Google Analytics

ProvisionAccountTicketRequest

Mensagem de solicitação para o RPC ProvisionAccountTicket.

Campos
account

Account

A conta a ser criada.

redirect_uri

string

URI de redirecionamento para o qual o usuário será encaminhado depois de aceitar os Termos de Serviço. Precisa ser configurado no console do Cloud como um URI de redirecionamento.

ProvisionAccountTicketResponse

Mensagem de resposta para a RPC ProvisionAccountTicket.

Campos
account_ticket_id

string

O parâmetro a ser transmitido no link dos Termos de Serviço.

ProvisionSubpropertyRequest

Mensagem de solicitação para o RPC CreateSubproperty.

Campos
subproperty

Property

Obrigatório. A subpropriedade a ser criada.

subproperty_event_filter

SubpropertyEventFilter

Opcional. O filtro de eventos da subpropriedade a ser criado em uma propriedade comum.

custom_dimension_and_metric_synchronization_mode

SynchronizationMode

Opcional. O modo de sincronização de recursos da subpropriedade para dimensões e métricas personalizadas

ProvisionSubpropertyResponse

Mensagem da resposta para o RPC ProvisionSubproperty.

Campos
subproperty

Property

A subpropriedade criada.

subproperty_event_filter

SubpropertyEventFilter

O filtro de eventos da subpropriedade criada.

ReorderEventEditRulesRequest

Mensagem de solicitação para o RPC ReorderEventEditRules.

Campos
parent

string

Obrigatório. Exemplo de formato: properties/123/dataStreams/456

event_edit_rules[]

string

Obrigatório. Nomes de recursos EventEditRule para o fluxo de dados especificado, na ordem de processamento necessária. Todas as EventEditRules do stream precisam estar presentes na lista.

ReportingDataAnnotation

Uma anotação de dados de relatórios é um comentário conectado a determinadas datas para dados de relatórios.

Campos
name

string

Obrigatório. Identificador. Nome do recurso desta anotação de dados de relatórios. Formato: "properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}" Formato: "properties/123/reportingDataAnnotations/456"

title

string

Obrigatório. Título legível para humanos desta anotação de dados de relatórios.

description

string

Opcional. Descrição para esta anotação de dados de relatórios.

color

Color

Obrigatório. A cor usada para mostrar essa anotação de dados de relatórios.

system_generated

bool

Apenas saída. Se for "true", essa anotação foi gerada pelo sistema do Google Analytics. Não é possível atualizar ou excluir anotações geradas pelo sistema.

Campo de união target. O destino desta anotação de dados de relatórios target pode ser apenas um dos seguintes:
annotation_date

Date

Se definido, a anotação de dados de relatórios será para uma data específica representada por esse campo. A data precisa ser válida e ter ano, mês e dia definidos. A data pode estar no passado, presente ou futuro.

annotation_date_range

DateRange

Se definido, a anotação de dados de relatórios será para um período representado por este campo.

Cor

Cores que podem ser usadas para essa anotação de dados de relatórios

Enums
COLOR_UNSPECIFIED Cor desconhecida ou não especificada.
PURPLE Cor roxa.
BROWN Cor marrom.
BLUE Cor azul.
GREEN Cor verde.
RED Cor vermelha.
CYAN Cor ciano.
ORANGE Cor laranja. (Usado apenas para anotações geradas pelo sistema)

DateRange

Representa o período de uma anotação de dados de relatórios. As datas de início e término estão incluídas. Os fusos horários são baseados na propriedade principal.

Campos
start_date

Date

Obrigatório. A data de início desse período. Precisa ser uma data válida com ano, mês e dia definidos. A data pode estar no passado, presente ou futuro.

end_date

Date

Obrigatório. A data de término desse intervalo. Precisa ser uma data válida com ano, mês e dia definidos. Essa data precisa ser maior ou igual à data de início.

ReportingIdentitySettings

Um recurso que contém configurações relacionadas à identidade de relatórios.

Campos
name

string

Apenas saída. Identificador. Nome do recurso singleton das configurações de identidade de relatórios. Formato: properties/{property_id}/reportingIdentitySettings Exemplo: "properties/1234/reportingIdentitySettings"

reporting_identity

ReportingIdentity

A estratégia usada para identificar identidades de usuários em relatórios.

ReportingIdentity

Várias estratégias para identificar identidades de usuários em relatórios.

Enums
IDENTITY_BLENDING_STRATEGY_UNSPECIFIED Estratégia de combinação não especificada.
BLENDED Estratégia de identidade de relatório combinada.
OBSERVED Estratégia de identidade do relatório observada.
DEVICE_BASED Estratégia de identidade do relatório com base no dispositivo.

RunAccessReportRequest

A solicitação de um relatório de registro de acesso a dados.

Campos
entity

string

O Relatório de acesso aos dados permite solicitações no nível da propriedade ou da conta. Se solicitado no nível da conta, os relatórios de acesso aos dados incluem todos os acessos de todas as propriedades nessa conta.

Para fazer uma solicitação no nível da propriedade, a entidade precisa ser, por exemplo, "properties/123" se "123" for o ID da sua propriedade do Google Analytics. Para fazer uma solicitação no nível da conta, a entidade precisa ser, por exemplo, "accounts/1234" se "1234" for o ID da sua conta do Google Analytics.

dimensions[]

AccessDimension

As dimensões solicitadas e mostradas na resposta. As solicitações podem ter até nove dimensões.

metrics[]

AccessMetric

As métricas solicitadas e mostradas na resposta. As solicitações podem ter até 10 métricas.

date_ranges[]

AccessDateRange

Períodos dos registros de acesso a serem lidos. Se vários períodos forem solicitados, cada linha de resposta vai conter um índice de período com base zero. Se dois períodos se sobrepuserem, os registros de acesso dos dias em comum serão incluídos nas linhas de resposta dos dois períodos. São permitidos até dois períodos.

dimension_filter

AccessFilterExpression

Com os filtros de dimensão, é possível restringir a resposta do relatório a valores de dimensão específicos que correspondem ao filtro. Por exemplo, filtrar registros de acesso de um único usuário. Para saber mais, consulte Fundamentos dos filtros de dimensão e confira exemplos. Não é possível usar métricas nesse filtro.

metric_filter

AccessFilterExpression

Com os filtros de métricas, é possível restringir a resposta do relatório a valores de métricas específicos que correspondem ao filtro. Os filtros de métrica são aplicados depois de agregar as linhas do relatório, semelhante à cláusula HAVING do SQL. Não é possível usar dimensões nesse filtro.

offset

int64

A contagem de linhas da linha inicial. A primeira linha é contada como linha 0. Se o deslocamento não for especificado, ele será tratado como 0. Se o deslocamento for zero, esse método vai retornar a primeira página de resultados com entradas limit.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.

limit

int64

O número de linhas que serão retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 100.000 linhas por solicitação, não importa quantas você peça. limit precisa ser positivo.

A API pode retornar menos linhas do que o limit solicitado se não houver tantas linhas restantes quanto o limit. Por exemplo, há menos de 300 valores possíveis para a dimensão country. Portanto, ao gerar relatórios apenas sobre country, não é possível ter mais de 300 linhas, mesmo que você defina limit com um valor maior.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.

time_zone

string

O fuso horário desta solicitação, se especificado. Se não for especificado, o fuso horário da propriedade será usado. O fuso horário da solicitação é usado para interpretar as datas de início e término do relatório.

Formatado como strings do banco de dados de fusos horários da IANA (https://www.iana.org/time-zones). Por exemplo, "America/New_York" ou "Asia/Tokyo".

order_bys[]

AccessOrderBy

Especifica como as linhas são ordenadas na resposta.

return_entity_quota

bool

Alterna se o estado atual da cota da propriedade do Google Analytics será retornado. A cota é retornada em AccessQuota. Para solicitações no nível da conta, esse campo precisa ser "false".

include_all_users

bool

Opcional. Determina se os usuários que nunca fizeram uma chamada de API devem ser incluídos na resposta. Se for "true", todos os usuários com acesso à propriedade ou conta especificada serão incluídos na resposta, tenham feito uma chamada de API ou não. Se for "false", apenas os usuários que fizeram uma chamada de API serão incluídos.

expand_groups

bool

Opcional. Decide se os usuários nos grupos de usuários serão retornados. Esse campo só funciona quando "include_all_users" está definido como "true". Se for "true", vai retornar todos os usuários com acesso à propriedade ou conta especificada. Se for "false", apenas os usuários com acesso direto serão retornados.

RunAccessReportResponse

A resposta personalizada do relatório de registro de acesso aos dados.

Campos
dimension_headers[]

AccessDimensionHeader

O cabeçalho de uma coluna no relatório que corresponde a uma dimensão específica. O número de DimensionHeaders e a ordenação deles correspondem às dimensões presentes nas linhas.

metric_headers[]

AccessMetricHeader

O cabeçalho de uma coluna no relatório que corresponde a uma métrica específica. O número de MetricHeaders e a ordenação deles correspondem às métricas presentes nas linhas.

rows[]

AccessRow

Linhas de combinações de valores de dimensão e valores de métrica no relatório.

row_count

int32

O número total de linhas no resultado da consulta. rowCount é independente do número de linhas retornadas na resposta, do parâmetro de solicitação limit e do parâmetro de solicitação offset. Por exemplo, se uma consulta retornar 175 linhas e incluir limit de 50 na solicitação de API, a resposta vai conter rowCount de 175, mas apenas 50 linhas.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.

quota

AccessQuota

O estado da cota para essa propriedade do Google Analytics, incluindo esta solicitação. Esse campo não funciona com solicitações no nível da conta.

SKAdNetworkConversionValueSchema

Esquema de valor da conversão da SKAdNetwork de um fluxo do iOS.

Campos
name

string

Apenas saída. Nome do recurso do esquema. Ele será filho APENAS de um stream do iOS, e pode haver no máximo um filho desse tipo em um stream do iOS. Formato: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema

postback_window_one

PostbackWindow

Obrigatório. As configurações de valor da conversão para a primeira janela de postback. Eles diferem dos valores para a janela de postback 2 e 3 porque contêm um valor de conversão refinado (um valor numérico).

Os valores de conversão para essa janela de postback precisam ser definidos. As outras janelas são opcionais e podem herdar as configurações desta janela se não estiverem definidas ou desativadas.

postback_window_two

PostbackWindow

As configurações de valor da conversão para a segunda janela de postback.

Esse campo só deve ser configurado se houver necessidade de definir valores de conversão diferentes para essa janela de postback.

Se enable_postback_window_settings for definido como "false" para essa janela de postback, os valores de postback_window_one serão usados.

postback_window_three

PostbackWindow

As configurações de valor da conversão para a terceira janela de postback.

Esse campo só deve ser definido se o usuário escolher definir valores de conversão diferentes para essa janela de postback. É permitido configurar a janela 3 sem definir a janela 2. Se as configurações das janelas 1 e 2 estiverem definidas e enable_postback_window_settings para essa janela de postback estiver definido como "false", o esquema vai herdar as configurações de postback_window_two.

apply_conversion_values

bool

Se ativado, o SDK do GA vai definir valores de conversão usando essa definição de esquema, e o esquema será exportado para todas as contas do Google Ads vinculadas a essa propriedade. Se desativado, o SDK do GA não vai definir automaticamente os valores de conversão, e o esquema não será exportado para o Google Ads.

SearchChangeHistoryEventsRequest

Mensagem de solicitação para a RPC SearchChangeHistoryEvents.

Campos
account

string

Obrigatório. O recurso da conta para o qual retornar recursos do histórico de alterações. Formato: accounts/{account}

Exemplo: accounts/100

property

string

Opcional. Nome do recurso de uma propriedade secundária. Se definido, retorna apenas as mudanças feitas nessa propriedade ou nos recursos filhos dela. Formato: properties/{propertyId}

Exemplo: properties/100

resource_type[]

ChangeHistoryResourceType

Opcional. Se definido, retorna apenas as mudanças de um recurso que corresponda a pelo menos um desses tipos.

action[]

ActionType

Opcional. Se definido, retorna apenas as mudanças que correspondem a um ou mais desses tipos de ações.

actor_email[]

string

Opcional. Se definido, retorna apenas as mudanças feitas por um usuário nesta lista.

earliest_change_time

Timestamp

Opcional. Se definido, retorna apenas as mudanças feitas após esse horário (inclusive).

latest_change_time

Timestamp

Opcional. Se definido, retorna apenas as mudanças feitas antes desse horário (incluindo esse valor).

page_size

int32

Opcional. O número máximo de itens ChangeHistoryEvent a serem retornados. Se não for especificado, no máximo 50 itens serão retornados. O valor máximo é 200. Valores maiores serão convertidos para o máximo.

O serviço pode retornar uma página com menos itens do que esse valor especifica (até mesmo zero), e ainda pode haver outras páginas. Se você quiser um número específico de itens, continue solicitando páginas adicionais usando page_token até receber a quantidade necessária.

page_token

string

Opcional. Um token de página recebido de uma chamada SearchChangeHistoryEvents anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para SearchChangeHistoryEvents precisam corresponder à chamada que forneceu o token da página.

SearchChangeHistoryEventsResponse

Mensagem de resposta para a RPC SearchAccounts.

Campos
change_history_events[]

ChangeHistoryEvent

Resultados que estavam acessíveis ao autor da chamada.

next_page_token

string

Um token, que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ServiceLevel

Vários níveis de serviço para o Google Analytics.

Enums
SERVICE_LEVEL_UNSPECIFIED O nível de serviço não foi especificado ou é inválido.
GOOGLE_ANALYTICS_STANDARD A versão padrão do Google Analytics.
GOOGLE_ANALYTICS_360 A versão paga e premium do Google Analytics.

SubmitUserDeletionRequest

Mensagem de solicitação para o RPC SubmitUserDeletion.

Campos
name

string

Obrigatório. O nome da propriedade para enviar a exclusão do usuário.

Campo de união user. O usuário que envia uma solicitação de exclusão para user pode ser apenas um dos seguintes:
user_id

string

User-ID do Google Analytics.

client_id

string

ID do cliente do Google Analytics.

app_instance_id

string

ID da instância do aplicativo do Firebase.

user_provided_data

string

Dados fornecidos pelo usuário. Pode conter um endereço de e-mail ou um número de telefone.

Os endereços de e-mail precisam ser normalizados da seguinte forma:

  • Letras minúsculas
  • Remover pontos antes de @ nos endereços gmail.com/googlemail.com
  • Remoção de todos os espaços

Os números de telefone precisam ser normalizados da seguinte forma:

  • Remoção de todos os caracteres não alfanuméricos
  • adicionar + prefixo

SubmitUserDeletionResponse

Mensagem de resposta para o RPC "SubmitUserDeletion".

Campos
deletion_request_time

Timestamp

Marca o momento em que todos os dados de visitantes anteriores a esse ponto devem ser excluídos. Definido como o horário em que a solicitação de exclusão foi recebida.

SubpropertyEventFilter

Uma mensagem de recurso que representa um filtro de eventos de subpropriedade do Google Analytics.

Campos
name

string

Apenas saída. Formato: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Exemplo: properties/1234/subpropertyEventFilters/5678

filter_clauses[]

SubpropertyEventFilterClause

Obrigatório. Lista não ordenada. Cláusulas de filtro que definem o SubpropertyEventFilter. Todas as cláusulas são combinadas com "AND" para determinar quais dados são enviados à subpropriedade.

apply_to_property

string

Imutável. Nome do recurso da subpropriedade que usa este filtro.

SubpropertyEventFilterClause

Uma cláusula para definir um filtro. Um filtro pode ser inclusivo (eventos que atendem à cláusula de filtro são incluídos nos dados da subpropriedade) ou exclusivo (eventos que atendem à cláusula de filtro são excluídos dos dados da subpropriedade).

Campos
filter_clause_type

FilterClauseType

Obrigatório. O tipo da cláusula de filtro.

filter_expression

SubpropertyEventFilterExpression

Obrigatório. A expressão lógica para quais eventos são enviados à subpropriedade.

FilterClauseType

Especifica se esta é uma cláusula de filtro de inclusão ou exclusão.

Enums
FILTER_CLAUSE_TYPE_UNSPECIFIED Tipo de cláusula de filtro desconhecido ou não especificado.
INCLUDE Os eventos serão incluídos na subpropriedade se a cláusula de filtro for atendida.
EXCLUDE Os eventos serão excluídos da subpropriedade se a cláusula de filtro for atendida.

SubpropertyEventFilterCondition

Uma expressão de filtro específica

Campos
field_name

string

Obrigatório. O campo que está sendo filtrado.

Campo de união one_filter.

one_filter pode ser apenas de um dos tipos a seguir:

null_filter

bool

Um filtro para valores nulos.

string_filter

StringFilter

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.

StringFilter

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.

Campos
match_type

MatchType

Obrigatório. O tipo de correspondência do filtro de string.

value

string

Obrigatório. O valor de string usado para a correspondência.

case_sensitive

bool

Opcional. Se for "true", o valor da string vai diferenciar maiúsculas de minúsculas. Se for "false", a correspondência não vai diferenciar maiúsculas de minúsculas.

MatchType

Como o filtro será usado para determinar uma correspondência.

Enums
MATCH_TYPE_UNSPECIFIED Tipo de correspondência desconhecido ou não especificado.
EXACT Correspondência exata do valor da string.
BEGINS_WITH Começa com o valor da string.
ENDS_WITH Termina com o valor da string.
CONTAINS Contém o valor da string.
FULL_REGEXP A expressão regular completa corresponde ao valor da string.
PARTIAL_REGEXP Correspondências parciais de expressões regulares com o valor da string.

SubpropertyEventFilterExpression

Uma expressão lógica de filtros de eventos da subpropriedade.

Campos
Campo de união expr. A expressão aplicada a um filtro. expr pode ser apenas de um dos tipos a seguir:
or_group

SubpropertyEventFilterExpressionList

Uma lista de expressões combinadas com "OR". Precisa conter apenas expressões "not_expression" ou "filter_condition".

not_expression

SubpropertyEventFilterExpression

Uma expressão de filtro a ser NOT'ed (invertida, complementada). Ele só pode incluir um filtro. Não é possível definir isso na SubpropertyEventFilterExpression de nível superior.

filter_condition

SubpropertyEventFilterCondition

Cria um filtro que corresponde a um evento específico. Não é possível definir isso na SubpropertyEventFilterExpression de nível superior.

SubpropertyEventFilterExpressionList

Uma lista de expressões de filtro de eventos da subpropriedade.

Campos
filter_expressions[]

SubpropertyEventFilterExpression

Obrigatório. Lista não ordenada. Uma lista de expressões de filtro de eventos da subpropriedade

SubpropertySyncConfig

A configuração de sincronização de subpropriedade controla como as configurações de propriedade comum são sincronizadas com as subpropriedades. Esse recurso é provisionado automaticamente para cada subpropriedade.

Campos
name

string

Apenas saída. Identificador. Formato: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Exemplo: properties/1234/subpropertySyncConfigs/5678

apply_to_property

string

Apenas saída. Imutável. Nome do recurso da subpropriedade a que essas configurações se aplicam.

custom_dimension_and_metric_sync_mode

SynchronizationMode

Obrigatório. Especifica o modo de sincronização de dimensão / métrica personalizada para a subpropriedade.

Se definido como "ALL", a sincronização de dimensões / métricas personalizadas será ativada imediatamente. A configuração local de dimensões / métricas personalizadas não será permitida na subpropriedade enquanto o modo de sincronização estiver definido como "ALL".

Se definido como "NONE", a sincronização de dimensões / métricas personalizadas será desativada. As dimensões e métricas personalizadas precisam ser configuradas explicitamente na subpropriedade.

SynchronizationMode

Modos de sincronização para uma subpropriedade

Enums
SYNCHRONIZATION_MODE_UNSPECIFIED Modo de sincronização desconhecido ou não especificado.
NONE As entidades não são sincronizadas. Edições locais são permitidas na subpropriedade.
ALL As entidades são sincronizadas da propriedade mãe. Não são permitidas mutações locais na subpropriedade (criar / atualizar / excluir)

UpdateAccessBindingRequest

Mensagem de solicitação para o RPC UpdateAccessBinding.

Campos
access_binding

AccessBinding

Obrigatório. A vinculação de acesso a ser atualizada.

UpdateAccountRequest

Mensagem de solicitação para a RPC UpdateAccount.

Campos
account

Account

Obrigatório. A conta a ser atualizada. O campo name da conta é usado para identificar a conta.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes de campo precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateAttributionSettingsRequest

Mensagem de solicitação para o RPC UpdateAttributionSettings.

Campos
attribution_settings

AttributionSettings

Obrigatório. As configurações de atribuição a serem atualizadas. O campo name é usado para identificar as configurações a serem atualizadas.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateAudienceRequest

Mensagem de solicitação para a RPC UpdateAudience.

Campos
audience

Audience

Obrigatório. O público-alvo a ser atualizado. O campo name do público-alvo é usado para identificar o público-alvo a ser atualizado.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateBigQueryLinkRequest

Mensagem de solicitação para a RPC UpdateBigQueryLink.

Campos
update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateCalculatedMetricRequest

Mensagem de solicitação para a RPC UpdateCalculatedMetric.

Campos
calculated_metric

CalculatedMetric

Obrigatório. O CalculatedMetric a ser atualizado

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateChannelGroupRequest

Mensagem de solicitação para a RPC UpdateChannelGroup.

Campos
channel_group

ChannelGroup

Obrigatório. O ChannelGroup a ser atualizado. O campo name do recurso é usado para identificar o ChannelGroup a ser atualizado.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateConversionEventRequest

Mensagem de solicitação para o RPC UpdateConversionEvent.

Campos
conversion_event

ConversionEvent

Obrigatório. O evento de conversão a ser atualizado. O campo name é usado para identificar as configurações a serem atualizadas.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateCustomDimensionRequest

Mensagem de solicitação para a RPC UpdateCustomDimension.

Campos
custom_dimension

CustomDimension

O CustomDimension a ser atualizado

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateCustomMetricRequest

Mensagem de solicitação para a RPC UpdateCustomMetric.

Campos
custom_metric

CustomMetric

O CustomMetric a ser atualizado

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateDataRedactionSettingsRequest

Mensagem de solicitação para a RPC UpdateDataRedactionSettings.

Campos
data_redaction_settings

DataRedactionSettings

Obrigatório. As configurações a serem atualizadas. O campo name é usado para identificar as configurações a serem atualizadas.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateDataRetentionSettingsRequest

Mensagem de solicitação para o RPC UpdateDataRetentionSettings.

Campos
data_retention_settings

DataRetentionSettings

Obrigatório. As configurações a serem atualizadas. O campo name é usado para identificar as configurações a serem atualizadas.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateDataStreamRequest

Mensagem de solicitação para a RPC UpdateDataStream.

Campos
data_stream

DataStream

O DataStream a ser atualizado

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateDisplayVideo360AdvertiserLinkRequest

Mensagem de solicitação para a RPC UpdateDisplayVideo360AdvertiserLink.

Campos
update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateEnhancedMeasurementSettingsRequest

Mensagem de solicitação para o RPC UpdateEnhancedMeasurementSettings.

Campos
enhanced_measurement_settings

EnhancedMeasurementSettings

Obrigatório. As configurações a serem atualizadas. O campo name é usado para identificar as configurações a serem atualizadas.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateEventCreateRuleRequest

Mensagem de solicitação para a RPC UpdateEventCreateRule.

Campos
event_create_rule

EventCreateRule

Obrigatório. O EventCreateRule a ser atualizado. O campo name do recurso é usado para identificar o EventCreateRule a ser atualizado.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateEventEditRuleRequest

Mensagem de solicitação para o RPC UpdateEventEditRule.

Campos
event_edit_rule

EventEditRule

Obrigatório. O EventEditRule a ser atualizado. O campo name do recurso é usado para identificar o EventEditRule a ser atualizado.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateExpandedDataSetRequest

Mensagem de solicitação para a RPC UpdateExpandedDataSet.

Campos
expanded_data_set

ExpandedDataSet

Obrigatório. O ExpandedDataSet a ser atualizado. O campo name do recurso é usado para identificar o ExpandedDataSet a ser atualizado.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateGoogleAdsLinkRequest

Mensagem de solicitação para a RPC UpdateGoogleAdsLink.

Campos
update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateGoogleSignalsSettingsRequest

Mensagem de solicitação para o RPC UpdateGoogleSignalsSettings

Campos
google_signals_settings

GoogleSignalsSettings

Obrigatório. As configurações a serem atualizadas. O campo name é usado para identificar as configurações a serem atualizadas.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateKeyEventRequest

Mensagem de solicitação para RPC UpdateKeyEvent

Campos
key_event

KeyEvent

Obrigatório. O evento principal a ser atualizado. O campo name é usado para identificar as configurações a serem atualizadas.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateMeasurementProtocolSecretRequest

Mensagem de solicitação para a RPC UpdateMeasurementProtocolSecret.

Campos
measurement_protocol_secret

MeasurementProtocolSecret

Obrigatório. A chave secreta do Measurement Protocol a ser atualizada.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os campos omitidos não serão atualizados.

UpdatePropertyRequest

Mensagem de solicitação para o RPC UpdateProperty.

Campos
property

Property

Obrigatório. A propriedade a ser atualizada. O campo name da propriedade é usado para identificar a propriedade a ser atualizada.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os nomes dos campos precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateReportingDataAnnotationRequest

Mensagem de solicitação para a RPC UpdateReportingDataAnnotation.

Campos
reporting_data_annotation

ReportingDataAnnotation

Obrigatório. A anotação de dados de relatórios a ser atualizada.

update_mask

FieldMask

Opcional. Lista de campos a serem atualizados. Os nomes de campo precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateSKAdNetworkConversionValueSchemaRequest

Mensagem de solicitação para a RPC UpdateSKAdNetworkConversionValueSchema.

Campos
skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

Obrigatório. Esquema de valor da conversão da SKAdNetwork a ser atualizado.

update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os campos omitidos não serão atualizados.

UpdateSearchAds360LinkRequest

Mensagem de solicitação para a RPC UpdateSearchAds360Link.

Campos
update_mask

FieldMask

Obrigatório. A lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateSubpropertyEventFilterRequest

Mensagem de solicitação para a RPC UpdateSubpropertyEventFilter.

Campos
subproperty_event_filter

SubpropertyEventFilter

Obrigatório. O filtro de eventos da subpropriedade a ser atualizado.

update_mask

FieldMask

Obrigatório. Lista de campos a serem atualizados. Os nomes de campo precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.

UpdateSubpropertySyncConfigRequest

Mensagem de solicitação para o RPC UpdateSubpropertySyncConfig.

Campos
subproperty_sync_config

SubpropertySyncConfig

Obrigatório. O SubpropertySyncConfig a ser atualizado.

update_mask

FieldMask

Opcional. Lista de campos a serem atualizados. Os nomes de campo precisam estar em snake case (por exemplo, "field_to_update"). Os campos omitidos não serão atualizados. Para substituir toda a entidade, use um caminho com a string "*" para corresponder a todos os campos.