GET/api/v4/plan-sites

Plandaki siteleri listeleme

Hesabın planına dahil olan tüm yayın platformu dizin sitelerini, her sitenin ID'si, URL'si ve desteklediği ülkelerle birlikte döndürür.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Bu uç nokta parametre almaz.

Yanıtlar

200Array of plan site objects. Country arrays are truncated below for brevity; the live response lists every supported country.
Response
{  "data": {    "planSites": [      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 1,        "name": "Google Maps",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "maps.google.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 184,        "name": "Facebook",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "facebook.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "GB"],        "id": 2,        "name": "Yelp",        "supportedCountries": ["US", "CA", "GB", "DE", "FR"],        "url": "yelp.com"      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Geçerli hesaba bağlı plana dahil olan tüm yayın platformu dizin sitelerini döndürür. Her öğe bir tamsayı id, görüntülenen bir name, sitenin url değeri, sitenin kabul ettiği ISO ülke kodlarının listesi (supportedCountries) ve adres gizleme / hizmet bölgesi bayrağının geçerli olduğu ülkeleri (hideAddressSupportedCountries) içerir.

Kullanım senaryosu: geçerli site ID'leri için bir seçici oluşturma. Bir konum için yayın platformlarını etkinleştirmeden veya devre dışı bırakmadan önce, planda hangi sayısal site ID'lerinin bulunduğunu öğrenmek için bu endpoint'i çağırın. API'nin başka bölümlerine yalnızca burada döndürülen ID'ler geçerli olarak iletilebilir. İnsanların anlayabileceği bir gönderim ayarları ekranı oluşturmak için id değerini name/url ile eşleştirin.

Kullanım senaryosu: bir konumun ülkesini önceden kontrol etme. Yalnızca işletme kaydını gerçekten kabul edecek yayın platformlarını sunmak için yanıtı, supportedCountries alanında konumun countryIso değerini içeren sitelerle sınırlayacak şekilde filtreleyin. Hizmet bölgesi olan işletmeler için adresin nerelerde gizlenebileceğini görmek üzere hideAddressSupportedCountries alanını da kontrol edin.

Dikkat edilmesi gerekenler.

  • Bu liste plan kapsamındadır ve sayfalandırılmaz: planın tüm site kataloğunu tek bir yanıtta döndürür, dolayısıyla cursor yoktur. Onlarca öğe bekleyin ve her istekte endpoint'i çağırmak yerine sonucu önbelleğe alın.
  • supportedCountries ve hideAddressSupportedCountries alanlarının her biri 50'den fazla ISO kodu içerebilir; yukarıdaki örnek kısaltılmıştır.
  • Hesabın istek hızı sınırını paylaşır; 429 durumunda Retry-After başlığına uyun.
Request
curl -X GET 'https://listingsapi.com/api/v4/plan-sites' \  -H "Authorization: API $LISTINGSAPI_KEY"