تفترض هذه الصفحة معرفة بدليلَي المطوّرين تصميم موجّه نحو الموارد وأسماء الموارد، وتكمّلهما بتفاصيل تنفيذ محدّدة لواجهة برمجة التطبيقات Google Ads API.
التصميم المرتكز على الموارد
بشكل عام، تتّبع Google Ads API تصميمًا موجّهًا إلى الموارد، ويتم وضع نموذج له على هيئة مجموعات من الموارد التي يمكن الوصول إليها بشكلٍ فردي (الأسماء لواجهة برمجة التطبيقات). تتم الإشارة إلى الموارد بأسماء مواردها ويتم التلاعب بها باستخدام مجموعة صغيرة من الطرق (المعروفة أيضًا باسم الأفعال أو العمليات).
تشكّل أسماء الموارد والطرق هذه، مع بادئة إصدار واجهة برمجة التطبيقات المحدّدة، عناوين URL لواجهة REST. على سبيل المثال، يمكن تقسيم عنوان URL أدناه إلى المكوّنات الفردية التالية وفقًا للجدول التالي:
https://googleads.googleapis.com/v18/customers/1234567890:mutate
| بادئة إصدار واجهة برمجة التطبيقات | اسم المورد (نسبي) | الطريقة |
|---|---|---|
https://googleads.googleapis.com/v18
|
customers/1234567890
|
mutate
|
جميع عناوين URL لبروتوكول REST لإصدار معيّن من واجهة برمجة التطبيقات (مثل v18)
مشاركة بادئة إصدار واجهة برمجة التطبيقات المشتركة يحدِّد اسم المورد وطريقة الاستخدام معًا
خدمة واجهة برمجة التطبيقات التي يتمّ طلبها.
تستخدِم Google Ads API بشكلٍ كبير الطرق المخصّصة، على عكس معظم
واجهات برمجة التطبيقات التقليدية المستندة إلى بروتوكول REST التي تستخدِم طرق REST العادية، مثل list وget
وcreate وupdate وdelete. تشمل أمثلة الطرق المخصّصة في Google Ads API
search وsearchStream وmutate.
تتناول الصفحات التالية المزيد من التفاصيل حول أسماء الموارد وطُرق الخدمة واصطلاحات تسمية تنسيق JSON في Google Ads API لتوضيح كيفية استخدامها معًا لتحديد نقاط نهاية واجهة برمجة التطبيقات REST.