v1Recursos/Locations/getObter um local

Obter um local

Retorna o perfil comercial completo de um local: endereço, horários, categorias, atributos, serviços, mídia e status de verificação.

get/api/v1/locations/{id}

locations:read

Parâmetros de consulta

idstringobrigatório

O local a consultar.

Resposta

dataobjectopcional

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.

closedbooleanopcional

periodsarray of objectopcional

openstringopcional

closestringopcional

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.

Erros

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.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

get/api/v1/locations/{id}

Sua chave de API

id *

{
  "data": {
    "id": "loc_456",
    "name": "Acme Dental — Downtown",
    "description": null,
    "tagline": null,
    "storeCode": null,
    "logoUrl": null,
    "street": "123 Main St",
    "street1": null,
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701",
    "country": "US",
    "latitude": 30.2672,
    "longitude": -97.7431,
    "phone": "+15125551234",
    "additionalPhones": [],
    "website": "https://acmedental.com",
    "businessEmail": null,
    "categoryName": "Dentist",
    "primaryCategoryDisplay": "Dentist",
    "primaryCategoryGoogle": "gcid:dentist",
    "additionalCategories": [],
    "attributes": [
      {
        "id": "attributes/wi_fi",
        "value": true
      }
    ],
    "services": [
      {
        "name": "Teeth Whitening",
        "description": null,
        "price": 150,
        "currency": "USD",
        "googleServiceTypeId": null
      }
    ],
    "ownerName": null,
    "menuUrl": null,
    "yearEstablished": null,
    "tags": [
      "vip"
    ],
    "labels": [],
    "regularHours": [
      {
        "day": "MONDAY",
        "closed": false,
        "periods": [
          {
            "openTime": "09:00",
            "closeTime": "17:00"
          }
        ]
      }
    ],
    "moreHours": [],
    "specialHours": [],
    "mediaByCategory": {
      "EXTERIOR": [
        {
          "url": "https://cdn.synup.com/media/1.jpg"
        }
      ]
    },
    "clientId": "cli_123",
    "archived": false,
    "scheduledArchiveAt": null,
    "verificationStatus": "verified"
  }
}