Method: locations.searchkeywords.impressions.monthly.list

Retorna as palavras-chave de pesquisa usadas para encontrar uma empresa na pesquisa ou no Google Maps. Cada palavra-chave de pesquisa é acompanhada por impressões, que são agregadas mensalmente.

Exemplo de solicitação: GET https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthlyRange.start_month.year=2022&monthlyRange.start_month.month=1&monthlyRange.end_month.year=2022&monthlyRange.end_month.month=3

Solicitação HTTP

GET https://businessprofileperformance.googleapis.com/v1/{parent=locations/*}/searchkeywords/impressions/monthly

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O local em que a série temporal será buscada. Formato: locations/{locationId}, em que locationId é um ID da ficha da empresa não ofuscado.

Parâmetros de consulta

Parâmetros
monthlyRange

object (MonthlyRange)

Obrigatório. O período em meses no qual agregar as impressões das palavras-chave da rede de pesquisa.
pageSize

integer

Opcional. O número de resultados solicitados. O tamanho de página padrão é 100. O tamanho da página pode ser definido como no máximo 100.
pageToken

string (bytes format)

Opcional. Um token que indica o próximo resultado paginado a ser retornado.

Uma string codificada em base64.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Representa a resposta paramonthly.list.

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

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

object (SearchKeywordCount)

Termos de pesquisa que foram usados para encontrar uma empresa.
nextPageToken

string (bytes format)

Um token que indica o último resultado paginado retornado. Pode ser usado para solicitações bem-sucedidas para conseguir a próxima "página" de palavras-chave. Ele só estará presente quando houver mais resultados a serem retornados.

Uma string codificada em base64.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

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

MonthlyRange

Período que indica um intervalo de meses (ambos inclusive).

Representação JSON 
{
  "startMonth": {
    object (Date)
  },
  "endMonth": {
    object (Date)
  }
}
Campos
startMonth

object (Date)

Obrigatório. Inclusivo: somente os campos ano e mês serão considerados.
endMonth

object (Date)

Obrigatório. Inclusivo: somente os campos ano e mês serão considerados.

SearchKeywordCount

Representa uma única palavra-chave da rede de pesquisa e o valor dela.

Representação JSON 
{
  "searchKeyword": string,
  "insightsValue": {
    object (InsightsValue)
  }
}
Campos
searchKeyword

string

A string em letras minúsculas que o usuário inseriu.
insightsValue

object (InsightsValue)

Uma destas opções: 1) A soma do número de usuários únicos que usaram a palavra-chave em um mês, agregada para cada mês solicitado. 2) Um limite que indica que o valor real está abaixo desse limite.

InsightsValue

Representa um valor de insights.

Representação JSON 
{

  // Union field InsightsValue can be only one of the following:
  "value": string,
  "threshold": string
  // End of list of possible types for union field InsightsValue.
}
Campos
Campo de união InsightsValue. Representa que apenas um dos seguintes campos proto precisa estar presente. InsightsValue pode ser apenas de um dos tipos a seguir:
value

string (int64 format)

Representa o valor real.
threshold

string (int64 format)

Representa o limite abaixo do qual o valor real está.