با AdMob API شروع کنید، با AdMob API شروع کنید، با AdMob API شروع کنید

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

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

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

پیش نیازها

نوع احراز هویت خود را تعیین کنید

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

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

یک پروژه ایجاد کنید

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

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

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

برای فعال کردن یک API برای پروژه خود:

  1. Open the API Library در Google API Console .
  2. If prompted, select a project, or create a new one. API Library لیست تمام API های موجود ، گروه بندی شده توسط خانواده محصول و محبوبیت.
  3. اگر API را که می خواهید فعال کنید در لیست قابل مشاهده نیست ، از جستجو برای یافتن آن استفاده کنید ، یا از View All در خانواده کالایی که به آن تعلق دارد کلیک کنید.
  4. API را که می خواهید فعال کنید انتخاب کنید ، سپس بر روی دکمه Enable کلیک کنید.
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

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

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

  1. Go to the Credentials page.

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

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

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

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

      اطلاعات بیشتر در مورد تنظیم صفحه رضایت OAuth خود را مشاهده کنید.

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

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

درخواست بدهید

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

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

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

اولین درخواست خود را برای ایجاد گزارش با استفاده از مثال هایی در جاوا ، پی اچ پی ، پایتون یا کرل ارائه دهید.

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

شما می توانید توکن های مشترک را به دو روش لغو کنید:

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

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

،

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

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

پیش نیازها

نوع احراز هویت خود را تعیین کنید

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

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

یک پروژه ایجاد کنید

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

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

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

برای فعال کردن یک API برای پروژه خود:

  1. Open the API Library در Google API Console .
  2. If prompted, select a project, or create a new one. API Library لیست تمام API های موجود ، گروه بندی شده توسط خانواده محصول و محبوبیت.
  3. اگر API را که می خواهید فعال کنید در لیست قابل مشاهده نیست ، از جستجو برای یافتن آن استفاده کنید ، یا از View All در خانواده کالایی که به آن تعلق دارد کلیک کنید.
  4. API را که می خواهید فعال کنید انتخاب کنید ، سپس بر روی دکمه Enable کلیک کنید.
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

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

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

  1. Go to the Credentials page.

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

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

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

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

      اطلاعات بیشتر در مورد تنظیم صفحه رضایت OAuth خود را مشاهده کنید.

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

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

درخواست بدهید

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

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

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

اولین درخواست خود را برای ایجاد گزارش با استفاده از مثال هایی در جاوا ، پی اچ پی ، پایتون یا کرل ارائه دهید.

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

شما می توانید توکن های مشترک را به دو روش لغو کنید:

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

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

،

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

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

پیش نیازها

نوع احراز هویت خود را تعیین کنید

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

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

یک پروژه ایجاد کنید

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

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

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

برای فعال کردن یک API برای پروژه خود:

  1. Open the API Library در Google API Console .
  2. If prompted, select a project, or create a new one. API Library لیست تمام API های موجود ، گروه بندی شده توسط خانواده محصول و محبوبیت.
  3. اگر API را که می خواهید فعال کنید در لیست قابل مشاهده نیست ، از جستجو برای یافتن آن استفاده کنید ، یا از View All در خانواده کالایی که به آن تعلق دارد کلیک کنید.
  4. API را که می خواهید فعال کنید انتخاب کنید ، سپس بر روی دکمه Enable کلیک کنید.
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

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

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

  1. Go to the Credentials page.

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

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

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

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

      اطلاعات بیشتر در مورد تنظیم صفحه رضایت OAuth خود را مشاهده کنید.

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

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

درخواست بدهید

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

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

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

اولین درخواست خود را برای ایجاد گزارش با استفاده از مثال هایی در جاوا ، پی اچ پی ، پایتون یا کرل ارائه دهید.

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

شما می توانید توکن های مشترک را به دو روش لغو کنید:

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

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