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