- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- DrivingDirectionMetricsRequest
- NumDays
- LocationMetrics
- LocationDrivingDirectionMetrics
- TopDirectionSources
- RegionCount
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 |
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 ( |
Campos | |
---|---|
locationNames[] |
Um conjunto de locais para os quais buscar insights, especificados pelos nomes deles. |
basicRequest |
Uma solicitação para incluir insights de métricas básicas no relatório. |
drivingDirectionsRequest |
Uma solicitação para incluir insights sobre solicitações de rotas de carro 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 ( |
Campos | |
---|---|
locationMetrics[] |
Uma coleção de valores de métricas por local. |
locationDrivingDirectionMetrics[] |
Um conjunto de valores para métricas relacionadas a rotas de carro. |
Escopos de autorização
Requer um dos seguintes escopos do 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 de rotas de carro.
Representação JSON | |
---|---|
{
"numDays": enum ( |
Campos | |
---|---|
numDays |
O número de dias para agregar dados. Os resultados retornados estarão disponíveis para os dados referentes ao último número de dias solicitados. Os valores válidos são 7, 30 e 90. |
languageCode |
O código BCP 47 do idioma. Se um código de idioma não for fornecido, o padrão será inglês. |
NumDays
Número de dias que esta solicitação pode suportar.
Enums | |
---|---|
SEVEN |
7 dias. Esse é o valor padrão. |
THIRTY |
30 dias. |
NINETY |
90 dias. |
LocationMetrics
Uma série de Métricas e DetalhamentoMetrics associados a um local em determinado período.
Representação JSON | |
---|---|
{
"locationName": string,
"timeZone": string,
"metricValues": [
{
object ( |
Campos | |
---|---|
locationName |
O nome do recurso de local a que esses valores pertencem. |
timeZone |
Fuso horário da IANA do local. |
metricValues[] |
Uma lista de valores para as métricas solicitadas. |
LocationDrivingDirectionMetrics
Um local indexado com as regiões de origem das pessoas. Isso é capturado pela contagem de quantas solicitações de rotas de carro para esse local são de cada região.
Representação JSON | |
---|---|
{
"locationName": string,
"topDirectionSources": [
{
object ( |
Campos | |
---|---|
locationName |
O nome do recurso de local ao qual este valor de métrica pertence. |
topDirectionSources[] |
Solicitações de rotas de carro por região de origem. Por convenção, estes são classificados por contagem, com no máximo 10 resultados. |
timeZone |
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 ( |
Campos | |
---|---|
dayCount |
O número de dias em que os dados são agregados. |
regionCounts[] |
Regiões classificadas em ordem decrescente por contagem. |
RegionCount
Uma região com a contagem de solicitações associadas.
Representação JSON | |
---|---|
{
"latlng": {
object ( |
Campos | |
---|---|
latlng |
Centro da região. |
label |
Rótulo legível por humanos da região. |
count |
Número de solicitações de rotas de carro nesta região. |