Method: publishers.items.queryMetrics

Consultar as métricas de um item.

Solicitação HTTP

GET https://chromewebstore.googleapis.com/v2/{name=publishers/*/items/*}:queryMetrics

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do item para consultar as métricas. Formato: publishers/{publisher}/items/{item}

Parâmetros de consulta

Parâmetros
timeSpec

object (TimeSpec)

Obrigatório. A especificação de tempo para consultar o conjunto de métricas.

metrics[]

string

Obrigatório. As métricas para consultar o conjunto de métricas.

Métricas compatíveis:

  • installs: contagem de instalações do item.
  • installs-7d: contagem de instalações do item nos últimos sete dias.
  • uninstalls: contagem de desinstalações do item.
  • users: contagem de usuários ativos por dia do item.
  • users-7d: contagem de usuários ativos do item nos últimos 7 dias.
  • impressions: contagem de impressões de itens em toda a vitrine.
  • page-views: contagem de visualizações individuais da página de detalhes do item.
dimensions[]

string

Opcional. Dimensões para dividir as métricas. É possível especificar no máximo uma dimensão.

Dimensões compatíveis:

  • os: o sistema operacional do usuário.
  • app-version: a versão do item.
  • country: o país do usuário.
  • install-source: a origem da instalação.
  • install-type: o tipo de instalação (da Web Store, inline ou outro).
  • language: o idioma do usuário.
  • enabled: se o item está ativado ou desativado.
  • utm-campaign: a campanha do UTM do usuário.
  • utm-content: o conteúdo do UTM do usuário.
  • utm-medium: a mídia do UTM do usuário.
  • utm-source: a origem do UTM do usuário.
  • utm-term: o termo UTM do usuário.
pageSize

integer

Opcional. O número máximo de linhas a serem retornadas. Se não for especificado, no máximo 100 linhas serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.

pageToken

string

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

Na paginação, todos os outros parâmetros enviados para a solicitação precisam corresponder à chamada que proporcionou o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para items.queryMetrics.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "metricRows": [
    {
      object (MetricRow)
    }
  ],
  "nextPageToken": string
}
Campos
metricRows[]

object (MetricRow)

As linhas de métricas.

nextPageToken

string

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

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chromewebstore
  • https://www.googleapis.com/auth/chromewebstore.readonly

TimeSpec

Um período para consultar métricas.

Representação JSON
{
  "firstDate": {
    object (Date)
  },
  "lastDate": {
    object (Date)
  }
}
Campos
firstDate

object (Date)

Opcional. A primeira data (inclusive) da especificação de tempo. Se não for definida, nenhum limite inferior será aplicado.

lastDate

object (Date)

Opcional. A última data (inclusive) da especificação de tempo. Se não for definida, nenhum limite superior será aplicado.

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.

month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.

day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

MetricRow

Uma única linha de métricas e valores de dimensão.

Representação JSON
{
  "date": {
    object (Date)
  },
  "dimensionValues": [
    string
  ],
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
Campos
date

object (Date)

A data do registro.

dimensionValues[]

string

Colunas de valor de dimensão para a linha.

metricValues[]

object (MetricValue)

Colunas de métricas da linha.

MetricValue

Representa o valor de uma única métrica.

Representação JSON
{
  "metric": string,
  "value": string,
  "uniqueUserCount": string
}
Campos
metric

string

O nome da métrica

value

string (int64 format)

O valor da métrica.

uniqueUserCount

string (int64 format)

A contagem de usuários únicos associada à métrica (se aplicável).