همه فراخوانی‌های Google Ad Manager API باید ازطریق OAuth2 مجاز شوند، یک استاندارد باز که به کاربران اجازه می‌دهد به برنامه‌های شخص ثالث مجوز اعطا کنند تا برنامه بتواند ازطرف کاربر با سرویس‌های وب تعامل داشته باشد. OAuth2 به برنامه کارخواه Ad Manager API شما امکان می‌دهد بدون نیاز به مدیریت یا ذخیره نام کاربری یا گذرواژه کاربر، به حساب Ad Manager کاربر دسترسی پیدا کند.
تولید اعتبارنامه‌های OAuth2
مراحل زیر را برای تولید اطلاعات کاربری OAuth2 انجام دهید.
۱. تعیین نوع اصالت‌سنجی
جدول زیر را بررسی کنید تا ببینید کدام نوع اصالت‌سنجی برای برنامه Ad Manager API شما مناسب‌تر است:
| نوع اصالت‌سنجی OAuth2 را انتخاب کنید | |
|---|---|
| حساب سرویس |
اگر فقط به دسترسی به داده‌های Ad Manager خودتان نیاز دارید، این گزینه را انتخاب کنید. بیشتر بدانید. |
| برنامه وب |
اگر می‌خواهید به‌عنوان هر کاربری که به برنامه شما اجازه می‌دهد به داده‌های Ad Manager او دسترسی داشته باشد اصالت‌سنجی کنید، این گزینه را انتخاب کنید. بیشتر بدانید. |
۲. ایجاد اعتبارنامه‌های OAuth2
وقتی نوع اصالت‌سنجی‌تان را تعیین کردید، روی برگه مربوطه در زیر کلیک کنید و دستورالعمل‌ها را برای تولید اطلاعات کاربری OAuth2 دنبال کنید:
- صفحه اطلاعات کاربری کنسول Google API را باز کنید.
- از منو کرکره‌ای پروژه، ایجاد پروژه جدید را انتخاب کنید، نامی برای پروژه وارد کنید، و درصورت تمایل، «شناسه پروژه» ارائه‌شده را ویرایش کنید. روی ایجاد کلیک کنید.
- در صفحه «اطلاعات کاربری»، ایجاد اطلاعات کاربری را انتخاب کنید، سپس کلید حساب سرویس را انتخاب کنید.
- حساب سرویس جدید را انتخاب کنید و JSON را انتخاب کنید.
- روی ایجاد کلیک کنید تا فایلی حاوی کلید خصوصی بارگیری شود.
- صفحه اطلاعات کاربری کنسول Google API را باز کنید.
- از منوِ کرکره‌ای پروژه، ایجاد پروژه جدید را انتخاب کنید، نامی برای پروژه وارد کنید (و درصورت تمایل، شناسه پروژه ارائه‌شده را ویرایش کنید)، و روی ایجاد کلیک کنید.
- در صفحه «اعتبارنامه‌ها»، ایجاد اعتبارنامه را انتخاب کنید، سپس شناسه کارخواه OAuth را انتخاب کنید.
- ممکن است از شما خواسته شود نام محصولی را در صفحه «صفحه رضایت» تنظیم کنید؛ اگر چنین شد، روی پیکربندی صفحه رضایت کلیک کنید، اطلاعات درخواست‌شده را ارائه دهید، و روی ذخیره کلیک کنید تا به صفحه «اطلاعات کاربری» برگردید.
- برنامه وب را برای نوع برنامه انتخاب کنید. دستورالعمل‌ها را برای وارد کردن مبدأهای جاوا اسکریپت، شناسه منبع یکسان تغییرمسیر، یا هر دو دنبال کنید.
- روی ایجاد کردن کلیک کنید.
- در صفحه‌ای که ظاهر می‌شود، شناسه کارخواه و رمز کارخواه را در بریده‌دان کپی کنید، زیرا هنگام پیکربندی کتابخانه کارخواه به آن‌ها نیاز خواهید داشت.
۳. پیکربندی شبکه «مدیر آگهی» شما
اگر توسعه‌دهنده شخص ثالث هستید، ممکن است لازم باشد از مشتری‌تان بخواهید این مرحله را برای شما انجام دهد.
- به شبکه Ad Manager خود بروید.
- روی برگه سرپرست کلیک کنید.
- مطمئن شوید دسترسی به میانای برنامه‌سازی کاربردی فعال باشد.
- روی دکمه افزودن کاربر حساب سرویس کلیک کنید.
- فرم را بااستفاده از ایمیل حساب خدمات تکمیل کنید. کاربر حساب خدمات باید اجازه‌های دسترسی به نهادها را داشته باشد، به‌گونه‌ای که گویی کاربر حساب خدمات ازطریق واسط کاربر به نهادها دسترسی دارد.
- روی دکمه ذخیره کلیک کنید. پیامی باید ظاهر شود که افزوده شدن حساب سرویس شما را تأیید کند.
- با رفتن به برگه «کاربران» و سپس کلیک کردن روی فیلتر حساب خدمات، کاربران حساب خدمات موجود را مشاهده کنید.
- به شبکه Ad Manager خود بروید.
- روی برگه سرپرست کلیک کنید.
- مطمئن شوید دسترسی به میانای برنامه‌سازی کاربردی فعال باشد.
۴. پیکربندی و استفاده از کتابخانه کارخواه
برای استفاده از اطلاعات اعتباری در کتابخانه کارخواه، راهنمای مناسب زیر را دنبال کنید:
جاوا
دات نت
Python
PHP
Ruby
اگر تصمیم بگیرید از یکی از کتابخانه‌های کارخواه ما استفاده نکنید، باید جریان حساب سرویس OAuth2 یا برنامه وب را خودتان پیاده‌سازی کنید.
پشت صحنه
کتابخانه‌های مشتری ما به‌طور خودکار جزئیات پوشش‌داده‌شده در زیر را انجام می‌دهند، بنابراین فقط درصورتی ادامه مطلب را بخوانید که به آنچه در پشت صحنه اتفاق می‌افتد علاقه‌مند باشید. این بخش برای کاربران پیشرفته‌ای است که ازقبل با مشخصات OAuth2 آشنایی دارند و می‌دانند چگونه از OAuth2 با Google APIs استفاده کنند.
سرایند درخواست HTTP
سرایند HTTP در هر درخواست به Ad Manager API باید شامل کد دسترسی در این فرم باشد:
Authorization: Bearer ACCESS_TOKEN
برای مثال:
POST … HTTP/1.1 Host: … Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg Content-Type: text/xml;charset=UTF-8 Content-Length: … <?xml version="1.0"?> <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"> … </soap:Envelope>
حوزه
یک کد دسترسی واحد می‌تواند سطوح مختلفی از دسترسی به چندین میانای برنامه‌سازی کاربردی را اعطا کند. پارامتر متغیری به‌نام scope مجموعه منابع و عملیاتی را که کد دسترسی اجازه می‌دهد کنترل می‌کند. درطول درخواست کد دسترسی،
برنامه شما یک یا چند مقدار را در پارامتر scope ارسال می‌کند.
Ad Manager فقط یک دامنه دارد که در زیر نشان داده شده است. مجوزدهی باید در سطح کاربر در محصول انجام شود.
| حوزه | اجازه‌ها |
|---|---|
https://www.googleapis.com/auth/admanager |
پویش‌هایتان را در Ad Manager مشاهده و مدیریت کنید. |