این صفحه فرض می‌کند که با راهنماهای توسعه‌دهنده طراحی منبع‌گرا و نام‌های منبع آشنایی دارید و آن‌ها را با جزئیات پیاده‌سازی خاص Google Ads API تکمیل می‌کند.
طراحی منبع‌محور
به‌طور کلی، Google Ads API از طراحی منبع‌محور پیروی می‌کند که به‌صورت مجموعه‌هایی از منابع با آدرس‌های جداگانه (اسم‌های API) مدل‌سازی شده است. منابع با نام منبعشان ارجاع داده می‌شوند و بااستفاده از مجموعه کوچکی از روش‌ها (که با نام فعل‌ها یا عملیات نیز شناخته می‌شوند) دستکاری می‌شوند. این نام‌های منبع و روش‌ها، در ترکیب با پیشوند نسخه API خاص، نشانی‌های وب میانای REST را تشکیل می‌دهند. برای مثال، این نشانی وب نمونه را می‌توان طبق جدول زیر به این مؤلفه‌های جداگانه تقسیم کرد:
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| پیشوند نسخه میانای برنامه‌سازی کاربردی | نام منبع (نسبی) | روش |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
همه نشانی‌های وب REST برای نسخه خاصی از API (مثلاً v26)
پیشوند مشترکی برای نسخه API دارند. نام منبع و روش باهم مشخص می‌کنند که کدام سرویس API فراخوانی می‌شود.
Google Ads API به‌شدت از روش‌های سفارشی استفاده می‌کند، برخلاف اکثر
میاناهای برنامه‌سازی کاربردی REST که از روش‌های استاندارد 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 ماشین‌خوانا.