v1Recursos/Connections/postCriar listagens do Google

Criar listagens do Google

Coloca na fila um novo Google Business Profile para cada local da seleção que pode receber um. Esta é a versão em API de Criar fichas do Google no Location Manager e a última etapa do fluxo: chame preview com locationIds para ver a prontidão e os logins disponíveis, liste os grupos de um login com destinations, chame preview de novo com accountConnectionId e googleAccountName até canSubmit ser true e então envie o mesmo body aqui. Tudo é verificado de novo nesta chamada, então uma prévia anterior não vale como garantia. Locais no estado ready ou review entram na fila, e os demais voltam em skipped. confirmedNoExistingProfiles precisa ser true, ou a solicitação retorna 400. Um 202 significa que o trabalho está na fila, não que os perfis já existem: a criação roda em segundo plano e pode ser repetida ou falhar, então consulte o endpoint de status. Retorna 409 quando o login ou o grupo não pode ser usado para esta seleção, ou quando nenhum dos locais pode ser criado.

post/api/v1/connections/google-listing-create
connections:write
Corpo da solicitação
locationIdsarray of stringobrigatório
Os ids dos locais a processar, até 200. Ids duplicados são ignorados.
accountConnectionIdstringobrigatório
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.
googleAccountNamestringobrigatório
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.
confirmedNoExistingProfilesboolean (true)obrigatório
Precisa ser true. Confirma que essas empresas precisam de novos perfis do Google e ainda não têm um. Qualquer outro valor retorna 400.
Resposta
dataobjectopcional
resultsarray of objectopcional
Uma entrada para cada local que create tentou colocar na fila.
locationIdstringopcional
O id do local.
outcomestring (queued | blocked | failed_to_queue)opcional
queued (a criação está a caminho), blocked (não foi permitida, veja reason) ou failed_to_queue (algo deu errado do nosso lado, então tente de novo).
connectionIdstringopcional
A nova conexão pendente do Google do local. Presente apenas com queued.
orderItemIdstringopcional
O id do pedido que executa a criação. Presente apenas com queued.
reasonstringopcional
Por que o local não entrou na fila: submission_not_allowed, um código de limite do plano (feature_disabled, location_limit, connection_limit, cancellation_pending ou entitlement) ou internal_error. Ausente com queued.
skippedarray of objectopcional
Locais selecionados que não entraram na fila porque estão excluídos ou precisam de correção, com os mesmos campos de locations na resposta de preview.
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.
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.
409Nada entrou na fila. O code da resposta é invalid_destination quando o login ou o grupo não pode ser usado para esta seleção, ou invalid_request quando nenhum dos locais selecionados pode ser criado. Chame preview para ver o motivo.
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
Sua chave de API
Corpo da solicitação*
{}

Guias que usam este recurso