عرض مواقع الويب المشمولة في الخطة

الاستجابات

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.

يعرض جميع مواقع أدلة منصات النشر المشمولة في الخطة المرتبطة بالحساب الحالي. يحتوي كل عنصر على id من نوع عدد صحيح، وname للعرض، وurl لموقع الويب، وقائمة برموز البلدان وفق معيار ISO التي يقبلها موقع الويب (supportedCountries)، والبلدان التي يُطبَّق فيها خيار إخفاء العنوان / منطقة الخدمة (hideAddressSupportedCountries).

حالة استخدام: إنشاء أداة لاختيار معرّفات مواقع الويب الصالحة. قبل تفعيل منصات النشر أو تعطيلها لموقع، استدعِ نقطة النهاية هذه لمعرفة معرّفات مواقع الويب الرقمية المتاحة ضمن الخطة. المعرّفات التي تُرجعها نقطة النهاية هذه هي وحدها الصالحة لتمريرها في مواضع أخرى من واجهة API. اربط id بـ name/url لعرض شاشة إعدادات إرسال يسهل على المستخدم قراءتها.

حالة استخدام: التحقق مسبقًا من بلد الموقع. صفِّ الاستجابة لتقتصر على مواقع الويب التي تتضمن supportedCountries فيها قيمة countryIso للموقع، بحيث لا تعرض إلا منصات النشر التي ستقبل إدراج النشاط التجاري فعليًا. بالنسبة إلى الأنشطة التجارية التي تخدم منطقة محددة، راجع hideAddressSupportedCountries أيضًا لمعرفة البلدان التي يمكن فيها إخفاء العنوان.

تنبيهات.

هذه قائمة يقتصر نطاقها على الخطة وغير مقسّمة إلى صفحات: فهي تُرجع الكتالوج الكامل لمواقع الويب الخاصة بالخطة في استجابة واحدة، لذا لا يوجد مؤشر تنقّل. توقّع عشرات العناصر وخزّن النتيجة مؤقتًا بدلًا من استدعاء نقطة النهاية مع كل طلب.
يمكن أن يحتوي كلٌّ من supportedCountries وhideAddressSupportedCountries على 50 رمزًا أو أكثر وفق معيار ISO؛ والمثال أعلاه مقتطع.
تخضع نقطة النهاية لحدّ معدل الطلبات المشترك للحساب؛ وعند تلقّي 429، التزم بترويسة Retry-After.

المعلمات

الاستجابات