این صفحه با فرض آشنایی با طراحی منبع گرا و راهنمای توسعه نام منابع و آنها را با جزئیات پیاده سازی خاص Search Ads 360 Reporting API تکمیل می کند.
طراحی منبع محور
به طور کلی، Search Ads 360 Reporting API از یک طراحی منبع محور پیروی می کند که به عنوان مجموعه ای از منابع قابل آدرس دهی جداگانه ( اسم های API) مدل شده است. منابع با نام منابع خود ارجاع داده می شوند و با استفاده از مجموعه کوچکی از روش ها (همچنین به عنوان افعال یا عملیات شناخته می شوند) دستکاری می شوند.
این نام‌ها و روش‌های منابع ، همراه با پیشوند نسخه API خاص، URLهای رابط REST را تشکیل می‌دهند. به عنوان مثال، URL زیر را می توان طبق جدول زیر به این اجزای جداگانه تقسیم کرد:
https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| پیشوند نسخه API | نام منبع (نسبی) | روش |
|---|---|---|
https://searchads360.googleapis.com/v0 | customers/1234567890 | search |
همه URL های REST برای یک نسخه خاص از API (به عنوان مثال، v0 ) یک پیشوند نسخه مشترک API مشترک دارند. نام منبع و روش با هم مشخص می کند که کدام سرویس API در حال فراخوانی است.
Search Ads 360 Reporting API به شدت از روش های سفارشی استفاده می کند، برخلاف اکثر API های REST سنتی که از روش های استاندارد REST مانند list و get استفاده می کنند. Search Ads 360 Reporting API شامل دو روش سفارشی است: search و searchStream .
صفحات زیر به جزئیات بیشتری درباره نام‌های منابع ، روش‌های سرویس و قراردادهای نام‌گذاری JSON در Search Ads 360 Reporting API می‌پردازند تا نشان دهند که چگونه با هم برای تعریف نقاط پایانی رابط REST استفاده می‌شوند.