v1Recursos/Locations/getListar ubicaciones con sus medios
Listar ubicaciones con sus medios
Lista ubicaciones junto con sus fotos, empezando por las más recientes — mismos filtros que GET /api/v1/locations. Úselo para preguntas como "¿qué ubicaciones no tienen fotos?", en lugar de GET /api/v1/media, que devuelve los medios de una sola ubicación a la vez.
get
media:read/api/v1/locations/mediaParámetros de consulta
clientIdstringopcional
Limita a las ubicaciones de un cliente. Obligatorio cuando su clave está limitada a clientes específicos — aquí no hay un campo de cliente por fila con el que comprobar un resultado combinado y sin límite, así que un clientId omitido se rechaza en lugar de suponerse. Búsquelo con GET /api/v1/clients.
searchstringopcional
Búsqueda de texto libre sobre el nombre, la dirección postal, la ciudad o el teléfono de la ubicación (sin distinguir mayúsculas, coincidencias parciales permitidas).
statusstring (all | active | archived | archival_pending | verification_pending | unapproved | requires_action)opcional
Un único grupo de estado: all, active (no archivada), archived, archival_pending, verification_pending (aprobación de Google pendiente), unapproved o requires_action. El valor por defecto es all.
tagsarray of stringopcional
Etiquetas internas — coincide con una ubicación que tenga alguna de estas.
categoriesarray of stringopcional
Nombres visibles de categoría — coincide con una ubicación cuya categoría general o de Google sea alguna de estas.
verificationarray of string (verified | pending | unverified | unknown)opcional
Estado de verificación de Google: verified, pending, unverified o unknown.
createdAfterstringopcional
Solo ubicaciones creadas en esta fecha o después.
createdBeforestringopcional
Solo ubicaciones creadas en esta fecha o antes.
cursorstringopcional
Cursor de paginación del nextCursor de una respuesta anterior. Déjelo vacío para la primera página.
limitintegeropcional
Ubicaciones a devolver por página, 1–100. El valor por defecto es 100.
Respuesta
dataobjectopcional
locationsarray of objectopcional
Las ubicaciones que coinciden en esta página.
idstringopcional
Identificador único de la ubicación.
namestringopcional
El nombre comercial de la ubicación.
logoUrlstringopcional
URL del logo de la ubicación, o null.
mediaByCategoryobjectopcional
Elementos multimedia agrupados por categoría (p. ej. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Cada elemento tiene una url y, opcionalmente, un label, un kind (PHOTO o VIDEO), una source, un indicador starred y un assetKey.
totalnumberopcional
Número total de fotos en todas las categorías de esta ubicación.
nextCursorstringopcional
Cursor de paginación para la siguiente página, o null cuando no hay más resultados.
totalnumberopcional
Número total de ubicaciones que coinciden con los filtros, en todas las páginas.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/locations/media
Su clave de API
clientId
search
status
tags
categories
verification
createdAfter
createdBefore
cursor
limit
{
"data": {
"locations": [
{
"id": "loc_456",
"name": "Acme Dental — Downtown",
"logoUrl": null,
"mediaByCategory": {
"EXTERIOR": [
{
"url": "https://cdn.synup.com/media/1.jpg"
}
]
},
"total": 1
}
],
"nextCursor": null,
"total": 1
}
}