تصميم واجهة REST

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

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

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

https://googleads.googleapis.com/v26/customers/1234567890:mutate

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

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

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

إدارة الأخطاء

يمكنك الاطّلاع على فهم أخطاء واجهة برمجة التطبيقات للحصول على إرشادات حول كيفية تحليل أي أخطاء تحدث وتصحيحها.

مستند الاستكشاف

لتسهيل وأتمتة عملية اكتشاف الطرق المتاحة في Google Ads API، يمكنك استخدام مستند الاستكشاف المنشور لكل إصدار.

ويمكنك الاطّلاع عليها على الرابط https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>. على سبيل المثال، هذا هو مستند الاستكشاف لأحدث إصدار من Google Ads API.

يحتوي مستند الاستكشاف على معلومات عن جميع الخدمات والطرق والموارد والكيانات المستخدَمة في Google Ads API، مثل المستندات المرجعية، ولكن بتنسيق JSON يمكن معالجته آليًا.