این صفحه با فرض آشنایی با طراحی منبع گرا و راهنمای توسعه نام منابع و آنها را با جزئیات پیاده سازی خاص API Google Ads تکمیل می کند.
طراحی منبع محور
به طور کلی، Google Ads API از یک طراحی منبع گرا پیروی می کند که به عنوان مجموعه ای از منابع قابل آدرس دهی جداگانه ( اسم های API) مدل شده است. منابع با نام منابع خود ارجاع داده می شوند و با استفاده از مجموعه کوچکی از روش ها (همچنین به عنوان افعال یا عملیات شناخته می شوند) دستکاری می شوند.
این نام‌ها و روش‌های منابع ، همراه با پیشوند نسخه API خاص، URLهای رابط REST را تشکیل می‌دهند. به عنوان مثال، URL زیر را می توان طبق جدول زیر به این اجزای جداگانه تقسیم کرد:
https://googleads.googleapis.com/v21/customers/1234567890:mutate
| پیشوند نسخه API | نام منبع (نسبی) | روش |
|---|---|---|
https://googleads.googleapis.com/v21 | customers/1234567890 | mutate |
همه URL های REST برای یک نسخه خاص از API (به عنوان مثال، v21 ) یک پیشوند نسخه مشترک API مشترک دارند. نام منبع و روش با هم مشخص می کند که کدام سرویس API در حال فراخوانی است.
Google Ads API به شدت از روش های سفارشی استفاده می کند، برخلاف اکثر API های REST سنتی که از روش های استاندارد REST مانند list ، get ، create ، update و delete استفاده می کنند. نمونه‌هایی از روش‌های سفارشی در Google Ads API عبارتند از search ، searchStream و mutate .
صفحات زیر به جزئیات بیشتری درباره نام‌های منابع Google Ads API، روش‌های سرویس و قراردادهای نام‌گذاری JSON می‌پردازند تا نشان دهند که چگونه با هم برای تعریف نقاط پایانی رابط REST استفاده می‌شوند.
سند کشف
برای تسهیل و خودکار کردن کشف روش‌های موجود در Google Ads API، می‌توانید از سند کشف منتشر شده برای هر نسخه استفاده کنید.
در https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION> موجود است. بنابراین، برای مثال، این سند کشف آخرین نسخه Google Ads API است.
سند کشف حاوی اطلاعاتی درباره همه سرویس‌ها، روش‌ها، منابع و موجودیت‌های مورد استفاده در Google Ads API است، مانند مستندات مرجع ، اما در قالب JSON قابل خواندن توسط ماشین.