Synup
Créer une clé
v1Ressources/Fiches publiées/getObtenir les problèmes de fiches

Obtenir les problèmes de fiches

Les problèmes affichés dans la vue d'ensemble des fiches, sous forme de données. Chaque problème correspond à une correction (une modification, une connexion ou une étape hors de l'application) et indique les fiches de publishers que cette correction débloquerait. Avec locationId, renvoie tous les problèmes de cet emplacement. Sans lui, renvoie une synthèse sur les emplacements de votre clé, éventuellement limitée à un client et à un tag, lue par pages d'emplacements : répétez l'appel avec cursor égal à page.nextCursor et les mêmes autres paramètres jusqu'à ce que page.nextCursor soit null. Lecture seule.

get/api/v1/listings/issues
listings:read
Paramètres de requête
locationIdstringfacultatif
Lit les problèmes d'un emplacement, par son id ou son id public loc_. Omettez-le pour une synthèse sur plusieurs emplacements.
clientIdstringfacultatif
Limite la lecture aux emplacements d'un client.
tagstringfacultatif
Limite la synthèse aux emplacements portant ce nom de tag. Ignoré lorsque locationId est fourni.
problemstringfacultatif
Clés de problème séparées par des virgules à inclure, par exemple phone,hours. Une clé inconnue renvoie 400 avec code invalid_problem.
familystringfacultatif
Familles de problèmes séparées par des virgules à inclure : access, identity, hours, content, media, map ou other. Une famille inconnue renvoie 400 avec code invalid_family.
qstringfacultatif
Recherche dans la synthèse par nom d'emplacement, sans tenir compte de la casse, jusqu'à 100 caractères.
cursorstringfacultatif
Le page.nextCursor de la réponse précédente, pour poursuivre une synthèse. Envoyez-le avec les mêmes autres paramètres : un curseur émis pour un autre périmètre ou filtre renvoie 400 avec code cursor_scope_mismatch.
Réponse
dataobjectfacultatif
scopeobjectobligatoire
kindstring (location | rollup)facultatif
keystringfacultatif
clientIdstringfacultatif
tagstringfacultatif
locationIdstringfacultatif
requestedLocationIdstringfacultatif
filtersobjectfacultatif
problemsarray of stringfacultatif
familiesarray of stringfacultatif
qstringfacultatif
generatedAtstringobligatoire
completebooleanobligatoire
True uniquement lorsque cette seule réponse a couvert tous les emplacements du périmètre. Dans ce cas totals est exact ; sinon totals est null.
totalsobjectobligatoire
fixesintegerobligatoire
Corrections distinctes. Une reconnexion de compte partagé compte une seule fois, quel que soit le nombre d'emplacements couverts.
affectedListingsintegerobligatoire
locationsWithIssuesintegerobligatoire
pageCountsobjectobligatoire
fixesintegerobligatoire
Corrections distinctes. Une reconnexion de compte partagé compte une seule fois, quel que soit le nombre d'emplacements couverts.
affectedListingsintegerobligatoire
locationsWithIssuesintegerobligatoire
pageobjectobligatoire
scopeLocationsintegerfacultatif
scannedLocationsintegerfacultatif
previouslyScannedintegerfacultatif
nextCursorstringfacultatif
Passez-le comme cursor, avec les mêmes autres paramètres, pour lire la page suivante d'emplacements. Null lorsqu'il n'y a plus de pages.
lastPagebooleanfacultatif
noticestring (archived | not_a_listing_location)obligatoire
issuesarray of objectobligatoire
idstringobligatoire
fixKeystringobligatoire
groupKeystringobligatoire
locationIdstringobligatoire
locationPublicIdstringfacultatif
locationNamestringfacultatif
locationCitystringfacultatif
clientIdstringfacultatif
clientNamestringfacultatif
problemstringobligatoire
Ce qui ne va pas, sous forme de clé de problème stable, par exemple phone ou reconnect_google.
familystring (access | identity | hours | content | media | map | other)obligatoire
tierinteger (1 | 2 | 3)obligatoire
statestring (open | update_in_flight | update_saved)obligatoire
reasonKeystringfacultatif
fixobjectobligatoire
L'action qui résout ce problème. kind indique laquelle : edit (un champ dans l'éditeur d'emplacement), connect, account (renouveler le même compte), verify (sur Google), external (une étape sur un autre site) ou explain (aucune correction dans l'application).
kindstring (edit | connect | account | verify | external | explain)obligatoire
sectionstring (identity | hours | description | social | media | businessDetails | openStatus | actionLinks | serviceArea | services | attributes | relationships | pin)facultatif
fieldstring (name | address | phone | website | primaryCategory | publisherCategory | hours | openingDate | openStatus | description | socialLinks | menuUrl | photos | serviceArea | services | attributes | relationships | coordinates)facultatif
tabstring (master | google | facebook | apple | bing)facultatif
providerstring (google | facebook | apple)facultatif
flowstring (renew)facultatif
accountobjectfacultatif
launchobjectfacultatif
targetobjectfacultatif
nextstring (contact_support | review_details | no_in_app_fix)facultatif
capabilityobjectobligatoire
allowedbooleanobligatoire
reasonstring (write_not_permitted | portal_not_permitted | field_not_portal_editable | clients_module_denied | agency_credential_requires_unrestricted_member | credential_serves_other_clients | account_unresolved | missing_api_scope)obligatoire
alternativesarray of objectfacultatif
fixobjectfacultatif
L'action qui résout ce problème. kind indique laquelle : edit (un champ dans l'éditeur d'emplacement), connect, account (renouveler le même compte), verify (sur Google), external (une étape sur un autre site) ou explain (aucune correction dans l'application).
capabilityobjectfacultatif
publishersarray of objectobligatoire
publisherIdstringfacultatif
publisherNamestringfacultatif
siteIdintegerfacultatif
affectedListingsintegerobligatoire
evidenceAtstringfacultatif
groupsarray of objectobligatoire
groupKeystringfacultatif
problemstringfacultatif
familystringfacultatif
tierintegerfacultatif
accountobjectfacultatif
keystringobligatoire
Une clé opaque et stable pour l'identifiant du compte. Regroupez selon cette clé, jamais selon le libellé.
labelstringobligatoire
agencyManagedbooleanobligatoire
locationsarray of objectfacultatif
locationIdstringfacultatif
locationPublicIdstringfacultatif
locationNamestringfacultatif
locationCitystringfacultatif
clientIdstringfacultatif
clientNamestringfacultatif
issueIdstringfacultatif
problemstringfacultatif
statestring (open | update_in_flight | update_saved)facultatif
affectedListingsintegerfacultatif
fixesintegerfacultatif
affectedListingsintegerfacultatif
affectedLocationsintegerfacultatif
Erreurs
400La requête n'est pas valide. code en indique la raison : invalid_cursor, cursor_scope_mismatch, invalid_problem, invalid_family ou search_too_long.
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/issues
Votre clé API
locationId
clientId
tag
problem
family
q
cursor
{}

Guides qui utilisent cette ressource