تصميم واجهة REST

تفترض هذه الصفحة أن لديك معرفة بأدلة المطوِّرين للتصميم الموجَّه للموارد وأسماء الموارد وتكملها بتفاصيل تنفيذ محدَّدة في Google Ads API.

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

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

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

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

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

تستخدم Google Ads API الطرق المخصّصة بشكل مكثّف، على عكس معظم واجهات برمجة تطبيقات REST التقليدية التي تستخدم طرق REST عادية، مثل list وget وcreate وupdate وdelete. من أمثلة الطرق المخصّصة في Google Ads API search وsearchStream وmutate.

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