Method: accounts.locations.findMatches

Busca todas las ubicaciones posibles que coinciden con la ubicación especificada. Esta operación solo es válida si la ubicación no está verificada.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

El nombre del recurso de la ubicación para la que se deben buscar coincidencias.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "languageCode": string,
  "numResults": integer,
  "maxCacheDuration": string
}
Campos
languageCode

string

El idioma preferido de la ubicación coincidente (en formato BCP-47).

numResults

integer

La cantidad de coincidencias que se mostrarán. El valor predeterminado es 3, con un máximo de 10. Ten en cuenta que la latencia puede aumentar si se solicitan más. No hay paginación.

maxCacheDuration

string (Duration format)

Ya no está disponible. Este campo se ignora para todas las solicitudes.

Es una duración en segundos con hasta nueve dígitos fraccionarios que termina en "s". Ejemplo: "3.5s".

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Mensaje de respuesta para locations.FindMatchingLocations.

Representación JSON
{
  "matchedLocations": [
    {
      object (MatchedLocation)
    }
  ],
  "matchTime": string
}
Campos
matchedLocations[]

object (MatchedLocation)

Es un conjunto de ubicaciones que son posibles coincidencias con la ubicación especificada, ordenadas de mayor a menor coincidencia. Si hay una coincidencia exacta, se ubicará en la primera posición.

matchTime

string (Timestamp format)

Cuándo se ejecutó por última vez el algoritmo de coincidencia para esta ubicación.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

MatchedLocation

Representa una posible coincidencia con una ubicación.

Representación JSON
{
  "location": {
    object (Location)
  },
  "isExactMatch": boolean
}
Campos
location

object (Location)

La ubicación dispersa poblada que es una posible coincidencia. Los campos sin propagar incluyen, entre otros, los siguientes: nombre (la ubicación coincidente no se puede recuperar a través de locations.get ni locations.batchGet); storeCode; detalles del área de cobertura de serviceArea; labels; adWordsLocationExtensions; photos

isExactMatch

boolean

¿Se trata de una coincidencia exacta?