v1Recursos/Listados publicados/getObtener el listado de una ubicación

Obtener el listado de una ubicación

Devuelve el estado de sincronización entre publishers, el estado del perfil de Google Business y las oportunidades de mejora de una ubicación.

get/api/v1/listings

listings:read

Parámetros de consulta

locationIdstringobligatorio

La ubicación a consultar. Obligatorio. Búsquelo con GET /api/v1/locations.

clientIdstringopcional

El cliente de la ubicación. Solo necesario para desambiguar cuando su clave está limitada a clientes específicos.

Respuesta

dataobjectopcional

statsobjectopcional

Cifras resumidas de todos los publishers de esta ubicación.

publishersnumberopcional

Número total de publishers registrados.

syncednumberopcional

Número de publishers actualmente sincronizados.

notConnectednumberopcional

Número de publishers aún no conectados.

googleVerifiedLocationsnumberopcional

Número de ubicaciones verificadas por Google.

duplicatesnumberopcional

Número de listados duplicados detectados.

connectionIssuesnumberopcional

Número de publishers con un problema de conexión.

requiresActionnumberopcional

Número de publishers que requieren una acción.

publishersarray of objectopcional

Estado de sincronización por publisher.

publisherIdstringopcional

Identificador del directorio/publisher.

publisherNamestringopcional

Nombre visible del publisher.

Uno de: synced, in_progress, failed, requires_action, not_connected, expired, suspended, pending_approval, inaccessible, credentials_invalidated, not_available.

liveLinksnumberopcional

Número de enlaces activos encontrados para este publisher, o null.

gbpobjectopcional

Resumen del perfil de Google Business, cuando está conectado.

connectedbooleanopcional

Si hay un perfil de Google Business conectado.

scorenumberopcional

Puntuación de completitud del perfil, 0–100, o null.

donearray of stringopcional

Elementos de mejora del perfil ya completados.

todoarray of stringopcional

Elementos de mejora del perfil pendientes.

opportunitiesarray of objectopcional

Mejoras sugeridas, cada una con un mensaje breve y un tono.

textstringopcional

tonestring (amber | rose | blue | zinc)opcional

aiobjectopcional

Un breve titular generado por IA y hasta 3 correcciones priorizadas para esta ubicación, o null.

headlinestringopcional

Resumen de una frase sobre el estado de los listados de esta ubicación.

fixFirstarray of objectopcional

Hasta 3 acciones sugeridas, ordenadas por impacto.

textstringopcional

impactstring (High | Med | Low)opcional

noticestringopcional

Un aviso legible sobre los datos de listados de esta ubicación, o null.

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.

404El recurso no se encontró, o no pertenece a su agencia.

429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.

get/api/v1/listings

Su clave de API

locationId *

clientId

{
  "data": {
    "stats": {
      "publishers": 42,
      "synced": 38,
      "notConnected": 2,
      "googleVerifiedLocations": 1,
      "duplicates": 0,
      "connectionIssues": 1,
      "requiresAction": 1
    },
    "publishers": [
      {
        "publisherId": "google",
        "publisherName": "Google",
        "status": "synced",
        "liveLinks": 1
      }
    ],
    "gbp": {
      "connected": true,
      "score": 82,
      "done": [
        "Business name",
        "Address"
      ],
      "todo": [
        "Add photos"
      ]
    },
    "opportunities": [
      {
        "text": "Add more photos to your Google profile",
        "tone": "amber"
      }
    ],
    "ai": {
      "headline": "90% synced — 1 listing needs action.",
      "fixFirst": [
        {
          "text": "Reconnect 1 listing needing action.",
          "impact": "High"
        }
      ]
    },
    "notice": null
  }
}