مستقیم درخواست کنید

ما شما را تشویق می کنیم که از کتابخانه ها و نمونه های مشتری برای پیاده سازی خود استفاده کنید. با این حال، اگر ادغام شما با API نیازهای خاصی دارد، مانند استفاده از زبان پشتیبانی نشده، می‌توانید درخواست‌های مستقیمی را که در زیر توضیح داده شده است، ارسال کنید.

سبک تماس

REST سبکی از معماری نرم افزار است که یک رویکرد راحت و سازگار برای درخواست و اصلاح داده ها ارائه می دهد.

اصطلاح REST مخفف " انتقال دولت نمایندگی " است. در زمینه Google API ها، به استفاده از افعال HTTP برای بازیابی و اصلاح نمایش داده های ذخیره شده توسط Google اشاره دارد.

در یک سیستم RESTful، منابع در یک فروشگاه داده ذخیره می شوند. یک سرویس گیرنده درخواستی را ارسال می کند که سرور یک عمل خاص را انجام دهد (مانند ایجاد، بازیابی، به روز رسانی یا حذف یک منبع)، و سرور این عمل را انجام می دهد و پاسخی را می فرستد، اغلب به شکل یک نمایش از منبع مشخص شده.

در API های RESTful Google، مشتری با استفاده از یک فعل HTTP مانند POST ، GET ، PUT ، یا DELETE ، اقدامی را مشخص می کند. این یک منبع را توسط یک URI منحصر به فرد جهانی به شکل زیر مشخص می کند:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

از آنجایی که همه منابع API دارای URI های منحصر به فرد قابل دسترسی با HTTP هستند، REST ذخیره داده را فعال می کند و برای کار با زیرساخت های توزیع شده وب بهینه شده است.

ممکن است تعاریف روش را در مستندات استانداردهای HTTP 1.1 مفید بیابید. آنها شامل مشخصات GET ، POST ، PUT و DELETE هستند.

REST در API مدیریت AdSense

عملیات پشتیبانی شده مستقیماً به افعال HTTP REST، همانطور که در عملیات API مدیریت AdSense توضیح داده شده است، نگاشت.

فرمت خاص برای URI های API مدیریت AdSense عبارتند از:

https://adsense.googleapis.com/v2/resourceID?parameters

که در آن resourceID شناسه یک کلاینت آگهی، واحد تبلیغات، کانال url، کانال سفارشی یا مجموعه گزارش‌ها است و parameters هر پارامتری هستند که باید در پرس و جو اعمال شوند.

فرمت پسوندهای مسیر resourceID به شما امکان می دهد منبعی را که در حال حاضر روی آن کار می کنید شناسایی کنید، به عنوان مثال:

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

مجموعه کامل URI های مورد استفاده برای هر عملیات پشتیبانی شده در API در سند مرجع API مدیریت AdSense خلاصه شده است.

در اینجا چند مثال از نحوه عملکرد این در API مدیریت AdSense آورده شده است.

لیست مشتریان تبلیغات:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

فهرست واحدهای تبلیغاتی در سرویس گیرنده آگهی ca-pub-1234567890123456:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

فرمت داده

JSON (JavaScript Object Notation) یک قالب داده رایج و مستقل از زبان است که نمایش متنی ساده ای از ساختارهای داده دلخواه را ارائه می دهد. برای اطلاعات بیشتر، به json.org مراجعه کنید.

درخواست های مجاز

توجه داشته باشید که AdSense از حساب‌های سرویس پشتیبانی نمی‌کند، در عوض باید از جریان برنامه نصب شده استفاده کنید.

هر درخواستی که برنامه شما به API مدیریت AdSense ارسال می کند باید شامل یک نشانه مجوز باشد. توکن همچنین برنامه شما را در گوگل شناسایی می کند.

درباره پروتکل های مجوز

برنامه شما باید از OAuth 2.0 برای تأیید درخواست ها استفاده کند. هیچ پروتکل مجوز دیگری پشتیبانی نمی شود. اگر برنامه شما از ورود به سیستم با Google استفاده می کند، برخی از جنبه های مجوز برای شما انجام می شود.

تأیید درخواست ها با OAuth 2.0

همه درخواست‌ها به API مدیریت AdSense باید توسط یک کاربر تأیید شده مجاز باشد.

این فرآیند با شناسه مشتری OAuth تسهیل می شود.

یا در صفحه اعتبارنامه ایجاد کنید.

جزئیات فرآیند مجوز یا "جریان" برای OAuth 2.0 بسته به نوع برنامه ای که می نویسید تا حدودی متفاوت است. فرآیند کلی زیر برای همه انواع برنامه ها اعمال می شود:

1. هنگامی که برنامه شما نیاز به دسترسی به داده های کاربر دارد، از Google دامنه دسترسی خاصی را می خواهد.
2. Google یک صفحه رضایت به کاربر نمایش می دهد و از او می خواهد تا به برنامه شما اجازه دهد تا برخی از داده های خود را درخواست کند.
3. اگر کاربر تأیید کند، گوگل به برنامه شما یک رمز دسترسی کوتاه مدت می دهد.
4. برنامه شما با پیوست کردن رمز دسترسی به درخواست، داده های کاربر را درخواست می کند.
5. اگر Google تشخیص دهد که درخواست شما و رمز معتبر هستند، داده‌های درخواستی را برمی‌گرداند.

برخی از جریان‌ها شامل مراحل اضافی هستند، مانند استفاده از نشانه‌های تازه‌سازی برای به دست آوردن نشانه‌های دسترسی جدید. برای اطلاعات دقیق درباره جریان‌ها برای انواع مختلف برنامه‌ها، به اسناد OAuth 2.0 Google مراجعه کنید.

در اینجا اطلاعات محدوده OAuth 2.0 برای API مدیریت AdSense آمده است:

برای درخواست دسترسی با استفاده از OAuth 2.0، برنامه شما به اطلاعات محدوده و همچنین اطلاعاتی که Google هنگام ثبت برنامه خود ارائه می دهد (مانند شناسه مشتری و رمز سرویس گیرنده) نیاز دارد.

نکته: کتابخانه های سرویس گیرنده Google APIs می توانند برخی از فرآیندهای مجوز را برای شما انجام دهند. آنها برای انواع زبان های برنامه نویسی در دسترس هستند. برای جزئیات بیشتر صفحه را با کتابخانه ها و نمونه ها بررسی کنید.

درخواست کردن

مرحله آخر درخواست API است. برای اطلاعات خاص به مستندات مرجع مراجعه کنید.