- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- MatchedLocation
Encontra todos os locais possíveis que correspondem ao local especificado. Essa operação só é válida se o local não tiver sido 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 |
O nome do recurso do local para que as correspondências serão encontradas. |
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 |
O idioma preferido para o local correspondente (no formato BCP-47). |
numResults |
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 mais solicitações forem solicitadas. Não há paginação. |
maxCacheDuration |
Obsoleto. Este campo é ignorado para todas as solicitações. Uma duração em segundos com até nove dígitos fracionários, encerrada por " |
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 ( |
Campos | |
---|---|
matchedLocations[] |
Um conjunto de locais que são possíveis correspondências com o local especificado, listados em ordem da melhor para a menor correspondência. Se houver uma correspondência exata, ele estará na primeira posição. |
matchTime |
Quando o algoritmo correspondente foi executado pela última vez para esse local. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
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.
MatchedLocation
Representa uma possível correspondência com um local.
Representação JSON | |
---|---|
{
"location": {
object ( |
Campos | |
---|---|
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 meio de |
isExactMatch |
É uma correspondência exata? |