Synup
Criar chave
v1Recursos/Locations/patchAtualizar um local

Atualizar um local

Edita os detalhes comerciais de um local existente — endereço, categorias, atributos do perfil comercial do Google, serviços e horários. Envie apenas os campos que deseja alterar; um campo enviado substitui totalmente seu valor atual (uma string vazia limpa um campo de texto, uma lista nova completa substitui uma existente). O país não pode ser alterado após a criação. As alterações salvas são automaticamente colocadas na fila para sincronizar com os diretórios e listagens conectados.

patch/api/v1/locations/{id}
locations:write
Parâmetros de consulta
idstringobrigatório
O local a atualizar.
Corpo da solicitação
namestringopcional
O nome comercial do local.
descriptionstringopcional
Uma breve descrição do negócio.
taglinestringopcional
Um breve slogan para o negócio.
storeCodestringopcional
Seu código interno de loja / referência para este local.
logoUrlstringopcional
URL da imagem do logotipo do local.
languageCodestringopcional
O idioma principal da listagem, como um código (ex.: "en").
streetstringopcional
Endereço.
street1stringopcional
Endereço, linha 2.
citystringopcional
Cidade.
stateIsostringopcional
Estado ou região, como código ISO (ex.: "CA").
postalCodestringopcional
CEP ou código postal.
latitudenumberopcional
Latitude. Se você alterar o endereço sem também definir isso, ela é re-derivada automaticamente.
longitudenumberopcional
Longitude. Se você alterar o endereço sem também definir isso, ela é re-derivada automaticamente.
phonestringopcional
Número de telefone.
additionalPhonesarray of stringopcional
Quaisquer números de telefone adicionais além do principal.
websitestringopcional
URL do site.
businessEmailstringopcional
Um e-mail de contato público para o negócio.
categoryIdstringopcional
ID da categoria geral — consulte com GET /api/v1/locations/categories.
categoryNamestringopcional
Nome de exibição da categoria geral.
publisherCategoriesobjectopcional
Categoria PRIMÁRIA por publisher — atualmente apenas google é suportado aqui (um id e um name são ambos obrigatórios; enviar apenas um limparia a categoria). Facebook/Apple/Bing só podem ser alterados no editor de local. Procure o par id/name do google com GET /api/v1/locations/publisher-categories.
googleobjectopcional
idstringopcional
namestringopcional
additionalCategoriesarray of objectopcional
Até 9 categorias extras, cada uma um { id?, name }. Um nome isolado é aceito e seu id é resolvido a partir do catálogo de categorias, quando houver correspondência. Procure os ids você mesmo com GET /api/v1/locations/categories.
idstringopcional
namestringopcional
attributesobjectopcional
Atributos do perfil comercial do Google, como um mapa de id de atributo para valor (ex.: { "attributes/wi_fi": "free" }) — SUBSTITUI o conjunto inteiro, então leia os atuais em GET /api/v1/locations/{id} e envie de volta tudo o que deseja manter. Um id sem representação válida no Google para a categoria deste local é descartado e reportado em rejectedAttributes, em vez de falhar a solicitação inteira. Não há um endpoint que liste quais ids de atributo são válidos para uma categoria — essa é a própria referência de atributos do Business Profile do Google, não do Synup.
servicesarray of objectopcional
Os serviços ou produtos que este local oferece — substitui a lista existente.
namestringopcional
descriptionstringopcional
pricenumberopcional
currencystringopcional
googleServiceTypeIdstringopcional
ownerNamestringopcional
O nome do proprietário.
menuUrlstringopcional
URL do cardápio/menu do negócio.
yearEstablishednumberopcional
O ano em que o negócio foi fundado (ex.: 2012).
tagsarray of stringopcional
Tags internas para organização própria — não exibidas publicamente. Substitui a lista existente.
labelsarray of stringopcional
Etiquetas internas para este local. Substitui a lista existente.
regularHoursarray of objectopcional
A agenda semanal de horários regulares — substitui totalmente a agenda existente. Uma entrada por dia da semana.
daystring (MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY)opcional
closedbooleanopcional
periodsarray of objectopcional
openstringopcional
closestringopcional
moreHoursarray of objectopcional
Tipos extras de horário além dos horários regulares (entrega, retirada, happy hour etc.), substitui a lista existente.
specialHoursarray of objectopcional
Substituições pontuais de data — fechamentos em feriados ou horários especiais de um único dia — substitui a lista existente. Qualquer data do calendário funciona, não apenas feriados nomeados.
applyToPublishersarray of string (google | facebook | apple | bing)opcional
Altera esses valores apenas para publishers específicos, em vez do padrão compartilhado que todo publisher herda.
Resposta
dataobjectopcional
locationobjectopcional
O perfil comercial completo de um local: endereço, horários, categorias, atributos, serviços, mídia e status — tudo o que update_location pode alterar, além do que create retornou.
idstringopcional
Identificador único do local.
namestringopcional
O nome comercial do local.
descriptionstringopcional
Uma descrição do negócio, ou null.
taglinestringopcional
Um breve slogan para o negócio, ou null.
storeCodestringopcional
Seu código interno de loja / referência para este local, ou null.
logoUrlstringopcional
URL da imagem do logotipo do local, ou null.
streetstringopcional
Endereço, linha 1, ou null.
street1stringopcional
Endereço, linha 2, ou null.
citystringopcional
Cidade.
statestringopcional
Estado ou região.
postalCodestringopcional
CEP ou código postal, ou null.
countrystringopcional
País, como código ISO-3166-1 alfa-2, ou null.
latitudenumberopcional
Latitude, ou null.
longitudenumberopcional
Longitude, ou null.
phonestringopcional
Número de telefone principal, ou null.
additionalPhonesarray of stringopcional
Quaisquer números de telefone adicionais além do principal.
websitestringopcional
A URL do site do local, ou null.
businessEmailstringopcional
Um e-mail de contato público para o negócio, ou null.
categoryNamestringopcional
O nome de exibição da categoria geral, ou null.
primaryCategoryDisplaystringopcional
O nome de exibição da categoria primária efetiva — por publisher (Google) se definida, senão a geral — ou null.
primaryCategoryGooglestringopcional
O id da categoria primária do Google do local (gcid), ou null.
additionalCategoriesarray of objectopcional
Até 9 categorias extras, cada uma com um id (quando resolvido) e um nome de exibição.
idstringopcional
namestringopcional
attributesarray of objectopcional
Atributos do perfil comercial do Google, como a lista armazenada de { id, value }.
idstringopcional
valueobjectopcional
O valor do atributo — um booleano para atributos sim/não, uma string para os de escolha única, ou um objeto com setValues/unsetValues para múltipla escolha.
servicesarray of objectopcional
Os serviços ou produtos que este local oferece.
namestringopcional
descriptionstringopcional
pricenumberopcional
currencystringopcional
googleServiceTypeIdstringopcional
ownerNamestringopcional
O nome do proprietário, ou null.
menuUrlstringopcional
URL do cardápio/menu do negócio, ou null.
yearEstablishednumberopcional
O ano em que o negócio foi fundado, ou null.
tagsarray of stringopcional
Tags internas para organização própria — não exibidas publicamente.
labelsarray of stringopcional
Etiquetas internas para este local.
regularHoursarray of objectopcional
A agenda semanal de horários regulares, ou null.
daystring (MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY)opcional
closedbooleanopcional
periodsarray of objectopcional
moreHoursarray of objectopcional
Tipos extras de horário além dos horários regulares (entrega, retirada etc.), ou null.
specialHoursarray of objectopcional
Substituições pontuais de data — fechamentos em feriados ou horários especiais de um único dia — 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.
clientIdstringopcional
ID do cliente ao qual este local pertence, ou null.
archivedbooleanopcional
Se o local está arquivado.
scheduledArchiveAtstringopcional
Quando o arquivamento foi solicitado (também o token usado por cancel-archive para correspondência), como timestamp ISO 8601, ou null se nenhum estiver pendente.
verificationStatusstring (verified | pending | unverified | unknown)opcional
Estado de verificação do Google: verified, pending, unverified ou unknown, ou null.
rejectedAttributesarray of stringopcional
Ids de atributos da solicitação que NÃO foram gravados — ou porque têm um campo dedicado próprio, ou porque seu valor não tinha uma representação válida no Google. Presente apenas quando ao menos um foi rejeitado.
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.
404O recurso não foi encontrado, ou não pertence à sua agência.
422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
patch/api/v1/locations/{id}
Sua chave de API
id *
Corpo da solicitação
{
  "data": {
    "location": {
      "id": "loc_456",
      "name": "Acme Dental — Downtown",
      "tagline": "Gentle care, on time",
      "city": "Austin",
      "state": "TX",
      "clientId": "cli_123"
    },
    "rejectedAttributes": []
  }
}

Guias que usam este endpoint