تمام فراخوانیهای API مدیریت تبلیغات گوگل (Google Ad Manager API) باید از طریق OAuth2، یک استاندارد باز که به کاربران اجازه میدهد به برنامههای شخص ثالث مجوز بدهند، تأیید شوند تا برنامه بتواند از طرف کاربر با سرویسهای وب تعامل داشته باشد. OAuth2 به برنامه کلاینت API مدیریت تبلیغات شما این امکان را میدهد که بدون نیاز به مدیریت یا ذخیره نام کاربری یا رمز عبور کاربر، به حساب مدیریت تبلیغات کاربر دسترسی پیدا کند.
ایجاد اعتبارنامههای OAuth2
برای تولید اعتبارنامههای OAuth2 مراحل زیر را انجام دهید.
۱. نوع احراز هویت خود را تعیین کنید
برای اینکه ببینید کدام نوع احراز هویت برای برنامه Ad Manager API شما مناسبتر است، جدول زیر را بررسی کنید:
| نوع احراز هویت OAuth2 خود را انتخاب کنید | |
|---|---|
| حساب کاربری خدمات | اگر فقط به دادههای مدیریت تبلیغات خودتان نیاز دارید، این را انتخاب کنید. بیشتر بدانید. |
| برنامه وب | اگر میخواهید به عنوان هر کاربری که به برنامه شما اجازه دسترسی به دادههای Ad Manager خود را میدهد، احراز هویت شوید، این گزینه را انتخاب کنید. بیشتر بدانید. |
۲. اعتبارنامههای OAuth2 ایجاد کنید
پس از تعیین نوع احراز هویت خود، روی برگه مربوطه در زیر کلیک کنید و دستورالعملها را برای تولید اعتبارنامههای OAuth2 دنبال کنید:
- صفحه اعتبارنامههای کنسول API گوگل را باز کنید.
- از منوی کشویی پروژه، گزینه «ایجاد یک پروژه جدید» را انتخاب کنید، نامی برای پروژه وارد کنید و در صورت تمایل، شناسه پروژه ارائه شده را ویرایش کنید. روی «ایجاد» کلیک کنید.
- در صفحه اعتبارنامهها، گزینه ایجاد اعتبارنامهها و سپس کلید حساب سرویس را انتخاب کنید.
- حساب کاربری سرویس جدید و سپس JSON را انتخاب کنید.
- برای دانلود فایلی که حاوی کلید خصوصی است، روی «ایجاد» کلیک کنید.
- صفحه اعتبارنامههای کنسول API گوگل را باز کنید.
- از منوی کشویی پروژه، گزینه ایجاد یک پروژه جدید را انتخاب کنید، نامی برای پروژه وارد کنید (و در صورت تمایل، شناسه پروژه ارائه شده را ویرایش کنید) و روی ایجاد کلیک کنید.
- در صفحه اعتبارنامهها، گزینه ایجاد اعتبارنامهها و سپس شناسه کلاینت OAuth را انتخاب کنید.
- ممکن است از شما خواسته شود نام محصول را در صفحه «صفحه رضایت» تنظیم کنید؛ در این صورت، روی «پیکربندی صفحه رضایت» کلیک کنید، اطلاعات درخواستی را وارد کنید و برای بازگشت به صفحه «اعتبارنامهها» روی «ذخیره» کلیک کنید.
- برای نوع برنامه، برنامه وب را انتخاب کنید. دستورالعملها را برای وارد کردن جاوا اسکریپت، آدرسهای اینترنتی تغییر مسیر یا هر دو دنبال کنید.
- روی ایجاد کلیک کنید.
- در صفحهای که ظاهر میشود، شناسه کلاینت و رمز کلاینت را در کلیپبورد خود کپی کنید، زیرا هنگام پیکربندی کتابخانه کلاینت به آنها نیاز خواهید داشت.
۳. شبکه مدیریت تبلیغات خود را پیکربندی کنید
اگر شما یک توسعهدهنده شخص ثالث هستید، ممکن است لازم باشد که مشتری شما این مرحله را برای شما انجام دهد.
- به شبکه مدیر تبلیغات خود بروید.
- روی برگه مدیریت کلیک کنید.
- مطمئن شوید که دسترسی API فعال است.
- روی دکمه افزودن حساب کاربری سرویس کلیک کنید.
- فرم را با استفاده از ایمیل حساب سرویس پر کنید. به کاربر حساب سرویس باید مجوزهایی برای دسترسی به موجودیتها اعطا شود، گویی آن کاربر حساب سرویس به موجودیتهای موجود در رابط کاربری دسترسی دارد.
- روی دکمه ذخیره کلیک کنید. پیامی ظاهر میشود که افزودن حساب کاربری سرویس شما را تأیید میکند.
- با رفتن به برگه کاربران و سپس کلیک بر روی فیلتر حساب سرویس ، کاربران حساب سرویس موجود را مشاهده کنید.
- به شبکه مدیر تبلیغات خود بروید.
- روی برگه مدیریت کلیک کنید.
- مطمئن شوید که دسترسی API فعال است.
۴. پیکربندی و استفاده از کتابخانه کلاینت
برای استفاده از اعتبارنامهها در کتابخانه کلاینت خود، راهنمای مناسب زیر را دنبال کنید:
جاوا
دات نت
پایتون
پی اچ پی
روبی
اگر تصمیم به استفاده از یکی از کتابخانههای کلاینت ما ندارید، باید حساب سرویس OAuth2 یا جریان برنامه وب را خودتان پیادهسازی کنید.
پشت صحنه
کتابخانههای کلاینت ما بهطور خودکار جزئیات زیر را انجام میدهند، بنابراین فقط در صورتی که به اتفاقات پشت صحنه علاقهمند هستید، ادامه مطلب را بخوانید. این بخش برای کاربران حرفهای در نظر گرفته شده است که از قبل با مشخصات OAuth2 آشنا هستند و میدانند چگونه از OAuth2 با APIهای گوگل استفاده کنند .
هدر درخواست 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>
دامنه
یک توکن دسترسی میتواند درجات مختلفی از دسترسی به چندین API را اعطا کند. یک پارامتر متغیر به نام scope مجموعه منابع و عملیاتی را که یک توکن دسترسی مجاز میداند، کنترل میکند. در طول درخواست توکن دسترسی، برنامه شما یک یا چند مقدار را در پارامتر scope ارسال میکند.
مدیر تبلیغات فقط یک محدوده دارد که در زیر نشان داده شده است. مجوزدهی باید در سطح کاربر درون محصول انجام شود.
| دامنه | مجوزها |
|---|---|
https://www.googleapis.com/auth/admanager | کمپینهای خود را در Ad Manager مشاهده و مدیریت کنید. |