تصميم واجهة REST

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

تصميم موجه بالموارد

بشكل عام، تتّبع 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) تشترك في بادئة إصدار واجهة برمجة التطبيقات الشائعة. يحدد اسم المورد والطريقة معًا خدمة واجهة برمجة التطبيقات التي يتم استدعاؤها.

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

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