Ein Google-Konto verbinden

Parameter

Body

Name	Typ	Erforderlich	Beschreibung
input	object	erforderlich	Wrapper object. The entire request body must be nested under `input`.
input.successUrl	string	erforderlich	URL the user is redirected to after they successfully authorize Google. Must be an absolute https URL you control.
input.errorUrl	string	erforderlich	URL the user is redirected to if they cancel or the authorization fails. Must be an absolute https URL you control.

Antworten

200OAuth URL generated successfully. Redirect the user to `url` to begin the Google authorization flow. The `url` shown is a placeholder; send the user to the `url` returned in your own response.

Response

{  "data": {    "bulkConnectLinkForGoogle": {      "errors": null,      "success": true,      "url": "https://connect.example.com/oauth?token=8f3c1d92-..."    }  }}

400Bad request, the body was not wrapped in `input`, or `successUrl`/`errorUrl` was omitted (error message: `Variable "$input" of required type "GoogleOauthBulkInput!" was not provided`).

401Unauthenticated, missing or invalid API key.

Generiert eine kurzlebige OAuth-URL, die ein Benutzer aufruft, um Listings API zur gebündelten Verwaltung seiner Google Business Profile-Standorte zu autorisieren. Leiten Sie den Benutzer zur zurückgegebenen url weiter; er durchläuft die Einwilligungsseite von Google und wird anschließend zu einer der von Ihnen angegebenen URLs zurückgeleitet. Der Link ist 24 Stunden lang gültig.

Anfragestruktur. Der Body muss in ein input-Objekt eingebettet sein, das die beiden Pflichtfelder successUrl und errorUrl enthält. Dies sind die absoluten https-URLs, zu denen der Benutzer zurückgeleitet wird, nachdem er die Einwilligungsseite von Google abgeschlossen oder abgebrochen hat; geben Sie Endpunkte in Ihrer eigenen Anwendung an, die bei Erfolg das Onboarding fortsetzen und bei einem Fehler einen erneuten Versuch ermöglichen. Es gibt kein accountId-Feld, der Verbindungslink ist immer auf das Konto beschränkt, dem der API-Schlüssel gehört, und das Senden von accountId oder eines flachen, nicht eingebetteten Bodys wird mit HTTP 400 abgelehnt.

Dies ist der erste Schritt des Workflows zur gebündelten Verbindung. Sobald das Konto autorisiert ist, erscheint es im Endpunkt zum Auflisten verbundener Konten (GET /connected-accounts) mit einem connectedAccountId, das Sie für jeden späteren Aufruf verwenden.

Anwendungsfall: Onboarding der Google-Profile eines Agenturkunden. Ein neuer Kunde gewährt Zugriff auf seine Google Business Profile-Profile. Rufen Sie diesen Endpunkt auf und leiten Sie den Kunden zur zurückgegebenen url weiter. Nach seiner Einwilligung sind seine Google-Einträge unter dem neu verbundenen Konto verfügbar. Führen Sie dann POST /connected-accounts/trigger-matches aus, um diese Google-Einträge Ihren Listings API-Standorten zuzuordnen, prüfen Sie die Zuordnungen mit GET /connected-accounts/{connectedAccountId}/connection-suggestions und schließen Sie sie mit POST /connected-accounts/confirm-matches ab.

Anwendungsfall: Erneuern abgelaufener Zugangsdaten. Wenn das Google-Token eines verbundenen Kontos abläuft, werden Aktualisierungen der Einträge nicht mehr synchronisiert. Stellen Sie mit diesem Endpunkt einen neuen Verbindungslink aus und lassen Sie den Kontoinhaber die Autorisierung erneut erteilen; die bestehende Verbindung wird aktualisiert, ohne ein Duplikat anzulegen.

Verwenden Sie für Facebook den connect-facebook-Endpunkt. success: true mit einem url, das nicht null ist, bedeutet, dass der Link generiert wurde; errors wird nur befüllt, wenn die Generierung fehlschlägt.

curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connect-google' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "successUrl": "https://listingsapi.com/docs/api/connected-accounts-trigger-matches", "errorUrl": "https://listingsapi.com/docs/api/connected-accounts-connect" } }'

Parameter

Body

Beispielanfrage

Antworten