/api/v4/connected-accounts/connected-account-listingsEinträge eines verbundenen Kontos abrufen
Gibt die Google Business Profile- oder Facebook-Einträge zurück, auf die ein verbundenes Konto zugreifen kann, mit optionaler Filterung und Paginierung.
Parameter
Body
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| connectedAccountId | string | erforderlich | UUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored. |
| page | integer | optional | Page number to fetch. Defaults to 1. |
| perPage | integer | optional | Records per page. Defaults to 500, which is also the maximum. |
| locationInfo | string | optional | Free-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone. |
Beispielanfrage
Body zum direkten Einfügen. Ersetzen Sie Platzhalter-IDs und -Werte durch Ihre eigenen.
{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50}Antworten
200List of listings accessible to the account, with pagination metadata.
{ "data": { "connectedAccountListings": { "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "totalPages": 1, "totalRecords": 60 }, "records": [ { "accountTypeName": "Google", "address": "123 William St, NY 10038, Manhattan, US", "id": "R21iQnVsa0RhdGFMYWtlOjA2MDQ4NmExLTA0NzQtNDc4NS1iMjNhLTBkOGM4MzhmNGQ5OA==", "liveLink": null, "locationName": "Trial", "phone": "(718) 667-7787" } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Gibt die Google Business Profile- oder Facebook-Einträge zurück, auf die ein verbundenes Konto Zugriff hat. Jeder Datensatz enthält die id des Eintrags (eine base64-ID), locationName, address, phone und liveLink. Obwohl es sich um einen POST handelt, ist dies eine Leseoperation, aber die Konto- und Paginierungsoptionen müssen im JSON-Body gesendet werden.
Anwendungsfall: eine Eintragsauswahl erstellen. Nachdem ein Kunde ein Google-Konto verbunden hat, dem Dutzende von Einträgen gehören, rufen Sie diesen Endpunkt auf, um eine durchsuchbare Liste anzuzeigen. Übergeben Sie einen vom Kunden eingegebenen Suchbegriff in locationInfo (gesucht wird innerhalb von Name, Adresse, Telefonnummer, Postleitzahl und Geschäftscode), damit er schnell das richtige Geschäft finden kann.
Anwendungsfall: Daten für connect-listing bereitstellen. Die id in jedem Datensatz ist genau die connectedAccountListingId, die connect-listing erwartet. Rufen Sie die Einträge ab, lassen Sie den Kunden (oder Ihre Zuordnungslogik) einen davon auswählen und übergeben Sie dann dessen id zusammen mit der locationId des Zielstandorts in Listings API an connect-listing, um beide zu verknüpfen.
Verwenden Sie zur Paginierung die Schlüssel page und perPage auf der obersten Ebene des Bodys; perPage hat den Standardwert 500, der zugleich der Höchstwert ist. Lesen Sie pageInfo.hasNextPage und pageInfo.totalPages aus der Antwort aus, um den gesamten Datenbestand seitenweise abzurufen. Dieser Endpunkt wird auf das Anfragelimit des Kontos angerechnet; eine 429 enthält einen Retry-After-Header.
Die oben gezeigte Anfragestruktur wurde anhand der Live-API überprüft. Die Beispielantwort dient der Veranschaulichung.
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connected-account-listings' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50 }'