تصميم واجهة REST

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

التصميم المستند إلى الموارد

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

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

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

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

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

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