Method: accounts.locations.reportInsights

Retorna um relatório com insights sobre uma ou mais métricas por local.

Solicitação HTTP

POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:reportInsights

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

Parâmetros de caminho

Parâmetros
name

string

O nome do recurso da conta.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "locationNames": [
    string
  ],
  "basicRequest": {
    object (BasicMetricsRequest)
  },
  "drivingDirectionsRequest": {
    object (DrivingDirectionMetricsRequest)
  }
}
Campos
locationNames[]

string

Um conjunto de locais para os quais buscar insights, especificados pelos nomes.

basicRequest

object (BasicMetricsRequest)

Uma solicitação para incluir insights de métricas básicas no relatório.

drivingDirectionsRequest

object (DrivingDirectionMetricsRequest)

Uma solicitação para incluir insights sobre solicitações de rotas no relatório.

Corpo da resposta

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

Mensagem de resposta para Insights.ReportLocationInsights.

Representação JSON
{
  "locationMetrics": [
    {
      object (LocationMetrics)
    }
  ],
  "locationDrivingDirectionMetrics": [
    {
      object (LocationDrivingDirectionMetrics)
    }
  ]
}
Campos
locationMetrics[]

object (LocationMetrics)

Uma coleção de valores de métricas por local.

locationDrivingDirectionMetrics[]

object (LocationDrivingDirectionMetrics)

Uma coleção de valores para métricas relacionadas a rotas de carro.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Para mais informações, consulte a Visão geral do OAuth 2.0.

DrivingDirectionMetricsRequest

Uma solicitação de insights sobre rotas de carro.

Representação JSON
{
  "numDays": enum (NumDays),
  "languageCode": string
}
Campos
numDays

enum (NumDays)

O número de dias para os quais os dados serão agregados. Os resultados retornados serão dados disponíveis sobre o último número de dias solicitados. Os valores válidos são 7, 30 e 90.

languageCode

string

O código BCP 47 do idioma. Se um código de idioma não for fornecido, o padrão será o inglês.

NumDays

Número de dias que esta solicitação pode aceitar.

Enums
SEVEN 7 dias. Esse é o valor padrão.
THIRTY 30 dias.
NINETY 90 dias.

LocationMetrics

Uma série de métricas e detalhamentos associadas a um local em determinado período.

Representação JSON
{
  "locationName": string,
  "timeZone": string,
  "metricValues": [
    {
      object (MetricValue)
    }
  ]
}
Campos
locationName

string

O nome do recurso de local a que esses valores pertencem.

timeZone

string

Fuso horário da IANA do local.

metricValues[]

object (MetricValue)

Uma lista de valores para as métricas solicitadas.

LocationDrivingDirectionMetrics

Um local indexado com as regiões de onde as pessoas costumam vir. Esse valor é capturado com a contagem de quantas solicitações de rotas de carro para esse local vêm de cada região.

Representação JSON
{
  "locationName": string,
  "topDirectionSources": [
    {
      object (TopDirectionSources)
    }
  ],
  "timeZone": string
}
Campos
locationName

string

O nome do recurso de local a que o valor da métrica pertence.

topDirectionSources[]

object (TopDirectionSources)

Solicitações de direção por região de origem. Por convenção, eles são classificados por contagem com no máximo 10 resultados.

timeZone

string

Fuso horário (IDs de fuso horário IANA, por exemplo, "Europa/Londres") do local.

TopDirectionSources

Principais regiões de origem das solicitações de rotas de carro.

Representação JSON
{
  "dayCount": integer,
  "regionCounts": [
    {
      object (RegionCount)
    }
  ]
}
Campos
dayCount

integer

É o número de dias em que os dados são agregados.

regionCounts[]

object (RegionCount)

Regiões classificadas em ordem decrescente por contagem.

RegionCount

Uma região com a contagem de solicitações associada.

Representação JSON
{
  "latlng": {
    object (LatLng)
  },
  "label": string,
  "count": string
}
Campos
latlng

object (LatLng)

Centro da região.

label

string

Rótulo legível por humanos para a região.

count

string (int64 format)

Número de solicitações de rotas de carro desta região.