/api/v4/locations/{locationId}/listings/premiumBir konumun premium işletme kayıtlarını alın
Bir konumun planındaki her yayın platformu dizininin senkronizasyon durumunu döndürür.
Parametreler
Yol
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| locationId | string | zorunlu | Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID. |
Yanıtlar
200Array of listings with per-directory sync status.
{ "data": { "listingsForLocation": [ { "id": "TGlzdGluZzoxMDQ0Njg3MjM=", "databaseId": "104468723", "site": { "id": "U2l0ZTox", "databaseId": "1", "name": "Google Maps", "url": "maps.google.com", "syScore": "100" }, "syncStatus": "REQUIRING_ACTION", "displayStatus": "Connect your account to sync the listing", "actionRequired": true, "listingUrl": null, "connectedAccountId": null, "lastUpdate": "2026-07-06T18:33:28Z", "indexStatus": false, "syncIssue": null, "verified": false }, { "id": "TGlzdGluZzoxMDQ0Njg3MTQ=", "databaseId": "104468714", "site": { "id": "U2l0ZToxODA=", "databaseId": "180", "name": "Bing", "url": "www.bing.com", "syScore": "97" }, "syncStatus": "IN_PROGRESS", "displayStatus": "Information submitted to partner; awaiting response", "actionRequired": false, "listingUrl": null, "connectedAccountId": null, "lastUpdate": "2026-07-06T18:33:35Z", "indexStatus": false, "syncIssue": null, "verified": false }, { "id": "TGlzdGluZzoxMDQ0Njg3Mjc=", "databaseId": "104468727", "site": { "id": "U2l0ZTozODc=", "databaseId": "387", "name": "BeLocalFocussed", "url": "belocalfocussed.com", "syScore": "80" }, "syncStatus": "SYNCED", "displayStatus": "Synced", "actionRequired": false, "listingUrl": "https://belocalfocussed.com/jenny-home-26x0ffkd0e", "connectedAccountId": null, "lastUpdate": "2026-07-06T18:33:30Z", "indexStatus": false, "syncIssue": null, "verified": false }, { "id": "TGlzdGluZzoxMDQ0Njg3MDk=", "databaseId": "104468709", "site": { "id": "U2l0ZTozMDE=", "databaseId": "301", "name": "Local Mint", "url": "localmint.com", "syScore": "69" }, "syncStatus": "FAILED", "displayStatus": "Partner experiencing issues; awaiting response", "actionRequired": false, "listingUrl": null, "connectedAccountId": null, "lastUpdate": "2026-07-06T18:34:03Z", "indexStatus": false, "syncIssue": "Publisher requires website URL", "verified": false } ] }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Bir konumun planına dahil olan her yayın platformu dizininin senkronizasyon durumunu döndürür. Her kayıt, bir site (dizin meta verileri) ile bir syncStatus ve insanlar tarafından okunabilir bir displayStatus öğesini eşleştirir. Yukarıdaki örnek, yaygın durumların her biri için bir kayıt göstermek üzere Jenny Home için alınan canlı yanıttan (30'dan fazla dizin döndürür) kısaltılmıştır.
İşletme kaydı katmanı yolun bir parçasıdır: /listings/premium planın premium dizinlerini (burada gösterilenler), /listings/additional ise ek/ücretsiz işletme kayıtlarını döndürür. listingType adlı bir sorgu parametresi yoktur; bu parametreyle gönderilen değer yok sayılır.
Kullanım senaryosu: işletme kayıtlarının durumu için bir kontrol paneli
Kapsamı ve kaç dizindeki kaydın yayında, işlem aşamasında veya engellenmiş olduğunu bir bakışta göstermek için bir konumun premium işletme kayıtlarını alın ve syncStatus değerine göre gruplandırın. Kullanıcıların tıklayarak yayındaki işletme kaydına gidebilmesi için SYNCED satırlarında listingUrl öğesini gösterin ve senkronize edilmemiş tüm kayıtlar için displayStatus/syncIssue öğelerini okuyun (e.g. Publisher requires website URL).
Kullanım senaryosu: "hesabınızı bağlayın" işlemini gerektiren engelleri gösterin
İşletme sahibinin yapılacaklar listesini oluşturmak için actionRequired: true değerine göre filtreleyin. Canlı verilerde Google Maps, Facebook ve Waze, displayStatus: "Connect your account to sync the listing" ile birlikte REQUIRING_ACTION durumunda döner; bunların senkronize edilebilmesi için önce bir OAuth bağlantısı gerekir. İşletme sahibini ilgili bağlantı akışına yönlendirin, ardından durumun ilerleyişini izlemek için bu uç noktayı yeniden düzenli aralıklarla sorgulayın.
syncStatus değerleri: AVAILABLE (senkronizasyona hazır, başlatılmadı), IN_PROGRESS (iş ortağına gönderildi, yanıt bekleniyor), PENDING_APPROVAL (iş ortağının onayı bekleniyor), SYNCED / COMPLETED (yayında; listingUrl doldurulmuş), REQUIRING_ACTION (işletme sahibinin işlem yapması gerekiyor, bkz. displayStatus), FAILED (senkronizasyon başarısız oldu; bkz. syncIssue), CANNOT_SUBMIT (gönderim mümkün değil).
Bu, hesabın istek hızı sınırına tabi, konum bazında bir listedir; 429 durumunda hemen yeniden sorgulamak yerine Retry-After başlığında belirtilen süre geçtikten sonra yeniden deneyin.
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/listings/premium' \ -H "Authorization: API $LISTINGSAPI_KEY"