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. A sincronização começa cerca de 15 minutos após a última edição do local, então várias edições seguidas são enviadas juntas como uma única atualização.

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 de loja ou referência interna para este local. Uma string vazia o remove, inclusive no Google.

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.

openStatusstring (OPEN | CLOSED_TEMPORARILY | CLOSED_PERMANENTLY)opcional

Whether the business is open: OPEN, CLOSED_TEMPORARILY or CLOSED_PERMANENTLY. Send null to clear it.

openingDatestringopcional

When the business opened or will open, as YYYY-MM-DD. Send null to clear it.

googleAdsPhonestringopcional

The phone number Google Ads call extensions use for this location. Send null to clear it.

relationshipDataobjectopcional

Chain membership and parent or child links as Google models them: parentChain (chains/{id} or null), parentLocation (a placeId and relationType) and childrenLocations (a list of the same). It replaces the stored value; send null to clear it.

businessEmailstringopcional

Um e-mail de contato público para o negócio.

categoryIdstringopcional

Id da categoria geral, de GET /api/v1/locations/categories. Um local precisa de uma categoria: envie isto, categoryName ou publisherCategories.google.

categoryNamestringopcional

Nome de exibição da categoria geral. Um local precisa de uma categoria: envie isto, categoryId ou publisherCategories.google. Um nome que não está no catálogo é mantido como categoria de exibição.

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

serviceAreaobjectopcional

Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.

businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório

CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.

placesarray of objectopcional

Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.

namestringobrigatório

placeIdstringopcional

ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.

placeTypestring (country | administrativeArea | locality | postalCode)opcional

publisherServiceAreasobjectopcional

Uma área de atendimento diferente para Google, Facebook, Apple ou Bing, cada uma no mesmo formato de serviceArea, salva como o valor próprio desse publisher. Envie null para um publisher para remover o valor próprio dele, e ele volta a usar serviceArea. Envie junto com serviceArea para definir Master e publishers em uma única chamada. Não pode ser combinado com applyToPublishers.

googleobjectopcional

Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.

businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório

CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.

placesarray of objectopcional

Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.

namestringobrigatório

placeIdstringopcional

ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.

placeTypestring (country | administrativeArea | locality | postalCode)opcional

facebookobjectopcional

Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.

businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório

CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.

placesarray of objectopcional

Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.

namestringobrigatório

placeIdstringopcional

ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.

placeTypestring (country | administrativeArea | locality | postalCode)opcional

appleobjectopcional

Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.

businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório

CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.

placesarray of objectopcional

Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.

namestringobrigatório

placeIdstringopcional

ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.

placeTypestring (country | administrativeArea | locality | postalCode)opcional

bingobjectopcional

Configurações de área de atendimento no Master, para uma empresa que atende os clientes no local deles. Defina businessType como CUSTOMER_LOCATION_ONLY para ocultar o endereço: nenhum publisher recebe uma rua que exibiria, mesmo que haja uma salva. Envie null para remover. Para definir apenas para alguns publishers, use publisherServiceAreas ou applyToPublishers.

businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório

CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.

placesarray of objectopcional

Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.

namestringobrigatório

placeIdstringopcional

ID de lugar do Google da área. O Google só aceita lugares que tenham um, então um lugar sem ele é salvo, mas não é enviado ao Google.

placeTypestring (country | administrativeArea | locality | postalCode)opcional

socialLinksobjectopcional

URLs de perfis sociais: facebook, instagram, twitter, linkedin, youtube, tiktok, pinterest. Na atualização, só mudam as chaves enviadas; null remove uma. Publicados no Google como seus atributos url_* e no Bing e na Apple.

facebookstringopcional

instagramstringopcional

twitterstringopcional

linkedinstringopcional

youtubestringopcional

tiktokstringopcional

pintereststringopcional

paymentMethodsarray of stringopcional

Formas de pagamento aceitas, por exemplo "Visa", "American Express", "Cash only". Substitui a lista inteira; uma lista vazia ou null a limpa. Publicadas no Google como seus atributos pay_* e na Apple e no Bing.

attributesobjectopcional

Atributos do Perfil da Empresa no Google, como um mapa de id de atributo para valor (ex.: { "attributes/wi_fi": "free" }). SUBSTITUI o conjunto inteiro, incluindo links url_* como os de agendamento ou de concessionária, então leia os atuais com GET /api/v1/locations/{id} e envie de volta tudo o que quiser manter. Ids que o Google não oferece para a categoria do local não são salvos e voltam em rejectedAttributes; o restante da atualização é aplicado mesmo assim. Ids de redes sociais, cardápio e pagamento (url_facebook, url_menu, pay_*, …) também voltam ali: defina-os com socialLinks, menuUrl e paymentMethods.

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.

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 valor comum que todos herdam. Cada publisher listado publica o próprio valor; os demais continuam usando o valor principal. É salvo mesmo enquanto o publisher não está conectado e publicado assim que ele se conecta. Remova com clearPublisherOverrides.

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.

socialLinksobjectopcional

URLs de perfis sociais por rede, ou null.

paymentMethodsarray of stringopcional

Formas de pagamento aceitas, como nomes de exibição.

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.

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.

serviceAreaobjectopcional

Configurações de área de atendimento no Master, ou null para uma loja física comum.

businessTypestring (CUSTOMER_LOCATION_ONLY | CUSTOMER_AND_BUSINESS_LOCATION)obrigatório

CUSTOMER_LOCATION_ONLY oculta o endereço (somente área de atendimento). CUSTOMER_AND_BUSINESS_LOCATION mostra o endereço e as áreas atendidas.

placesarray of objectopcional

Áreas atendidas, até 20. Cada uma é { name, placeId?, placeType? }. O Google e o Bing as publicam. O Facebook e a Apple não têm uma lista de áreas de atendimento, então para eles vale apenas a rua oculta.

publisherOverridesobjectopcional

Valores por publisher diferentes do Master, com as chaves google, facebook, apple ou bing. Cada publisher publica esses valores; um publisher sem entrada para um campo usa o valor do Master. Mantidos estando ou não o publisher conectado.

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": []
  }
}

Atualizar um local

Guias que usam este endpoint