Method: accounts.locations.findMatches

Encontra todos os locais possíveis que correspondem ao local especificado. Esta operação só será válida se o local não for verificado.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

O nome do recurso do local para o qual encontrar correspondências.

Corpo da solicitação

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

Representação JSON 
{
  "languageCode": string,
  "numResults": integer,
  "maxCacheDuration": string
}
Campos
languageCode

string

O idioma preferido do local correspondente (no formato BCP-47).
numResults

integer

O número de correspondências a serem retornadas. O valor padrão é 3, com um máximo de 10. A latência pode aumentar se forem solicitadas mais. Não há paginação.
maxCacheDuration

string (Duration format)

Obsoleto. Este campo é ignorado para todas as solicitações.

Uma duração em segundos com até nove dígitos fracionários, encerrada por "s". Exemplo: "3.5s".

Corpo da resposta

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

Mensagem de resposta para Locations.FindMatchingLocations.

Representação JSON 
{
  "matchedLocations": [
    {
      object (MatchedLocation)
    }
  ],
  "matchTime": string
}
Campos
matchedLocations[]

object (MatchedLocation)

Um conjunto de locais que são possíveis correspondências com o local especificado, listados em ordem decrescente. Se houver uma correspondência exata, ela vai estar na primeira posição.
matchTime

string (Timestamp format)

Quando o algoritmo correspondente foi executado pela última vez para esse local.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

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.

MatchedLocation

Representa uma possível correspondência com um local.

Representação JSON 
{
  "location": {
    object (Location)
  },
  "isExactMatch": boolean
}
Campos
location

object (Location)

O local pouco preenchido que é uma possível correspondência. Os campos não preenchidos incluem, entre outros: nome (o local correspondente não pode ser recuperado por locations.get nem locations.batchGet); storeCode; detalhes da área de cobertura de serviceArea; labels; adWordsLocationExtensions; photos
isExactMatch

boolean

É uma correspondência exata?