تصميم واجهة REST

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

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

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

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

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

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

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

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