این سند نحوه احراز هویت در Ad Manager API را شرح می دهد. نحوه احراز هویت به رابطی که استفاده می‌کنید و محیطی که کد شما در آن اجرا می‌شود بستگی دارد، اما همه درخواست‌های API باید شامل یک نشانه دسترسی با دامنه API Ad Manager باشد.
کتابخانه‌های سرویس گیرنده Ad Manager از اعتبارنامه پیش‌فرض برنامه برای تولید نشانه‌های دسترسی با دامنه API Ad Manager استفاده می‌کنند. این راهنما نحوه پیکربندی اعتبار پیش فرض برنامه را نشان می دهد.
اگر از کتابخانه مشتری استفاده نمی کنید، همچنان باید اعتبارنامه ایجاد کنید و از آنها برای تأیید درخواست های خود استفاده کنید.
برای اطلاعات بیشتر در مورد احراز هویت و مجوز، به راهنمای استفاده از OAuth 2.0 مراجعه کنید.
نوع احراز هویت خود را تعیین کنید
| نوع احراز هویت | توضیحات |
|---|---|
| حساب خدمات | اگر می‌خواهید به‌عنوان حساب اختصاصی به جای یک شخص خاص، احراز هویت را انتخاب کنید. بیشتر بدانید . |
| برنامه وب | اگر می‌خواهید به عنوان هر کاربری که به برنامه شما اجازه دسترسی به داده‌های Ad Manager خود را می‌دهد، احراز هویت را انتخاب کنید. بیشتر بدانید |
| توسعه محلی | اگر می‌خواهید به‌عنوان «حساب Google» یا «حساب سرویس» از محیط توسعه محلی خود احراز هویت کنید، این را انتخاب کنید. |
Ad Manager API را فعال کنید
Ad Manager API را در Google API Console Project Cloud فعال کنید.
اگر از شما خواسته شد، یک پروژه را انتخاب کنید یا یک پروژه جدید ایجاد کنید.
اعتبارنامه ایجاد کنید
روی برگه مربوط به نوع احراز هویت خود کلیک کنید و دستورالعمل ها را برای ایجاد اعتبارنامه خود دنبال کنید:
حساب خدمات
در Google Cloud
برای احراز هویت یک بار کاری که در Google Cloud اجرا می شود، از اعتبار حساب سرویس متصل به منبع محاسباتی که کد شما در آن اجرا می شود استفاده می کنید.
به عنوان مثال، می توانید یک حساب سرویس را به یک نمونه ماشین مجازی Compute Engine (VM)، یک سرویس Cloud Run یا یک کار Dataflow متصل کنید. این رویکرد روش احراز هویت ترجیحی برای کدهای در حال اجرا در یک منبع محاسباتی Google Cloud است.
برای اطلاعات در مورد منابعی که می‌توانید یک حساب سرویس را به آن ضمیمه کنید، و برای کمک به پیوست کردن حساب سرویس به منبع، به مستندات پیوست کردن حساب سرویس مراجعه کنید.
در محل یا در یک ارائه دهنده ابر دیگر
روش ترجیحی برای تنظیم احراز هویت از خارج از Google Cloud استفاده از فدراسیون هویت حجم کار است. شما یک فایل پیکربندی اعتبارنامه ایجاد می کنید و متغیر محیطی GOOGLE_APPLICATION_CREDENTIALS را تنظیم می کنید تا به آن اشاره کند. این رویکرد از ایجاد یک کلید حساب سرویس ایمن تر است.
اگر قادر به پیکربندی فدراسیون هویت بار کاری نیستید، باید یک حساب سرویس ایجاد کنید و یک کلید برای حساب سرویس ایجاد کنید:
صفحه Google API Console Credentials را باز کنید.
در صفحه اعتبارنامه ها، Create credentials و سپس Service Account را انتخاب کنید.
روی آدرس ایمیل حساب سرویسی که می‌خواهید برای آن کلید ایجاد کنید کلیک کنید.
روی تب Keys کلیک کنید.
روی منوی کشویی افزودن کلید کلیک کنید، سپس ایجاد کلید جدید را انتخاب کنید.
JSON را به عنوان نوع کلید انتخاب کنید و روی Create کلیک کنید.
متغیر محیطی
GOOGLE_APPLICATION_CREDENTIALSرا روی مسیر فایل JSON قرار دهید.
لینوکس یا macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
ویندوز
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
برنامه وب
صفحه Google API Console Credentials را باز کنید.
اگر از شما خواسته شد، پروژه ای را انتخاب کنید که در آن Ad Manager API را فعال کرده اید.
در صفحه Credentials، Create credentials را انتخاب کنید، سپس OAuth Client ID را انتخاب کنید.
نوع برنامه کاربردی وب را انتخاب کنید.
فرم را پر کنید و روی ایجاد کلیک کنید. برنامه هایی که از زبان ها و فریم ورک هایی مانند PHP، جاوا، پایتون، روبی و دات نت استفاده می کنند باید URI های مجاز تغییر مسیر را مشخص کنند. URI های تغییر مسیر، نقاط پایانی هستند که سرور OAuth 2.0 می تواند پاسخ ها را به آنها ارسال کند. این نقاط پایانی باید از قوانین اعتبارسنجی Google پیروی کنند.
پس از ایجاد اعتبار، فایل client_secret.json را دانلود کنید. فایل را در مکانی ایمن ذخیره کنید که فقط برنامه شما بتواند به آن دسترسی داشته باشد.
از اینجا، مراحل دریافت توکن های دسترسی OAuth 2.0 را دنبال کنید
توسعه محلی
Application Default Credentials (ADC) را در محیط محلی خود تنظیم کنید.
Google Cloud CLI را نصب کنید، سپس با اجرای دستور زیر آن را مقداردهی اولیه کنید:
gcloud init
اعتبارنامه محلی احراز هویت را برای حساب Google خود ایجاد کنید و شناسه پروژه را روی پروژه ای تنظیم کنید که در آن Ad Manager API فعال است:
gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID
از طرف دیگر، با تنظیم متغیر محیطی GOOGLE_APPLICATION_CREDENTIALS در مسیر فایل کلید خود، به عنوان یک حساب سرویس احراز هویت کنید.
لینوکس یا macOS
export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
ویندوز
set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH
شبکه Ad Manager خود را پیکربندی کنید
حساب خدمات
- به شبکه Ad Manager خود بروید.
- روی تب Admin کلیک کنید.
- اطمینان حاصل کنید که دسترسی API فعال است.
- روی دکمه افزودن یک حساب کاربری سرویس کلیک کنید.
- با استفاده از ایمیل حساب سرویس، فرم را پر کنید. کاربر حساب سرویس باید به نقش ها و تیم های مناسب برای ادغام API شما اضافه شود.
- روی دکمه Save کلیک کنید. باید پیامی ظاهر شود که افزودن حساب سرویس شما را تأیید می کند.
- با رفتن به تب Users و سپس کلیک کردن روی فیلتر حساب سرویس، کاربران حساب های سرویس موجود را مشاهده کنید.
برنامه وب
- به شبکه Ad Manager خود بروید.
- روی تب Admin کلیک کنید.
- اطمینان حاصل کنید که دسترسی API فعال است.
توسعه محلی
- به شبکه Ad Manager خود بروید.
- روی تب Admin کلیک کنید.
- اطمینان حاصل کنید که دسترسی API فعال است.
بدون کتابخانه مشتری
اگر از کتابخانه سرویس گیرنده استفاده نمی کنید، همچنان قویاً توصیه می کنیم از کتابخانه OAuth2 برای احراز هویت استفاده کنید.
برای دستورالعمل‌های دقیق در مورد دریافت نشانه‌های دسترسی، به استفاده از OAuth2 با APIهای Google مراجعه کنید.
دسترسی به توکن ها
رمز دسترسی خود را با درج یک پارامتر پرس و جو access_token یا مقدار Bearer هدر HTTP Authorization در درخواست به API وارد کنید. در صورت امکان، هدر HTTP ترجیح داده می شود، زیرا رشته های پرس و جو در گزارش های سرور قابل مشاهده هستند.
به عنوان مثال:
GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX
GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg
دامنه
هر نشانه دسترسی با یک یا چند محدوده مرتبط است. یک محدوده مجموعه ای از منابع و عملیاتی را که یک نشانه دسترسی اجازه می دهد، کنترل می کند. Ad Manager REST API تنها یک محدوده دارد. مجوز باید در سطح کاربر در محصول انجام شود.
| دامنه | مجوزها |
|---|---|
https://www.googleapis.com/auth/admanager | کمپین های خود را در Google Ad Manager مشاهده و مدیریت کنید. |