/api/v4/connected-accounts/connected-account-listingsBağlı bir hesabın işletme kayıtlarını getirin
İsteğe bağlı filtreleme ve sayfalama ile bağlı bir hesabın erişebildiği Google Business Profile veya Facebook işletme kayıtlarını döndürür.
Parametreler
Gövde
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| connectedAccountId | string | zorunlu | UUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored. |
| page | integer | isteğe bağlı | Page number to fetch. Defaults to 1. |
| perPage | integer | isteğe bağlı | Records per page. Defaults to 500, which is also the maximum. |
| locationInfo | string | isteğe bağlı | Free-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone. |
Örnek istek
Yapıştırmaya hazır gövde. Yer tutucu kimlikleri ve değerleri kendi değerlerinizle değiştirin.
{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50}Yanıtlar
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.
Bağlı bir hesabın erişebildiği Google Business Profile veya Facebook işletme kayıtlarını döndürür. Her kayıt, işletme kaydının id (base64 biçiminde bir kimlik), locationName, address, phone ve liveLink alanlarını içerir. POST olmasına rağmen bu bir okuma işlemidir, ancak hesap ve sayfalama seçenekleri JSON gövdesinde gönderilmelidir.
Kullanım örneği: bir işletme kaydı seçici oluşturun. Bir müşteri, onlarca işletme kaydına sahip bir Google hesabını bağladıktan sonra, aranabilir bir liste görüntülemek için bu işlemi çağırın. Müşterinin doğru işletmeyi hızla bulabilmesi için yazdığı arama terimini locationInfo alanına yerleştirin (bu alan ad, adres, telefon, posta kodu ve mağaza kodu içinde eşleşme arar).
Kullanım örneği: connect-listing'e veri sağlayın. Her kayıttaki id, connect-listing'in beklediği connectedAccountListingId ile tam olarak aynıdır. İşletme kayıtlarını getirin, müşterinin (veya eşleştirme mantığınızın) birini seçmesini sağlayın, ardından bunları birbirine bağlamak için seçilen kaydın id değerini hedef Listings API locationId değeriyle birlikte connect-listing'e iletin.
Gövdede doğrudan yer alan page ve perPage anahtarlarıyla sayfalama yapın; perPage varsayılan olarak 500 değerini alır ve bu aynı zamanda en yüksek değerdir. Tüm sonuçları sayfa sayfa almak için yanıttaki pageInfo.hasNextPage ve pageInfo.totalPages değerlerini okuyun. Bu uç noktaya yapılan istekler hesabın istek hızı sınırına dahil edilir; bir 429 yanıtı, Retry-After başlığını içerir.
Yukarıdaki istek yapısı, canlı API kullanılarak doğrulanmıştır. Örnek yanıt açıklama amaçlıdır.
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 }'