شروع به کار با AdMob API

مهم: نقش‌ها و اجازه‌های جدید کاربر بر داده‌های برگردانده‌شده توسط AdMob API تأثیر خواهد گذاشت. بیشتر بدانید

این راهنما برای توسعه‌دهندگانی است که می‌خواهند از AdMob API برای دریافت برنامه‌ریزی‌شده داده‌ها در حساب AdMob خود استفاده کنند.

همه فراخوانی‌های Google AdMob API باید ازطریق OAuth2 مجاز شوند تا برنامه شما بتواند ازطرف کاربر با خدمات وب تعامل داشته باشد. ‫OAuth2 به برنامه کارخواه AdMob API شما امکان می‌دهد بدون نیاز به مدیریت یا ذخیره نام کاربری یا گذرواژه کاربر، به حساب AdMob کاربر دسترسی پیدا کند. برای نمای کلی مجوز، به مجوز مراجعه کنید.

برای تولید کردن اطلاعات اعتباری OAuth2 و انجام اولین درخواست، مراحل زیر را انجام دهید.

پیش‌نیازها

• حساب Google.

• حساب Google AdMob.

• آشنایی با اصول اولیه REST و مجوز دادن به درخواست‌ها با OAuth 2.0.

نوع اصالت‌سنجی خود را تعیین کنید

برای اینکه ببینید کدام نوع اصالت‌سنجی برای برنامه شما مناسب‌تر است، جدول زیر را بررسی کنید:

نوع اصالت‌سنجی OAuth2 را انتخاب کنید	اگر …
برنامه رایانه	همه حساب‌های AdMob API خود را بااستفاده از یک حساب مدیر سطح بالا مدیریت می‌کنید. کاربر جدید هستید یا می‌خواهید با ساده‌ترین راه‌اندازی سریع شروع کنید. برنامه شما فقط کاربران Google AdMob را از یک ماشین اصالت‌سنجی می‌کند.
برنامه وب	می‌خواهید به‌عنوان کاربری اصالت‌سنجی کنید که می‌تواند به برنامه شما اجازه دهد به داده‌های حساب AdMob API او دسترسی داشته باشد. می‌خواهید به‌راحتی چندین اطلاعات اعتباری مجوز تولید کنید، برای مثال، برای مدیریت حساب‌های طرف سوم. برنامه شما به نشانی‌های وب برگشتی نیاز دارد. نشانی‌های وب برگشتی در جریان برنامه رایانه پشتیبانی نمی‌شود.

نکته کلیدی: حتی اگر برنامه‌ای برای اجرا در سرور توسعه می‌دهید، همچنان می‌توانید جریان برنامه رایانه را انتخاب کنید. تفاوت در این است که آیا مجوز OAuth به‌صورت محلی یا از راه دور تکمیل می‌شود. جریان کار رایانه‌ای برای تکمیل در ماشین محلی به مجوز نیاز دارد، درحالی‌که جریان کار وب به مجوز اجازه می‌دهد در سرور مجوز Google تکمیل شود.

ساختن پروژه

برای شروع استفاده از AdMob API، ابتدا باید پروژه‌ای در «کنسول Google API» ایجاد یا انتخاب کنید و API را بااستفاده از ابزار راه‌اندازی فعال کنید. این ابزار شما را در این فرایند راهنمایی می‌کند و AdMob API را به‌طور خودکار فعال می‌کند.

فعال کردن API برای یک پروژه موجود

مراحل زیر برای کاربرانی که پروژه موجود دارند و ترجیح می‌دهند «میانای برنامه‌سازی کاربردی AdMob» را برای آن به‌صورت دستی فعال کنند اعمال می‌شود.

برای فعال کردن میانای برنامه‌سازی کاربردی برای پروژه:

1. در «کنسول Google API»، کتابخانه API را باز کنید.
2. درصورت دریافت پیام‌واره، پروژه‌ای را انتخاب کنید یا پروژه جدیدی بسازید. «کتابخانه میانای برنامه‌سازی کاربردی» همه میاناهای برنامه‌سازی کاربردی دردسترس را فهرست می‌کند و براساس خانواده محصول و محبوبیت گروه‌بندی می‌کند.
3. اگر API موردنظرتان برای فعال کردن در فهرست قابل‌مشاهده نیست، از جستجو برای یافتن آن استفاده کنید، یا روی مشاهده همه در خانواده محصولی که به آن تعلق دارد کلیک کنید.
4. میانای برنامه‌سازی کاربردی موردنظر را برای فعال کردن انتخاب کنید، سپس روی دکمه فعال کردن کلیک کنید.
5. اگر خواسته شد، صورت‌حساب را فعال کنید.
6. درصورت درخواست، «شرایط خدمات» API را بخوانید و بپذیرید.

ایجاد اعتبارنامه‌های OAuth2

دستورالعمل‌های زیر شما را در فرایند ایجاد شناسه کارخواه OAuth 2.0 برای استفاده با جریان برنامه نصب‌شده راهنمایی می‌کند.

1. به صفحه «کارخواهان» بروید.

2. روی ایجاد اعتبارنامه‌ها > شناسه کارخواه OAuth کلیک کنید.

   اگر قبلاً صفحه کسب رضایت OAuth را برای این پروژه پیکربندی نکرده‌اید، اکنون به این کار هدایت خواهید شد. روی پیکربندی صفحه موافقت کلیک کنید. چندین روش برای پیکربندی صفحه کسب رضایت برای استفاده از شناسه کارخواه OAuth 2.0 وجود دارد.

   1. نوع کاربر را روی خارجی و وضعیت انتشار را روی منتشرشده تنظیم کنید.

   2. یا، نوع کاربر را روی خارجی و وضعیت انتشار را روی آزمایشی تنظیم کنید، سپس با انتخاب افزودن کاربران، کاربران آزمایشی را اضافه کنید تا به آن‌ها امکان دهید از شناسه کارخواه OAuth 2.0 شما استفاده کنند.

      اطلاعات تکمیلی را درباره راه‌اندازی صفحه موافقت OAuth ببینید.

3. برنامه رایانه یا برنامه وب را به‌عنوان نوع برنامه انتخاب کنید، نامی برای آن انتخاب کنید، سپس روی ایجاد کلیک کنید.

پس‌از اتمام، شناسه کارخواه و رمز کارخواه OAuth 2.0 به شما ارائه می‌شود که می‌توانید آن را در قالب JSON بارگیری کنید و برای استفاده بعدی ذخیره کنید.

درخواست دادن

«میانای برنامه‌سازی کاربردی AdMob» براساس HTTP و JSON ساخته شده است، بنابراین هر کارخواه استاندارد HTTP می‌تواند درخواست‌هایی به آن ارسال کند و پاسخ‌ها را تجزیه کند. بااین‌حال، کتابخانه‌های کارخواه Google API یکپارچگی زبان بهتری، امنیت بهبودیافته، و پشتیبانی برای ایجاد درخواست‌های مجاز ارائه می‌دهند. کتابخانه‌های کاربر در تعدادی از زبان‌های برنامه‌نویسی دردسترس هستند؛ بااستفاده از آن‌ها می‌توانید از نیاز به راه‌اندازی دستی درخواست‌های HTTP و تجزیه پاسخ‌ها اجتناب کنید.

توجه: اولین‌باری که جریان OAuth را فعال می‌کنید، از شما خواسته می‌شود شناسه ناشر AdMob خود را ارائه دهید و پیام‌واره مجوز را در مرورگرتان بپذیرید. قبل‌از پذیرفتن، مطمئن شوید با «حساب Google» که به حساب AdMob شما دسترسی دارد به سیستم وارد شده باشید. برنامه شما سپس برای دسترسی به داده‌ها ازطرف هر حسابی که درحال‌حاضر به سیستم آن وارد شده است مجاز می‌شود.

با اعتبارنامه‌های OAuth 2.0 ایجادشده، آماده‌اید تا استفاده از «میانای برنامه‌سازی کاربردی AdMob» را شروع کنید. برای درخواست دسترسی بااستفاده از OAuth 2.0، برنامه شما به اطلاعات حوزه نیز نیاز دارد:

حوزه	معنی
https://www.googleapis.com/auth/admob.readonly	دیدن همه داده‌های AdMob. این داده‌ها ممکن است شامل اطلاعات حساب، تنظیمات موجودی و میانجی‌گری، گزارش‌ها، و داده‌های دیگر باشد. این داده‌ها شامل داده‌های حساس مثل پرداخت‌ها یا جزئیات پویش نمی‌شود.
https://www.googleapis.com/auth/admob.report	گزارش‌های عملکرد آگهی و درآمد را ببینید. شناسه ناشر، منطقه زمانی، و کد واحد پول پیش‌فرض را ببینید.

اولین درخواست خود را برای تولید گزارش بااستفاده از مثال‌های Java، PHP، Python، یا curl ایجاد کنید.

کدهای هم‌رسانی‌شده را فسخ کنید

می‌توانید نشان‌های هم‌رسانی‌شده را به دو روش باطل کنید:

1. به صفحه اجازه‌های حساب Google خود بروید و دسترسی پروژه مربوطه را لغو کنید.

2. یا می‌توانید نشان‌های برنامه وب را بااستفاده از Google Identity API باطل کنید.