v1Recursos/Connections/postVista previa de la creación de listados de Google

Vista previa de la creación de listados de Google

Comprueba si cada ubicación de la selección puede tener un nuevo listado de Google, sin crear ni guardar nada. El flujo empieza aquí: envía solo locationIds para obtener la preparación de cada ubicación y, en accounts, los inicios de sesión de Google que pueden crear para todos los clientes de la selección. Después de elegir un grupo con el endpoint destinations, vuelve a llamar a preview con accountConnectionId y googleAccountName para comprobar ese destino. Cuando canSubmit sea true, envía el mismo body, junto con confirmedNoExistingProfiles, al endpoint create. Los ids de ubicaciones a los que no tienes acceso vuelven en unavailableIds en lugar de hacer fallar la solicitud. Hasta 200 ubicaciones por solicitud. Comprobar un grupo lo lee en vivo desde Google, así que esa llamada puede devolver 502.

post/api/v1/connections/google-listing-create/preview
connections:read
Cuerpo de la solicitud
locationIdsarray of stringobligatorio
Los ids de las ubicaciones con las que trabajar, hasta 200. Los duplicados se ignoran.
accountConnectionIdstringopcional
El connectionId del inicio de sesión de Google con el que crear, tomado de accounts en la respuesta de preview. Obligatorio para destinations y create. Opcional para preview, donde lo envías junto con googleAccountName para comprobar un destino.
googleAccountNamestringopcional
El resourceName del grupo de Google donde crear los listados, por ejemplo accounts/123456789, tomado de la respuesta de destinations. Obligatorio para create. Opcional para preview.
Respuesta
dataobjectopcional
countsobjectopcional
Cuántas ubicaciones hay en cada estado.
readyintegeropcional
Ubicaciones que se pueden crear tal como están.
reviewintegeropcional
Ubicaciones que se pueden crear, pero conviene revisar antes.
needs_attentionintegeropcional
Ubicaciones que necesitan una corrección antes de poder crearse.
excludedintegeropcional
Ubicaciones que no tendrán un nuevo listado de Google.
unavailableintegeropcional
Ids solicitados que no se encontraron o a los que no tienes acceso.
locationsarray of objectopcional
La preparación de cada ubicación solicitada a la que tienes acceso.
locationIdstringopcional
El id de la ubicación.
clientIdstringopcional
El cliente al que pertenece la ubicación, o null.
namestringopcional
El nombre comercial de la ubicación, o null.
statestring (ready | review | needs_attention | excluded)opcional
ready (se puede crear), review (se puede crear, pero revísala antes porque Google podría tener ya un perfil para ella), needs_attention (corrige la ubicación y vuelve a llamar a preview) o excluded (no tendrá un nuevo listado de 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 qué la ubicación está en este estado. Excluida: archived, already_connected, creating (ya hay una creación en curso), needs_reconnection (vinculada a un listado de Google cuyo acceso venció), google_excluded_by_package (Google no forma parte del paquete de listados de la ubicación) u opted_out. Necesita corrección: missing_business_name, missing_google_category o missing_address (sin calle, ciudad y país, y sin área de servicio). Revisión: possible_existing_profile (un listado de Google encontrada en uno de tus inicios de sesión coincide con esta ubicación) o previously_connected (la ubicación estuvo vinculada a Google y se desconectó). Vacío para una ubicación en estado ready.
unavailableIdsarray of stringopcional
Ids de ubicaciones solicitados que no se encontraron o a los que no tienes acceso. Se listan aquí en lugar de hacer fallar la solicitud.
accountsarray of objectopcional
Inicios de sesión de Google que pueden crear para todos los clientes de la selección, incluidos los que hay que volver a conectar. Los de la agencia aparecen primero. Vacío cuando todas las ubicaciones seleccionadas están excluidas o cuando ningún inicio de sesión cubre a todos los clientes.
connectionIdstringopcional
El id de conexión del inicio de sesión. Envíalo como accountConnectionId.
displayNamestringopcional
El nombre visible del inicio de sesión, normalmente el correo de la cuenta de Google.
ownerobjectopcional
A quién pertenece el inicio de sesión: a la agencia o a un cliente.
typestring (agency | client)opcional
agency para un inicio de sesión de toda la agencia, client para uno que pertenece a un solo cliente.
clientIdstringopcional
El id del cliente dueño del inicio de sesión. Solo aparece cuando type es client.
namestringopcional
El nombre comercial del cliente dueño del inicio de sesión. Solo aparece cuando type es client.
statusstring (ready | needs_reconnection)opcional
ready cuando el inicio de sesión se puede usar, needs_reconnection cuando su acceso venció y alguien tiene que volver a conectarlo primero.
noCommonAccountbooleanopcional
True cuando algunas ubicaciones podrían crearse pero ningún inicio de sesión cubre a todos sus clientes. Divide la selección por cliente y vuelve a intentarlo.
destinationobjectopcional
El resultado de comprobar el destino que enviaste.
selectedbooleanopcional
False cuando no enviaste ni accountConnectionId ni googleAccountName.
validbooleanopcional
Si el inicio de sesión y el grupo se pueden usar para esta selección. Aparece cuando selected es true.
resourceNamestringopcional
El nombre de recurso del grupo comprobado. Aparece cuando valid es true.
reasonstring (account_unavailable | group_unavailable | group_not_creatable)opcional
Por qué no se puede usar el destino: account_unavailable (el inicio de sesión no puede crear para esta selección o hay que volver a conectarlo), group_unavailable (el grupo no se encontró en el inicio de sesión o googleAccountName no tiene la forma accounts/123456789) o group_not_creatable (el grupo no admite nuevos listados). Aparece cuando valid es false.
submittableCountintegeropcional
Cuántas ubicaciones pondría en cola create: ready más review.
canSubmitbooleanopcional
True cuando el destino es válido y al menos una ubicación se puede crear.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
502No se pudo contactar con Google para leer los grupos del inicio de sesión. Inténtalo de nuevo más tarde. El code de la respuesta es provider_unavailable.
post/api/v1/connections/google-listing-create/preview
Su clave de API
Cuerpo de la solicitud*
{}

Guías que usan este recurso