v1Ressourcen/Veröffentlichte Einträge/getListing-Probleme abrufen

Listing-Probleme abrufen

Die in der Listings-Übersicht angezeigten Probleme als Daten. Jedes Problem ist eine Korrektur (eine Bearbeitung, eine Anmeldung oder ein Schritt außerhalb der App) und nennt die Publisher-Einträge, die diese Korrektur freigeben würde. Mit locationId werden alle Probleme dieses Standorts zurückgegeben. Ohne locationId erhalten Sie eine Zusammenfassung über die Standorte Ihres Schlüssels, optional auf einen Kunden und ein Tag eingegrenzt, seitenweise nach Standorten gelesen: Wiederholen Sie den Aufruf mit cursor gleich page.nextCursor und denselben übrigen Parametern, bis page.nextCursor null ist. Nur lesend.

get/api/v1/listings/issues
listings:read
Query-Parameter
locationIdstringoptional
Liest die Probleme eines Standorts, per ID oder öffentlicher loc_-ID. Weglassen für eine Zusammenfassung über mehrere Standorte.
clientIdstringoptional
Beschränkt das Lesen auf die Standorte eines Kunden.
tagstringoptional
Beschränkt die Zusammenfassung auf Standorte mit diesem Tag-Namen. Wird ignoriert, wenn locationId gesetzt ist.
problemstringoptional
Kommagetrennte Problem-Schlüssel, die einbezogen werden, zum Beispiel phone,hours. Ein unbekannter Schlüssel ergibt 400 mit code invalid_problem.
familystringoptional
Kommagetrennte Problemfamilien, die einbezogen werden: access, identity, hours, content, media, map oder other. Eine unbekannte Familie ergibt 400 mit code invalid_family.
qstringoptional
Durchsucht die Zusammenfassung nach Standortnamen, ohne Beachtung der Groß-/Kleinschreibung, bis zu 100 Zeichen.
cursorstringoptional
Der page.nextCursor aus der vorherigen Antwort, um eine Zusammenfassung fortzusetzen. Senden Sie ihn mit denselben übrigen Parametern: Ein Cursor, der für einen anderen Geltungsbereich oder Filter ausgegeben wurde, ergibt 400 mit code cursor_scope_mismatch.
Antwort
dataobjectoptional
scopeobjecterforderlich
kindstring (location | rollup)optional
keystringoptional
clientIdstringoptional
tagstringoptional
locationIdstringoptional
requestedLocationIdstringoptional
filtersobjectoptional
problemsarray of stringoptional
familiesarray of stringoptional
qstringoptional
generatedAtstringerforderlich
completebooleanerforderlich
Nur dann true, wenn diese eine Antwort alle Standorte im Geltungsbereich abgedeckt hat. Dann ist totals exakt, andernfalls ist totals null.
totalsobjecterforderlich
fixesintegererforderlich
Verschiedene Korrekturen. Eine erneute Verbindung eines gemeinsam genutzten Kontos zählt einmal, egal wie viele Standorte sie abdeckt.
affectedListingsintegererforderlich
locationsWithIssuesintegererforderlich
pageCountsobjecterforderlich
fixesintegererforderlich
Verschiedene Korrekturen. Eine erneute Verbindung eines gemeinsam genutzten Kontos zählt einmal, egal wie viele Standorte sie abdeckt.
affectedListingsintegererforderlich
locationsWithIssuesintegererforderlich
pageobjecterforderlich
scopeLocationsintegeroptional
scannedLocationsintegeroptional
previouslyScannedintegeroptional
nextCursorstringoptional
Übergeben Sie diesen Wert als cursor, mit denselben übrigen Parametern, um die nächste Seite mit Standorten zu lesen. Null, wenn es keine weiteren Seiten gibt.
lastPagebooleanoptional
noticestring (archived | not_a_listing_location)erforderlich
issuesarray of objecterforderlich
idstringerforderlich
fixKeystringerforderlich
groupKeystringerforderlich
locationIdstringerforderlich
locationPublicIdstringoptional
locationNamestringoptional
locationCitystringoptional
clientIdstringoptional
clientNamestringoptional
problemstringerforderlich
Was falsch ist, als stabiler Problem-Schlüssel, zum Beispiel phone oder reconnect_google.
familystring (access | identity | hours | content | media | map | other)erforderlich
tierinteger (1 | 2 | 3)erforderlich
statestring (open | update_in_flight | update_saved)erforderlich
reasonKeystringoptional
fixobjecterforderlich
Die Aktion, die dieses Problem behebt. kind gibt an, welche: edit (ein Feld im Standort-Editor), connect, account (dasselbe Konto erneuern), verify (bei Google), external (ein Schritt auf einer anderen Website) oder explain (keine Korrektur in der App).
kindstring (edit | connect | account | verify | external | explain)erforderlich
sectionstring (identity | hours | description | social | media | businessDetails | openStatus | actionLinks | serviceArea | services | attributes | relationships | pin)optional
fieldstring (name | address | phone | website | primaryCategory | publisherCategory | hours | openingDate | openStatus | description | socialLinks | menuUrl | photos | serviceArea | services | attributes | relationships | coordinates)optional
tabstring (master | google | facebook | apple | bing)optional
providerstring (google | facebook | apple)optional
flowstring (renew)optional
accountobjectoptional
launchobjectoptional
targetobjectoptional
nextstring (contact_support | review_details | no_in_app_fix)optional
capabilityobjecterforderlich
allowedbooleanerforderlich
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)erforderlich
alternativesarray of objectoptional
fixobjectoptional
Die Aktion, die dieses Problem behebt. kind gibt an, welche: edit (ein Feld im Standort-Editor), connect, account (dasselbe Konto erneuern), verify (bei Google), external (ein Schritt auf einer anderen Website) oder explain (keine Korrektur in der App).
capabilityobjectoptional
publishersarray of objecterforderlich
publisherIdstringoptional
publisherNamestringoptional
siteIdintegeroptional
affectedListingsintegererforderlich
evidenceAtstringoptional
groupsarray of objecterforderlich
groupKeystringoptional
problemstringoptional
familystringoptional
tierintegeroptional
accountobjectoptional
keystringerforderlich
Ein undurchsichtiger, stabiler Schlüssel für die Zugangsdaten des Kontos. Gruppieren Sie danach, nie nach dem Label.
labelstringerforderlich
agencyManagedbooleanerforderlich
locationsarray of objectoptional
locationIdstringoptional
locationPublicIdstringoptional
locationNamestringoptional
locationCitystringoptional
clientIdstringoptional
clientNamestringoptional
issueIdstringoptional
problemstringoptional
statestring (open | update_in_flight | update_saved)optional
affectedListingsintegeroptional
fixesintegeroptional
affectedListingsintegeroptional
affectedLocationsintegeroptional
Fehler
400Die Abfrage ist ungültig. code nennt den Grund: invalid_cursor, cursor_scope_mismatch, invalid_problem, invalid_family oder search_too_long.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/listings/issues
Ihr API-Schlüssel
locationId
clientId
tag
problem
family
q
cursor
{}

Anleitungen, die diese Ressource verwenden