Listings APIListings API
Accedi
POST/api/v4/connected-accounts/connected-account-listings

Recupera le schede di un account collegato

Restituisce le schede di Google Business Profile o Facebook accessibili a un account collegato, con filtri e paginazione facoltativi.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Corpo

NomeTipoObbligatorioDescrizione
connectedAccountIdstringobbligatorioUUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored.
pageintegerfacoltativoPage number to fetch. Defaults to 1.
perPageintegerfacoltativoRecords per page. Defaults to 500, which is also the maximum.
locationInfostringfacoltativoFree-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone.

Richiesta di esempio

Corpo pronto da incollare. Sostituisci gli ID e i valori segnaposto con i tuoi.

Request body
{  "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",  "perPage": 50}

Risposte

200List of listings accessible to the account, with pagination metadata.
Response
{  "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.

Restituisce le schede di Google Business Profile o Facebook a cui un account collegato ha accesso. Ogni record include id della scheda (un ID base64), locationName, address, phone e liveLink. Pur essendo una POST, questa è un'operazione di lettura, ma l'account e le opzioni di paginazione devono essere inviati nel corpo JSON.

Caso d'uso: creare un selettore di schede. Dopo che un cliente ha collegato un account Google che possiede decine di schede, chiama questo endpoint per visualizzare un elenco in cui è possibile effettuare ricerche. Inserisci in locationInfo un termine di ricerca digitato dal cliente (la ricerca trova corrispondenze all'interno di nome, indirizzo, numero di telefono, codice postale e codice del negozio), così che possa trovare rapidamente il punto vendita giusto.

Caso d'uso: fornire dati a connect-listing. Il valore id di ogni record è esattamente il valore connectedAccountListingId atteso da connect-listing. Recupera le schede, lascia che il cliente (o la tua logica di abbinamento) ne scelga una, quindi passa il suo id insieme al locationId di destinazione in Listings API a connect-listing per collegarli.

Gestisci la paginazione con le chiavi page e perPage direttamente nel corpo; il valore predefinito di perPage è 500, che è anche il massimo. Leggi pageInfo.hasNextPage e pageInfo.totalPages dalla risposta per scorrere tutte le pagine dell'insieme completo. Le richieste a questo endpoint vengono conteggiate ai fini del limite di frequenza delle richieste dell'account; una risposta 429 include un header Retry-After.

La struttura della richiesta riportata sopra è stata verificata sull'API in produzione. La risposta di esempio è illustrativa.

Request
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  }'
Run in playground