v1Recursos/Locations/getListar locais com sua mídia
Listar locais com sua mídia
Lista locais junto com suas fotos, as mais recentes primeiro — mesmos filtros de GET /api/v1/locations. Use isso para perguntas como "quais locais não têm fotos?", em vez de GET /api/v1/media, que retorna a mídia de apenas UM local por vez.
get
media:read/api/v1/locations/mediaParâmetros de consulta
clientIdstringopcional
Limita aos locais de um cliente. Obrigatório quando sua chave está limitada a clientes específicos — não há um campo de cliente por linha aqui para verificar um resultado combinado e sem limitação, então um clientId omitido é rejeitado em vez de adivinhado. Procure com GET /api/v1/clients.
searchstringopcional
Busca por texto livre no nome, endereço, cidade ou telefone do local (sem diferenciar maiúsculas/minúsculas, correspondências parciais permitidas).
statusstring (all | active | archived | archival_pending | verification_pending | unapproved | requires_action)opcional
Um único grupo de status: all, active (não arquivado), archived, archival_pending, verification_pending (aprovação do Google pendente), unapproved ou requires_action. O padrão é all.
tagsarray of stringopcional
Tags internas — corresponde a um local que tenha qualquer uma destas.
categoriesarray of stringopcional
Nomes de exibição de categoria — corresponde a um local cuja categoria geral ou do Google seja qualquer uma destas.
verificationarray of string (verified | pending | unverified | unknown)opcional
Estado de verificação do Google: verified, pending, unverified ou unknown.
createdAfterstringopcional
Somente locais criados nesta data ou depois.
createdBeforestringopcional
Somente locais criados nesta data ou antes.
cursorstringopcional
Cursor de paginação do nextCursor de uma resposta anterior. Deixe vazio para a primeira página.
limitintegeropcional
Locais a retornar por página, 1–100. O padrão é 100.
Resposta
dataobjectopcional
locationsarray of objectopcional
Os locais correspondentes para esta página.
idstringopcional
Identificador único do local.
namestringopcional
O nome comercial do local.
logoUrlstringopcional
URL do logotipo do local, ou null.
mediaByCategoryobjectopcional
Itens de mídia agrupados por categoria (ex.: EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Cada item tem uma url e, opcionalmente, um label, um kind (PHOTO ou VIDEO), uma source, um indicador starred e um assetKey.
totalnumberopcional
Número total de fotos em todas as categorias para este local.
nextCursorstringopcional
Cursor de paginação para a próxima página, ou null quando não há mais resultados.
totalnumberopcional
Número total de locais que correspondem aos filtros, em todas as páginas.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/locations/media
Sua chave 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
}
}