سير عمل واجهة برمجة التطبيقات

يصف هذا الدليل سير العمل الشائع لواجهة برمجة التطبيقات من أجل إنشاء "حزم المزادات" واستردادها وتعديلها في "مساحة العرض والفيديو 360".

الحصول على قائمة بـ "حزم المزادات"

يمكنك طلب واجهة برمجة التطبيقات LIST API. تتيح هذه الواجهة الفلترة حسب external_deal_id.

إنشاء "حزمة مزاد" جديدة

1. يجب أن يكون external_deal_id فريدًا. يمكنك طلب واجهة برمجة التطبيقات LIST باستخدام external_deal_id لمعرفة ما إذا كان قد تم استخدام المعرّف من قبل.
2. يمكنك طلب واجهة برمجة التطبيقات Create API. سيتم تخصيص اسم فريد، ويمكن استخدامه للحصول على الحزمة التي تم إنشاؤها.
3. يمكنك طلب واجهة برمجة التطبيقات Get API للاطّلاع على تفاصيل "حزمة المزاد" التي تم إنشاؤها.
4. يمكنك اختياريًا تحميل شعار للحزمة التي تم إنشاؤها.

تعديل "حزمة مزاد"

1. إذا لم يتم تخزين اسم "حزمة المزاد" التي تم إنشاؤها، يمكنك طلب واجهة برمجة التطبيقات LIST API التي تم فلترتها حسب external_deal_id للحصول على "حزمة المزاد" التي تريد تعديلها.
2. يمكنك تعديل الحقول استنادًا إلى النتائج من واجهة برمجة التطبيقات LIST.
3. يمكنك طلب واجهة برمجة التطبيقات Patch API لتعديل "حزمة المزاد". يجب تحديد updateMask. تشير هذه السمة إلى الحقول التي تريد تطبيق التعديل عليها. لا يمكن ضبط سوى الحقول التي يُسمح بتعديلها في updateMask.

العملية التجريبية

الفرق الوحيد بين الإصدار التجريبي والإصدار المتاح للجميع هو أنّه خلال الإصدار التجريبي، يجب أن يكون لحزم المزادات التي يتم إنشاؤها الحالة DISCOVERY_OBJECT_STATUS_PAUSED، ولا يمكن تعديل الحالة. لا تظهر الحزم التي تم إيقافها مؤقتًا في واجهة مستخدم "مساحة العرض والفيديو 360". يوفّر ذلك للبورصات طريقة لاختبار عملية دمج واجهة برمجة التطبيقات بدون عرض حزم الاختبار.

من الشائع إنشاء جميع الحزم "الحقيقية" في الإصدار التجريبي على أنّها PAUSED ثم تفعيلها مرة واحدة في الإصدار المتاح للجميع.

Quota

‫2,000 حزمة نشطة لكل بورصة

‫2,000 حزمة متوقّفة مؤقتًا لكل بورصة