v1Ressources/Fiches publiées/getObtenir la fiche d'un établissement

Obtenir la fiche d'un établissement

Renvoie l'état de synchronisation par publisher, le statut du profil Google Business et les pistes d'amélioration pour un établissement.

get/api/v1/listings

listings:read

Paramètres de requête

locationIdstringobligatoire

L'établissement à consulter. Obligatoire. Retrouvez-le avec GET /api/v1/locations.

clientIdstringfacultatif

Le client de l'établissement. Nécessaire seulement pour lever une ambiguïté quand votre clé est limitée à des clients spécifiques.

Réponse

dataobjectfacultatif

statsobjectfacultatif

Chiffres résumés sur l'ensemble des publishers de cet établissement.

publishersnumberfacultatif

Nombre total de publishers suivis.

syncednumberfacultatif

Nombre de publishers actuellement synchronisés.

notConnectednumberfacultatif

Nombre de publishers pas encore connectés.

googleVerifiedLocationsnumberfacultatif

Nombre d'établissements vérifiés par Google.

duplicatesnumberfacultatif

Nombre de fiches en double détectées.

connectionIssuesnumberfacultatif

Nombre de publishers ayant un problème de connexion.

requiresActionnumberfacultatif

Nombre de publishers nécessitant une action.

publishersarray of objectfacultatif

État de synchronisation par publisher.

publisherIdstringfacultatif

Identifiant de l'annuaire/publisher.

publisherNamestringfacultatif

Nom d'affichage du publisher.

L'une des valeurs : synced, in_progress, failed, requires_action, not_connected, expired, suspended, pending_approval, inaccessible, credentials_invalidated, not_available.

liveLinksnumberfacultatif

Nombre de liens actifs trouvés pour ce publisher, ou null.

gbpobjectfacultatif

Synthèse du profil Google Business, lorsqu'il est connecté.

connectedbooleanfacultatif

Si un profil Google Business est connecté.

scorenumberfacultatif

Score de complétude du profil, de 0 à 100, ou null.

donearray of stringfacultatif

Éléments d'amélioration du profil déjà réalisés.

todoarray of stringfacultatif

Éléments d'amélioration du profil restant à faire.

opportunitiesarray of objectfacultatif

Améliorations suggérées, chacune avec un message court et un ton.

textstringfacultatif

tonestring (amber | rose | blue | zinc)facultatif

aiobjectfacultatif

Un court titre généré par IA et jusqu'à 3 corrections prioritaires pour cet établissement, ou null.

headlinestringfacultatif

Résumé en une phrase de l'état des fiches de cet établissement.

fixFirstarray of objectfacultatif

Jusqu'à 3 actions suggérées, classées par impact.

textstringfacultatif

impactstring (High | Med | Low)facultatif

noticestringfacultatif

Une note lisible sur les données de fiches de cet établissement, ou null.

Erreurs

400Il manque un paramètre requis à la requête, ou elle est invalide.

401Clé API manquante, invalide, expirée ou révoquée.

403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.

404La ressource est introuvable, ou n'appartient pas à votre agence.

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

get/api/v1/listings

Votre clé 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
  }
}