v1Recursos/Connections/postPrévia da criação de listagens do Google
Prévia da criação de listagens do Google
Verifica se cada local da seleção pode receber uma nova listagem do Google, sem criar nem salvar nada. O fluxo começa aqui: envie apenas locationIds para obter a prontidão de cada local e, em accounts, os logins do Google que podem criar para todos os clientes da seleção. Depois de escolher um grupo com o endpoint destinations, chame preview de novo com accountConnectionId e googleAccountName para verificar esse destino. Quando canSubmit for true, envie o mesmo body, junto com confirmedNoExistingProfiles, para o endpoint create. Ids de locais aos quais você não tem acesso voltam em unavailableIds em vez de fazer a solicitação falhar. Até 200 locais por solicitação. Verificar um grupo faz a leitura ao vivo no Google, então essa chamada pode retornar 502.
post
connections:read/api/v1/connections/google-listing-create/previewCorpo da solicitação
locationIdsarray of stringobrigatório
Os ids dos locais a processar, até 200. Ids duplicados são ignorados.
accountConnectionIdstringopcional
O connectionId do login do Google usado para criar, vindo de accounts na resposta de preview. Obrigatório para destinations e create. Opcional para preview, onde você o envia com googleAccountName para verificar um destino.
googleAccountNamestringopcional
O resourceName do grupo do Google onde as listagens serão criadas, como accounts/123456789, vindo da resposta de destinations. Obrigatório para create. Opcional para preview.
Resposta
dataobjectopcional
countsobjectopcional
Quantos locais estão em cada estado.
readyintegeropcional
Locais que podem ser criados do jeito que estão.
reviewintegeropcional
Locais que podem ser criados, mas devem ser conferidos antes.
needs_attentionintegeropcional
Locais que precisam de uma correção antes de serem criados.
excludedintegeropcional
Locais que não vão receber uma nova listagem do Google.
unavailableintegeropcional
Ids solicitados que não foram encontrados ou aos quais você não tem acesso.
locationsarray of objectopcional
A prontidão de cada local solicitado ao qual você tem acesso.
locationIdstringopcional
O id do local.
clientIdstringopcional
O cliente ao qual o local pertence, ou null.
namestringopcional
O nome comercial do local, ou null.
statestring (ready | review | needs_attention | excluded)opcional
ready (pode ser criado), review (pode ser criado, mas confira antes, porque o Google pode já ter um perfil para ele), needs_attention (corrija o local e chame preview de novo) ou excluded (não vai receber uma nova listagem do Google).
reasonsarray of string (archived | already_connected | creating | needs_reconnection | google_excluded_by_package | opted_out | missing_business_name | missing_google_category | missing_address | possible_existing_profile | previously_connected)opcional
Por que o local está neste estado. Excluído: archived, already_connected, creating (uma criação já está em andamento), needs_reconnection (vinculado a uma listagem do Google cujo acesso expirou), google_excluded_by_package (o Google não faz parte do pacote de listagens do local) ou opted_out. Precisa de correção: missing_business_name, missing_google_category ou missing_address (sem rua, cidade e país, e sem área de atendimento). Conferir: possible_existing_profile (uma listagem do Google encontrada em um dos seus logins corresponde a este local) ou previously_connected (o local já foi vinculado ao Google e foi desconectado). Vazio para um local no estado ready.
unavailableIdsarray of stringopcional
Ids de locais solicitados que não foram encontrados ou aos quais você não tem acesso. Eles aparecem aqui em vez de fazer a solicitação falhar.
accountsarray of objectopcional
Logins do Google que podem criar para todos os clientes da seleção, incluindo os que precisam ser reconectados. Os logins da agência vêm primeiro. Vazio quando todos os locais selecionados estão excluídos ou quando nenhum login cobre todos os clientes.
connectionIdstringopcional
O id de conexão do login. Envie como accountConnectionId.
displayNamestringopcional
O nome de exibição do login, normalmente o e-mail da conta do Google.
ownerobjectopcional
A quem o login pertence: à agência ou a um cliente.
typestring (agency | client)opcional
agency para um login de toda a agência, client para um login que pertence a um único cliente.
clientIdstringopcional
O id do cliente dono do login. Presente apenas quando type é client.
namestringopcional
O nome comercial do cliente dono do login. Presente apenas quando type é client.
statusstring (ready | needs_reconnection)opcional
ready quando o login pode ser usado, needs_reconnection quando o acesso expirou e alguém precisa reconectá-lo primeiro.
noCommonAccountbooleanopcional
True quando alguns locais poderiam ser criados, mas nenhum login cobre todos os clientes deles. Divida a seleção por cliente e tente de novo.
destinationobjectopcional
O resultado da verificação do destino enviado.
selectedbooleanopcional
False quando você não enviou accountConnectionId nem googleAccountName.
validbooleanopcional
Se o login e o grupo podem ser usados para esta seleção. Presente quando selected é true.
resourceNamestringopcional
O nome de recurso do grupo verificado. Presente quando valid é true.
reasonstring (account_unavailable | group_unavailable | group_not_creatable)opcional
Por que o destino não pode ser usado: account_unavailable (o login não pode criar para esta seleção ou precisa ser reconectado), group_unavailable (o grupo não foi encontrado no login, ou googleAccountName não está no formato accounts/123456789) ou group_not_creatable (o grupo não aceita novas listagens). Presente quando valid é false.
submittableCountintegeropcional
Quantos locais create colocaria na fila: ready mais review.
canSubmitbooleanopcional
True quando o destino é válido e pelo menos um local pode ser criado.
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.
502Não foi possível acessar o Google para ler os grupos do login. Tente de novo mais tarde. O code da resposta é provider_unavailable.
post/api/v1/connections/google-listing-create/preview
Sua chave de API
Corpo da solicitação*
{}Guias que usam este recurso
- What Is a Business Listings API?A business listings API manages a business's name, address, hours and more across many publishers at once, with sync status and duplicate detection built in.
- Business Listings API: Complete Developer GuideHow a business listings API works and how to create, update, sync and monitor locations across Google, Apple, Bing and directories with the Synup API.
- Google Business Profile API vs a Listings Management APIHow Google's Business Profile API compares with a listings management API on scope, access, sync status, duplicates and reviews, and when to use each.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Update Business Information Across Google, Apple, Bing and DirectoriesPush one business-information change to Google, Apple, Bing and the directory network through a single API call, and verify it reached each publisher.
- How to Manage Thousands of Business Locations via APIDesign a sync job for thousands of locations on the Synup API with cursor pagination, tags, rate-limit handling, an id map and rollup health checks.
- How Google Business Profile Synchronization WorksGoogle Business Profile sync rests on an owner's OAuth consent, matching a location to the right Google listing, then a write-and-verify loop.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Connect and Manage Google Business Profiles via APIConnect a Google Business Profile to a location, match the account's listings, keep the profile in sync and handle reconnects with the Synup API.
- Building Publisher Integrations Directly vs Using SynupWhat it really costs to integrate Google, Apple, Bing and directories yourself, versus one API, and how to decide between them or combine both.