v1Ressourcen/Connections/postVorschau der Google-Eintragserstellung

Vorschau der Google-Eintragserstellung

Prüft, ob jeder Standort der Auswahl einen neuen Google-Eintrag bekommen kann, ohne etwas zu erstellen oder zu speichern. Hier beginnt der Ablauf: Senden Sie nur locationIds, um die Bereitschaft jedes Standorts und in accounts die Google-Logins zu erhalten, die für jeden Kunden der Auswahl erstellen dürfen. Nachdem Sie mit dem destinations-Endpunkt eine Gruppe gewählt haben, rufen Sie preview erneut mit accountConnectionId und googleAccountName auf, um dieses Ziel zu prüfen. Ist canSubmit true, senden Sie denselben Body zusammen mit confirmedNoExistingProfiles an den create-Endpunkt. Standort-IDs, auf die Sie keinen Zugriff haben, kommen in unavailableIds zurück, statt die Anfrage scheitern zu lassen. Bis zu 200 Standorte pro Anfrage. Die Prüfung einer Gruppe liest sie live von Google, daher kann dieser Aufruf 502 zurückgeben.

post/api/v1/connections/google-listing-create/preview
connections:read
Anfragetext
locationIdsarray of stringerforderlich
Die IDs der zu bearbeitenden Standorte, höchstens 200. Doppelte IDs werden ignoriert.
accountConnectionIdstringoptional
Die connectionId des Google-Logins, unter dem erstellt wird, aus accounts in der preview-Antwort. Pflicht für destinations und create. Optional für preview, wo Sie sie zusammen mit googleAccountName senden, um ein Ziel zu prüfen.
googleAccountNamestringoptional
Der resourceName der Google-Gruppe, in der die Einträge erstellt werden, etwa accounts/123456789, aus der destinations-Antwort. Pflicht für create. Optional für preview.
Antwort
dataobjectoptional
countsobjectoptional
Wie viele Standorte in jeden Zustand fallen.
readyintegeroptional
Standorte, die so erstellt werden können, wie sie sind.
reviewintegeroptional
Standorte, die erstellt werden können, aber vorher geprüft werden sollten.
needs_attentionintegeroptional
Standorte, die vor der Erstellung korrigiert werden müssen.
excludedintegeroptional
Standorte, die keinen neuen Google-Eintrag bekommen.
unavailableintegeroptional
Angefragte IDs, die nicht gefunden wurden oder auf die Sie keinen Zugriff haben.
locationsarray of objectoptional
Die Bereitschaft jedes angefragten Standorts, auf den Sie Zugriff haben.
locationIdstringoptional
Die ID des Standorts.
clientIdstringoptional
Der Kunde, zu dem der Standort gehört, oder null.
namestringoptional
Der Unternehmensname des Standorts oder null.
statestring (ready | review | needs_attention | excluded)optional
ready (kann erstellt werden), review (kann erstellt werden, sollte aber zuerst geprüft werden, weil Google möglicherweise schon ein Profil dafür hat), needs_attention (korrigieren Sie den Standort und rufen Sie preview erneut auf) oder excluded (bekommt keinen neuen Google-Eintrag).
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)optional
Warum der Standort in diesem Zustand ist. Ausgeschlossen: archived, already_connected, creating (eine Erstellung läuft bereits), needs_reconnection (mit einem Google-Eintrag verknüpft, dessen Zugriff abgelaufen ist), google_excluded_by_package (Google gehört nicht zum Eintragspaket des Standorts) oder opted_out. Korrektur nötig: missing_business_name, missing_google_category oder missing_address (keine Straße, Stadt und kein Land und kein Einzugsgebiet). Prüfung: possible_existing_profile (ein unter einem Ihrer Logins gefundener Google-Eintrag passt zu diesem Standort) oder previously_connected (der Standort war früher mit Google verknüpft und wurde getrennt). Leer bei einem Standort im Zustand ready.
unavailableIdsarray of stringoptional
Angefragte Standort-IDs, die nicht gefunden wurden oder auf die Sie keinen Zugriff haben. Sie werden hier aufgeführt, statt die Anfrage scheitern zu lassen.
accountsarray of objectoptional
Google-Logins, die für jeden Kunden der Auswahl erstellen dürfen, einschließlich solcher, die neu verbunden werden müssen. Agentur-Logins stehen zuerst. Leer, wenn alle ausgewählten Standorte ausgeschlossen sind oder kein einzelner Login alle Kunden abdeckt.
connectionIdstringoptional
Die Verbindungs-ID des Logins. Senden Sie sie als accountConnectionId.
displayNamestringoptional
Der Anzeigename des Logins, meist die E-Mail-Adresse des Google-Kontos.
ownerobjectoptional
Wem der Login gehört: der Agentur oder einem Kunden.
typestring (agency | client)optional
agency für einen agenturweiten Login, client für einen Login, der einem Kunden gehört.
clientIdstringoptional
Die ID des Kunden, dem der Login gehört. Nur vorhanden, wenn type client ist.
namestringoptional
Der Unternehmensname des Kunden, dem der Login gehört. Nur vorhanden, wenn type client ist.
statusstring (ready | needs_reconnection)optional
ready, wenn der Login genutzt werden kann, needs_reconnection, wenn sein Zugriff abgelaufen ist und ihn zuerst jemand neu verbinden muss.
noCommonAccountbooleanoptional
True, wenn einige Standorte erstellt werden könnten, aber kein einzelner Login alle ihre Kunden abdeckt. Teilen Sie die Auswahl nach Kunden auf und versuchen Sie es erneut.
destinationobjectoptional
Das Ergebnis der Prüfung des gesendeten Ziels.
selectedbooleanoptional
False, wenn Sie weder accountConnectionId noch googleAccountName gesendet haben.
validbooleanoptional
Ob Login und Gruppe für diese Auswahl genutzt werden können. Vorhanden, wenn selected true ist.
resourceNamestringoptional
Der Ressourcenname der geprüften Gruppe. Vorhanden, wenn valid true ist.
reasonstring (account_unavailable | group_unavailable | group_not_creatable)optional
Warum das Ziel nicht genutzt werden kann: account_unavailable (der Login darf für diese Auswahl nicht erstellen oder muss neu verbunden werden), group_unavailable (die Gruppe wurde unter dem Login nicht gefunden oder googleAccountName hat nicht die Form accounts/123456789) oder group_not_creatable (die Gruppe kann keine neuen Einträge aufnehmen). Vorhanden, wenn valid false ist.
submittableCountintegeroptional
Wie viele Standorte create einreihen würde: ready plus review.
canSubmitbooleanoptional
True, wenn das Ziel gültig ist und mindestens ein Standort erstellt werden kann.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
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.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
502Google war nicht erreichbar, um die Gruppen des Logins zu lesen. Versuchen Sie es später erneut. Der code der Antwort ist provider_unavailable.
post/api/v1/connections/google-listing-create/preview
Ihr API-Schlüssel
Anfragetext*
{}

Anleitungen, die diese Ressource verwenden