Tampilkan daftar situs dalam paket

Respons

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.

Mengembalikan semua situs direktori platform publikasi yang disertakan dalam paket yang terkait dengan akun saat ini. Setiap entri memiliki id berupa bilangan bulat, name untuk tampilan, url situs, daftar kode negara ISO yang diterima situs (supportedCountries), dan negara tempat flag hide-address / service-area diterapkan (hideAddressSupportedCountries).

Kasus penggunaan: membuat pemilih ID situs yang valid. Sebelum mengaktifkan atau menonaktifkan platform publikasi untuk suatu lokasi, panggil endpoint ini untuk mengetahui ID situs numerik yang tersedia dalam paket. Hanya ID yang dikembalikan di sini yang valid untuk digunakan di bagian lain API. Petakan id ke name/url untuk menampilkan layar pengaturan pengiriman yang mudah dipahami pengguna.

Kasus penggunaan: memeriksa negara lokasi sebelum melanjutkan. Filter respons agar hanya mencakup situs yang supportedCountries-nya menyertakan countryIso lokasi, sehingga Anda hanya menawarkan platform publikasi yang benar-benar akan menerima profil bisnis tersebut. Untuk bisnis area layanan, periksa juga hideAddressSupportedCountries untuk mengetahui negara tempat alamat dapat disembunyikan.

Hal yang perlu diperhatikan.

Daftar ini dibatasi pada cakupan paket dan tidak menggunakan paginasi: seluruh katalog situs untuk paket dikembalikan dalam satu respons, sehingga tidak ada cursor. Daftar ini biasanya berisi puluhan entri; simpan hasilnya dalam cache alih-alih memanggil endpoint ini untuk setiap permintaan.
supportedCountries dan hideAddressSupportedCountries masing-masing dapat berisi 50+ kode ISO; contoh di atas dipotong.
Menggunakan batas laju permintaan akun bersama-sama dengan endpoint lain; saat menerima 429, patuhi header Retry-After.

Parameter

Respons