- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- ComparisonMetadata
- Faça um teste
Retorna metadados de dimensões e métricas disponíveis nos métodos de geração de relatórios. Usado para explorar as dimensões e métricas. Nesse método, um identificador da propriedade do GA4 no Google Analytics é especificado na solicitação, e a resposta de metadados inclui dimensões e métricas personalizadas, além de metadados universais.
Por exemplo, se uma métrica personalizada com o nome de parâmetro levels_unlocked
for registrada em uma propriedade, a resposta de metadados vai conter customEvent:levels_unlocked
. Os metadados universais são dimensões e métricas aplicáveis a qualquer propriedade, como country
e totalUsers
.
Solicitação HTTP
GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
name |
Obrigatório. O nome do recurso dos metadados a serem recuperados. Esse campo de nome é especificado no caminho do URL, e não nos parâmetros de URL. A propriedade é um identificador numérico da propriedade do GA4 do Google Analytics. Para saber mais, confira onde encontrar o ID da propriedade. Exemplo: Properties/1234/metadata Defina o ID da propriedade como 0 para dimensões e métricas comuns a todas as propriedades. Nesse modo especial, o método não retorna dimensões e métricas personalizadas. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
As dimensões, métricas e comparações aceitas atualmente nos métodos de geração de relatórios.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "name": string, "dimensions": [ { object ( |
Campos | |
---|---|
name |
Nome do recurso dos metadados. |
dimensions[] |
As descrições de dimensão. |
metrics[] |
As descrições de métricas. |
comparisons[] |
As descrições de comparaçã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
ComparisonMetadata
Os metadados para uma única comparação.
Representação JSON |
---|
{ "apiName": string, "uiName": string, "description": string } |
Campos | |
---|---|
apiName |
O nome do recurso dessa comparação. Pode ser usado no campo |
uiName |
O nome dessa comparação na interface do usuário do Google Analytics. |
description |
A descrição dessa comparação. |