تصميم واجهة REST

تفترض هذه الصفحة أنّك على دراية بدليلَي المطوّرين تصميم موجّه نحو الموارد وأسماء الموارد، وتكمّلهما بتفاصيل تنفيذ محدّدة لواجهة برمجة التطبيقات Search Ads 360 Reporting API.

التصميم المرتكز على الموارد

بشكل عام، تتّبع Search Ads 360 Reporting API تصميمًا موجّهًا إلى الموارد، ويتم وضع نموذج لها على هيئة مجموعات من الموارد التي يمكن الوصول إليها بشكلٍ فردي (الأسماء لواجهة برمجة التطبيقات). تتم الإشارة إلى الموارد بأسماء مواردها ويتم التلاعب بها باستخدام مجموعة صغيرة من الطرق (المعروفة أيضًا باسم الأفعال أو العمليات).

إنّ أسماء الموارد والطرق هذه، بالإضافة إلى بادئة إصدار واجهة برمجة التطبيقات المحدّدة، تشكّل عناوين URL لواجهة REST. على سبيل المثال، يمكن تقسيم عنوان URL أدناه إلى هذه المكوّنات الفردية وفقًا للجدول التالي:

https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
بادئة إصدار واجهة برمجة التطبيقات اسم المورد (نسبي) الطريقة
https://searchads360.googleapis.com/v0 customers/1234567890 search

جميع عناوين URL لبروتوكول REST لإصدار معيّن من واجهة برمجة التطبيقات (مثل v0) مشاركة بادئة إصدار واجهة برمجة التطبيقات المشتركة يحدِّد اسم المورد وطريقة الاستخدام معًا خدمة واجهة برمجة التطبيقات التي يتمّ طلبها.

تستخدِم Search Ads 360 Reporting API بشكلٍ كبير الطُرق المخصّصة، على عكس معظم واجهات برمجة تطبيقات REST التقليدية التي تستخدِم طُرق REST العادية مثل list وget. تتضمّن Search Ads 360 Reporting API طريقتَين مخصّصتَين: search وsearchStream.

تتناول الصفحات التالية المزيد من التفاصيل حول أسماء الموارد وطُرق الخدمة واصطلاحات تسمية تنسيق JSON في Search Ads 360 Reporting API لتوضيح كيفية استخدامها معًا لتحديد نقاط نهاية واجهة REST.