POST/api/v4/locations/create/gmb-listing

Criar uma listagem do GMB para um local

Cria uma nova listagem do Google Business Profile para um local existente na Listings API e a vincula a uma conta do Google conectada.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Corpo

NomeTipoObrigatórioDescrição
inputobjectobrigatórioWrapper object. The entire request body must be nested under `input`.
input.locationIdstringobrigatórioBase64-encoded location Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) of the location to create the Google listing for.
input.connectedAccountIdstringobrigatórioUUID of the connected Google account the new listing should be created under. Taken from `GET /connected-accounts`.
input.folderIdstringopcionalGoogle account group to create the listing inside, as the `accounts/{id}` string from the folders endpoint. Omit to create it at the account root.

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5"  }}

Respostas

200Request accepted. `success: true` means GMB listing creation was initiated.
Response
{  "data": {    "createGmbListingForLocation": {      "clientMutationId": null,      "success": true,      "errors": null    }  }}
400Bad request, the body was not wrapped in `input` (error message: `Variable "$input" of required type "CreateGmbListingForLocationInput!" was not provided`).
401Unauthenticated, missing or invalid API key.

Cria uma listagem inteiramente nova do Google Business Profile para um local da Listings API e a associa a uma conta do Google conectada. Use esta operação quando o local ainda não tiver nenhuma listagem no Google, ao contrário de connect-listing, que vincula um local da Listings API a uma listagem que já existe na conta do Google.

Estrutura da solicitação. O corpo deve estar contido em um objeto input com dois campos obrigatórios: locationId (o Relay ID do local codificado em base64) e connectedAccountId (a conta do Google na qual a listagem será criada). folderId é opcional; informe esse valor para colocar a nova listagem em um grupo específico da conta do Google, usando o valor obtido em Listar pastas sem alterações. O envio de um corpo sem o objeto que o envolve é rejeitado com HTTP 400.

A criação é assíncrona: success: true significa que a solicitação foi aceita, não que a listagem esteja publicada imediatamente. O Google analisa os novos perfis antes de serem publicados.

Caso de uso: configurar a presença no Google para um estabelecimento físico inteiramente novo. Um cliente abre um novo local que ainda não tem um Google Business Profile. Crie o local na Listings API, conecte a conta do Google do cliente e, em seguida, chame este endpoint com o ID do local e connectedAccountId para que a Listings API envie a nova listagem ao Google nessa conta. Depois, consulte periodicamente as listagens do local para acompanhar a transição da nova listagem de pendente para verificada.

O local já deve conter informações comerciais válidas (nome, endereço, telefone) antes que uma listagem possa ser criada, e só pode existir uma listagem do Google por local. Em caso de falha, errors explica o motivo: geralmente, faltam campos obrigatórios no local, o local já tem uma listagem do Google, está arquivado ou a conta conectada não está ativa. Reconecte uma conta cuja conexão esteja desatualizada usando o endpoint connect-google. Observe que o endpoint atualmente retorna success: true mesmo quando connectedAccountId não é uma conta do Google real e conectada, portanto confirme se a listagem realmente aparece (por meio das listagens do local), em vez de confiar apenas em success.

Request
curl -X POST 'https://listingsapi.com/api/v4/locations/create/gmb-listing' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5"    }  }'