تصميم واجهة 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.

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