Package google.analytics.admin.v1beta

NumericValue

Começa com este número.

NumericValue

Termina com este número.

string

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

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 no horário atual do fuso horário da solicitação.

string

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

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

string

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

string

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

string

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

AccessStringFilter

Filtro relacionado a strings.

AccessInListFilter

Um filtro para valores na lista.

AccessNumericFilter

Um filtro para valores numéricos ou de data.

AccessBetweenFilter

Um filtro para dois valores.

AccessFilterExpressionList

Cada um dos FilterExpressions em and_group tem uma relação AND.

AccessFilterExpressionList

Cada um dos FilterExpressions no or_group tem um relacionamento OR.

AccessFilterExpression

A FilterExpression NÃO é de not_expression.

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.

AccessFilterExpression

Uma lista de expressões de filtro.

string

A lista de valores de string. Não pode estar em branco.

bool

Se verdadeiro, o valor da string diferencia maiúsculas de minúsculas.

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.

string

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

string

O valor de medição. Por exemplo, este valor pode ser "13".

Operation

O tipo de operação para este filtro.

NumericValue

Um valor numérico ou um valor de data.

bool

Se verdadeiro, classifica por ordem decrescente. Se for falso ou não especificado, classifica em ordem crescente.

MetricOrderBy

Classifica os resultados pelos valores de uma métrica.

DimensionOrderBy

Classifica os resultados pelos valores de uma dimensão.

string

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

OrderType

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

string

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

AccessQuotaStatus

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

AccessQuotaStatus

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

AccessQuotaStatus

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

AccessQuotaStatus

Os pares de propriedades e projetos na nuvem podem ter até 50 erros de servidor por hora.

AccessQuotaStatus

As propriedades podem usar até 25% dos tokens por projeto e por hora. Assim,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 por hora, diárias e por hora do projeto.

int32

Cota consumida por esta solicitação.

int32

Cota restante após essa solicitação.

AccessDimensionValue

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

AccessMetricValue

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

MatchType

O tipo de correspondência para este filtro.

string

O valor da string usado para a correspondência.

bool

Se verdadeiro, o valor da string diferencia maiúsculas de minúsculas.

string

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

Timestamp

Apenas saída. Hora em que a conta foi criada originalmente.

Timestamp

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

string

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

string

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

bool

Apenas saída. Indica se esta conta foi excluída de forma reversível ou não. As contas excluídas são excluídas dos resultados da Lista, a menos que seja especificamente solicitado.

string

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

string

Nome do recurso da conta a que este resumo da conta se refere Formato: accounts/{account_id}. Exemplo: "accounts/1000"

string

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

PropertySummary

Lista de resumos para contas filhas desta conta.

string

Obrigatório. A propriedade em que a coleta de dados do usuário será confirmada.

string

Obrigatório. Uma confirmação de que o autor da chamada desse método entende os termos de 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 processamento dos dados deles, incluindo a associação desses dados às informações de visitas que o Google Analytics coleta da minha propriedade de site e/ou app".

string

Obrigatório. O nome da CustomDimension a ser arquivada. Exemplo de formato: Properties/1234/customDimensões/5678

string

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

string

Nome do recurso com as alterações descritas por esta entrada.

ActionType

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

ChangeHistoryResource

Conteúdo do recurso anterior à mudança. Se o recurso tiver sido criado nesta alteração, este campo não estará presente.

ChangeHistoryResource

Conteúdo do recurso posterior à mudança. Se o recurso tiver sido excluído nesta alteração, este campo não estará presente.

Account

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

Property

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

FirebaseLink

Um resumo de um recurso FirebaseLink no histórico de alterações.

GoogleAdsLink

Um resumo de um recurso do GoogleAdsLink no histórico de alterações.

ConversionEvent

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

MeasurementProtocolSecret

Um resumo de um recurso Measurement ProtocolSecret no histórico de alterações.

DataRetentionSettings

Um resumo de um recurso de configurações de retenção de dados no histórico de alterações.

DataStream

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

string

ID deste evento do histórico de alterações. Esse ID é exclusivo no Google Analytics.

Timestamp

Horário em que a alteração foi feita.

ActorType

O tipo de ator que fez a alteração.

string

Endereço de e-mail da Conta do Google que fez a alteração. Este será um endereço de e-mail válido se o campo do ator estiver definido como USER. Caso contrário, estará vazio. Contas do Google que foram excluídas causarão um erro.

bool

Se verdadeiro, a lista de alterações retornadas foi filtrada e não representa todas as alterações que ocorreram nesse evento.

ChangeHistoryChange

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

string

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

string

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

Timestamp

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

bool

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

bool

Apenas saída. Se definido como verdadeiro, esse evento de conversão vai se referir a um evento personalizado. Se definido como "falso", 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. Os eventos padrão geralmente são criados pelo sistema do GA, mas, em alguns casos, podem ser criados pelos administradores da propriedade. Os eventos personalizados são contabilizados no número máximo de eventos de conversão personalizados que podem ser criados por propriedade.

ConversionCountingMethod

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

DefaultConversionValue

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

double

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

string

Quando um evento de conversão para esse event_name não tiver uma moeda definida, ela será 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.

ConversionEvent

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

string

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

string

Obrigatório. Exemplo de formato: properties/1234

CustomDimension

Obrigatório. A CustomDimension a ser criada.

string

Obrigatório. Exemplo de formato: properties/1234

CustomMetric

Obrigatório. A CustomMetric a ser criado.

string

Obrigatório. Exemplo de formato: properties/1234

DataStream

Obrigatório. O DataStream a ser criado.

string

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

FirebaseLink

Obrigatório. O link do Firebase a ser criado.

string

Obrigatório. Exemplo de formato: properties/1234

GoogleAdsLink

Obrigatório. O GoogleAdsLink a ser criado.

string

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

MeasurementProtocolSecret

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

Property

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

string

Apenas saída. Nome do recurso para este recurso CustomDimension. Formato: Properties/{property}/customDimensões/{customDimension}

string

Obrigatório. Imutável. Nome do parâmetro de inclusão de tags dessa dimensão personalizada.

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

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

Pode conter apenas caracteres alfanuméricos e sublinhado, 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.

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éricos mais espaço e sublinhado começando com uma letra. Nomes de exibição gerados pelo sistema legados podem conter colchetes, mas as atualizações nesse campo nunca permitirão colchetes.

string

Opcional. Descrição dessa dimensão personalizada. Comprimento máximo de 150 caracteres.

DimensionScope

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

bool

Opcional. Se definida como verdadeira, a dimensão será definida como NPA e será excluída da personalização de anúncios.

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

string

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

string

Obrigatório. Imutável. Nome da marcação desta métrica personalizada.

Se a métrica for no escopo do evento, esse vai ser o nome do parâmetro do evento.

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

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éricos mais espaço e sublinhado começando com uma letra. Nomes de exibição gerados pelo sistema legados podem conter colchetes, mas as atualizações nesse campo nunca permitirão colchetes.

string

Opcional. Descrição dessa dimensão personalizada. Comprimento máximo de 150 caracteres.

MeasurementUnit

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

MetricScope

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

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.

string

Apenas saída. Nome do recurso DataRetençãoSetting. Formato: Properties/{property}/dataretentionSettings

RetentionDuration

O período em que os dados de evento são retidos.

bool

Se verdadeiro, redefine o período de retenção do identificador do usuário a cada evento desse usuário.

string

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

bool

Permite que o suporte do Google acesse os dados para ajudar a resolver problemas.

bool

Permite que as equipes de vendas do Google atribuídas ao cliente acessem os dados para sugerir alterações na configuração e melhorar os resultados. As restrições para a equipe de vendas ainda se aplicam quando ativadas.

bool

Permite que qualquer equipe de vendas do Google acesse os dados para sugerir alterações de configuração e melhorar os resultados.

bool

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

bool

Permite que o Google compartilhe os dados de forma anônima com outras pessoas.

string

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

DataStreamType

Obrigatório. Imutável. O tipo desse recurso do DataStream.

string

Nome de exibição legível para o 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.

Timestamp

Apenas saída. Hora em que a transmissão foi criada.

Timestamp

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

WebStreamData

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

AndroidAppStreamData

Dados específicos para fluxos do app Android. Precisa ser preenchido se o tipo for ANDROID_APP_DATA_STREAM.

IosAppStreamData

Dados específicos para fluxos do app iOS. Precisa ser preenchido se o tipo for IOS_APP_DATA_STREAM.

string

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

string

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

string

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

string

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

string

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

Exemplo: "G-1A2BCD345E"

string

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

string

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

string

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

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"

string

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

string

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

string

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

string

Obrigatório. O nome do Measurement ProtocolSecret a ser excluído. Formato: Properties/{property}/dataStreams/{dataStream}/measurement ProtocolSecrets/{measurement ProtocolSecret}

string

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

string

Apenas saída. Exemplo de formato: Properties/1234/firebaseLinks/5678

string

Imutável. Nome do recurso do projeto do Firebase. Ao criar um FirebaseLink, você pode fornecer esse nome de recurso usando um número ou ID do projeto. Depois que esse recurso for criado, os FirebaseLinks retornados sempre terão um project_name que contém um número de projeto.

Formato: 'projects/{número do projeto}' Exemplo: 'projects/1234'

Timestamp

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

string

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

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"

string

Obrigatório. O nome da CustomDimension a ser obtida. Exemplo de formato: Properties/1234/customDimensões/5678

string

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

string

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

string

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

string

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

string

Obrigatório. O nome do secret do Measurement Protocol a ser pesquisado. Formato: Properties/{property}/dataStreams/{dataStream}/measurement ProtocolSecrets/{measurement ProtocolSecret}

string

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

string

Apenas saída. Formato: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}

Observação: googleAdsLinkId não é o ID de cliente do Google Ads.

string

Imutável. ID de cliente do Google Ads.

bool

Apenas saída. Se verdadeiro, a vinculação é para uma conta de administrador do Google Ads.

BoolValue

Ativar recursos de publicidade personalizados com essa integração. Publicar automaticamente minhas listas de público-alvo e os eventos/parâmetros de remarketing do Analytics a serem vinculados à conta do Google Ads. Se esse campo não for definido na criação/atualização, o padrão será "true".

Timestamp

Apenas saída. Hora em que o link foi criado originalmente.

Timestamp

Apenas saída. Hora em que o link foi atualizado pela última vez.

string

Apenas saída. Endereço de e-mail do usuário que criou o link. Uma string vazia será retornada se o endereço de e-mail não puder ser recuperado.

int32

O número máximo de recursos AccountSummary a serem retornados. O serviço pode retornar menos que esse valor, mesmo se houver páginas adicionais. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200; (valores mais altos serão convertidos para o máximo)

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.

AccountSummary

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

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.

int32

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo se houver páginas adicionais. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200; (valores mais altos serão convertidos para o máximo)

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.

bool

Se contas excluídas de maneira reversível (ou seja: "lixadas") serão incluídas nos resultados. As contas podem ser inspecionadas para determinar se foram excluídas ou não.

Account

Resultados que estavam acessíveis ao autor da chamada.

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.

string

Obrigatório. O nome do recurso da propriedade pai. Exemplo: "propriedades/123"

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 mais altos serão convertidos para o máximo)

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.

ConversionEvent

Os eventos de conversão solicitados

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.

string

Obrigatório. Exemplo de formato: properties/1234

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 mais altos serão convertidos para o máximo).

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.

CustomDimension

Lista de CustomDimensões.

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.

string

Obrigatório. Exemplo de formato: properties/1234

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 mais altos serão convertidos para o máximo).

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.

CustomMetric

Lista de CustomMetrics.

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.

string

Obrigatório. Exemplo de formato: properties/1234

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 mais altos serão convertidos para o máximo).

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.

DataStream

Lista de DataStreams.

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.

string

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

int32

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo se houver páginas adicionais. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200; (valores mais altos serão convertidos para o máximo)

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.

FirebaseLink

Lista de FirebaseLinks. Isso terá no máximo um valor.

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. Atualmente, o Google Analytics aceita apenas um FirebaseLink por propriedade. Portanto, isso nunca será preenchido.

string

Obrigatório. Exemplo de formato: properties/1234

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 mais altos serão convertidos para o máximo).

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.

GoogleAdsLink

Lista de GoogleAdsLinks.

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.

string

Obrigatório. O nome do recurso do stream pai. Formato: properties/{property}/dataStreams/{dataStream}/measurement ProtocolSecrets

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.

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.

MeasurementProtocolSecret

Uma lista de secrets do stream pai especificado na solicitação.

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.

string

Obrigatório. Uma expressão para filtrar os resultados da solicitação. Os campos qualificados para filtragem são: parent:(nome do recurso da conta/propriedade mãe) ou ancestor:(nome do recurso da conta mãe) ou firebase_project:(o ID ou número do projeto vinculado do Firebase). 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.    |

int32

O número máximo de recursos a serem retornados. O serviço pode retornar menos que esse valor, mesmo se houver páginas adicionais. Se não for especificado, no máximo 50 recursos serão retornados. O valor máximo é 200; (valores mais altos serão convertidos para o máximo)

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.

bool

Define se as propriedades excluídas de maneira reversível (ou seja, "na lixeira") serão incluídas nos resultados. As propriedades podem ser inspecionadas para determinar se elas foram excluídas ou não.

Property

Resultados que corresponderam aos critérios do filtro e estavam acessíveis para o autor da chamada.

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.

string

Apenas saída. Nome do recurso deste secret. Esse secret pode ser filho de qualquer tipo de stream. Formato: Properties/{property}/dataStreams/{dataStream}/measurement ProtocolSecrets/{measurement ProtocolSecret}

string

Obrigatório. Nome de exibição legível por humanos para este secret.

string

Apenas saída. O valor secret do Measurement Protocol. Transmita esse valor ao campo api_secret da API Measurement Protocol ao enviar hits para a propriedade pai desse secret.

int64

Número inteiro

double

Valor duplo

string

Apenas saída. Nome do recurso desta propriedade. Formato: propriedades/{property_id} Exemplo: "propriedades/1000"

PropertyType

Imutável. O tipo de propriedade para este recurso de propriedade. Ao criar uma propriedade, se o tipo for "PROPERTY_TYPE_UNSPECIFIED", "ORDINARY_PROPERTY" ficará implícito.

Timestamp

Apenas saída. Horário em que a entidade foi criada originalmente.

Timestamp

Apenas saída. Horário em que os campos de payload da entidade foram atualizados pela última vez.

string

Imutável. Nome do recurso do pai lógico dessa propriedade.

Observação: a interface de movimentação de propriedades pode ser usada para alterar o pai. Formato: accounts/{account}, propriedades/{property} Exemplo: "accounts/100", "properties/101"

string

Obrigatório. Nome de exibição legível desta propriedade.

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

IndustryCategory

Setor associado a esta propriedade Exemplo: AUTOMOTIVE, FOOD_AND_DRINK

string

Obrigatório. Fuso horário dos relatórios, usado como o limite do dia para relatórios, independentemente da origem dos dados. Caso o fuso horário siga o horário de verão, o Google Analytics fará os ajustes automaticamente.

OBSERVAÇÃO: a alteração do fuso horário só afeta dados posteriores. Ela não é aplicada de forma retroativa.

Formato: https://www.iana.org/time-zones (link em inglês). Exemplo: "America/Los_Angeles"

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"

ServiceLevel

Apenas saída. O nível de serviço do Google Analytics que se aplica a essa propriedade.

Timestamp

Apenas saída. Se definido, a hora em que a propriedade foi enviada para a lixeira. Se não for definida, a propriedade não vai estar na lixeira.

Timestamp

Apenas saída. Se definido, o horário em que essa propriedade na lixeira será excluída permanentemente. Se não for definida, a propriedade não vai estar na lixeira nem está programada para ser excluída.

string

Imutável. O nome do recurso do formato da conta mãe: accounts/{account_id}. Exemplo: "accounts/123"

string

Nome do recurso da propriedade mencionado por este resumo de propriedade Formato: propriedades/{property_id}. Exemplo: "propriedades/1000"

string

Nome de exibição da propriedade mencionada neste resumo de propriedades.

PropertyType

O tipo de propriedade da propriedade.

string

Nome do recurso do pai lógico dessa propriedade.

Observação: a interface de movimentação de propriedades pode ser usada para alterar o pai. Formato: accounts/{account}, propriedades/{property} Exemplo: "accounts/100", "properties/200"

Account

A conta a ser criada.

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.

string

O parâmetro a ser transmitido no link dos TOS.

string

O Relatório de acesso a dados é compatível com solicitações no nível da propriedade ou da conta. Se solicitados no nível da conta, os relatórios de acesso a dados incluem todo o acesso a todas as propriedades nessa conta.

Para solicitar no nível da propriedade, a entidade vai precisar ser, por exemplo, "properties/123" se "123" for o ID da propriedade do GA4. Para solicitar no nível da conta, a entidade vai precisar ser, por exemplo, "accounts/1234" se "1234" for o ID da conta do GA4.

AccessDimension

As dimensões solicitadas e exibidas na resposta. As solicitações podem ter até nove dimensões.

AccessMetric

As métricas solicitadas e exibidas na resposta. As solicitações podem ter até 10 métricas.

AccessDateRange

Períodos dos registros de acesso a serem lidos. Se vários períodos forem solicitados, cada linha de resposta terá um índice de período baseado em zero. Se dois períodos se sobrepuserem, os registros de acesso dos dias sobrepostos serão incluídos nas linhas de resposta dos dois períodos. As solicitações podem ter até dois períodos.

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 Princípios básicos dos filtros de dimensão para ver exemplos. Não é possível usar métricas neste filtro.

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étricas são aplicados após a agregação das linhas do relatório, de maneira semelhante à cláusula SQL. Não é possível usar dimensões neste filtro.

int64

A contagem de linhas da primeira linha. A primeira linha é contada como a linha 0. Se o deslocamento não for especificado, ele será tratado como 0. Se o deslocamento for zero, esse método retornará a primeira página de resultados com entradas limit.

Consulte Paginação para saber mais sobre esse parâmetro.

int64

O número de linhas a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 100.000 linhas por solicitação, independentemente de quantas linhas você solicitar. 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 um relatório somente para country, não será possível gerar mais de 300 linhas, mesmo que você defina limit como um valor mais alto.

Consulte Paginação para saber mais sobre esse parâmetro.

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 da IANA (https://www.iana.org/time-zones)). Por exemplo, "America/New_York" ou "Asia/Tokyo".

AccessOrderBy

Especifica como as linhas são ordenadas na resposta.

bool

Define se é necessário retornar o estado atual da cota dessa propriedade do Google Analytics. A cota é retornada em AccessQuota. Para solicitações no nível da conta, este campo precisa ser falso.

bool

Opcional. Determina se os usuários que nunca fizeram uma chamada de API na resposta serão incluídos. Se verdadeiro, todos os usuários com acesso à propriedade ou conta especificada são incluídos na resposta, independentemente de terem feito uma chamada de API ou não. Se for "false", somente os usuários que fizeram uma chamada de API serão incluídos.

bool

Opcional. Decidir se quer retornar os usuários nos grupos de usuários. Esse campo funciona apenas quando include_all_users está definido como verdadeiro. Se verdadeiro, todos os usuários com acesso à propriedade ou conta especificada serão retornados. Se for definido como "false", somente os usuários com acesso direto serão retornados.

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 ordem de DimensionHeaders correspondem às dimensões presentes nas linhas.

AccessMetricHeader

O cabeçalho de uma coluna no relatório que corresponde a uma métrica específica. O número de MetricHeaders e ordem de MetricHeaders correspondem às métricas presentes nas linhas.

AccessRow

Linhas de combinações de valores de dimensão e valores de métricas no relatório.

int32

O número total de linhas no resultado da consulta. rowCount é independente do número de linhas retornadas na resposta, no parâmetro de solicitação limit e no 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 conterá rowCount de 175, mas apenas 50 linhas.

Consulte Paginação para saber mais sobre esse parâmetro.

AccessQuota

O estado da cota para essa propriedade do Google Analytics, incluindo a solicitação. Este campo não funciona com solicitações no nível da conta.

string

Obrigatório. O recurso de conta em que os recursos do histórico de alterações serão retornados. Formato: accounts/{account} Exemplo: "accounts/100"

string

Opcional. Nome do recurso para uma propriedade filha. Se definido, retorna apenas as alterações feitas nessa propriedade ou nos recursos filhos dela. Formato: propriedades/{propertyId} Exemplo: "propriedades/100"

ChangeHistoryResourceType

Opcional. Se definido, somente as alterações serão retornadas se forem para um recurso que corresponda a pelo menos um desses tipos.

ActionType

Opcional. Se definido, retorna somente alterações que correspondam a um ou mais desses tipos de ações.

string

Opcional. Se definido, retorna as alterações somente se elas forem feitas por um usuário dessa lista.

Timestamp

Opcional. Se definido, retorna somente as alterações feitas depois desse período (inclusive).

Timestamp

Opcional. Se definido, retorna somente as alterações feitas antes desse horário (inclusive).

int32

Opcional. O número máximo de itens ChangeHistoryEvent a serem retornados. O serviço pode retornar menos que esse valor, mesmo se houver páginas adicionais. Se não for especificado, serão retornados no máximo 50 itens. O valor máximo é 200 (valores mais altos serão convertidos para o máximo).

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.

ChangeHistoryEvent

Resultados que estavam acessíveis ao autor da chamada.

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.

Account

Obrigatório. A conta a ser atualizada. O campo name da conta é usado para identificar a conta.

FieldMask

Obrigatório. 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 a entidade inteira, use um caminho com a string "*" para corresponder a todos os campos.

ConversionEvent

Obrigatório. O evento de conversão a ser atualizado. O campo name é usado para identificar as configurações que serão atualizadas.

FieldMask

Obrigatório. 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 a entidade inteira, use um caminho com a string "*" para corresponder a todos os campos.

CustomDimension

A CustomDimension a ser atualizada

FieldMask

Obrigatório. Lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir a entidade inteira, use um caminho com a string "*" para corresponder a todos os campos.

CustomMetric

A CustomMetric a ser atualizado

FieldMask

Obrigatório. Lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir a entidade inteira, use um caminho com a string "*" para corresponder a todos os campos.

DataRetentionSettings

Obrigatório. As configurações a serem atualizadas. O campo name é usado para identificar as configurações que serão atualizadas.

FieldMask

Obrigatório. 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 a entidade inteira, use um caminho com a string "*" para corresponder a todos os campos.

DataStream

O DataStream a ser atualizado

FieldMask

Obrigatório. Lista de campos a serem atualizados. Os campos omitidos não serão atualizados. Para substituir a entidade inteira, use um caminho com a string "*" para corresponder a todos os campos.

GoogleAdsLink

O GoogleAdsLink para atualizar

FieldMask

Obrigatório. 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 a entidade inteira, use um caminho com a string "*" para corresponder a todos os campos.

MeasurementProtocolSecret

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

FieldMask

Obrigatório. Lista de campos a serem atualizados. Os campos omitidos não serão atualizados.

Property

Obrigatório. A propriedade a ser atualizada. O campo name da propriedade é usado para identificar a propriedade a ser atualizada.

FieldMask

Obrigatório. 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 a entidade inteira, use um caminho com a string "*" para corresponder a todos os campos.