راه‌اندازی دسترسی میانای برنامه‌سازی کاربردی

در اینجا نحوه راه‌اندازی دسترسی به Data Manager API با کیت توسعه نرم‌افزار یا REST آورده شده است.

پیش‌نیازها

  1. پروژه Google Cloud یا «حساب Google» که می‌خواهید مالک پروژه باشد.

    • اگر پروژه‌ای ندارید، فرایند راه‌اندازی در بخش بعدی پروژه‌ای برایتان ایجاد می‌کند.

    • اگر ازقبل پروژه‌ای دارید، مطمئن شوید «حساب Google» شما نقشی دارد که می‌تواند میاناهای برنامه‌سازی کاربردی را در پروژه فعال کند، مثل مالک، ویرایشگر، یا سرپرست استفاده از سرویس. برای بررسی نقش خود، صفحه IAM را در کنسول Google Cloud باز کنید، پروژه خود را انتخاب کنید، و «حساب Google» خود را در فهرست پیدا کنید.

      برای جزئیات بیشتر، مشاهده دسترسی فعلی را ببینید.

  2. Google Cloud CLI نصب شده باشد.

فعال کردن میانای برنامه‌سازی کاربردی

اگر قبلاً این کار را نکرده‌اید، Data Manager API را در پروژه Google Cloud خود با کلیک کردن روی فعال کردن Data Manager API فعال کنید یا دستورالعمل‌ها را برای انجام دستی این مرحله دنبال کنید.

فعال کردن Data Manager API

اگر نمی‌توانید Data Manager API را پیدا کنید یا فعال کردن Data Manager API ناموفق است، بررسی کنید «حساب Google» شما پیش‌نیازها را برآورده می‌کند یا نه.

راه‌اندازی اصالت‌سنجی

می‌توانید از هرکدام از روش‌های اصالت‌سنجی در Google به‌غیراز کلیدهای میانای برنامه‌سازی کاربردی استفاده کنید. توصیه می‌کنیم نحوه انتخاب روش اصالت‌سنجی مناسب برای مورد استفاده‌تان را مرور کنید تا تصمیم بگیرید کدام رویکرد برای مورد استفاده شما مناسب است.

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

  • حساب‌های کاربری: نشان‌دهنده افرادی است که مستقیماً با میاناهای برنامه‌سازی کاربردی و سرویس‌های Google تعامل دارند.
  • حساب‌های خدمات: برنامه‌ها را به‌عنوان کاربر نشان می‌دهند، نه افراد. این کلیدها به برنامه‌هایتان اجازه می‌دهند اصالت‌سنجی و صدور مجوز را مدیریت کنند. برای مثال، اگر برنامه‌ای نیاز به دسترسی به منابع Google Cloud داشته باشد.

یکپارچه‌سازی شما می‌تواند از اعتبارنامه پیش‌فرض برنامه (ADC) استفاده کند تا به‌طور خودکار اعتبارنامه‌ها را از محیط پیدا کند، بنابراین لازم نیست کد کارخواه را برای اصالت‌سنجی تغییر دهید.

برای راه‌اندازی ADC، حساب کاربر یا حساب سرویس را انتخاب کنید:

حساب کاربر

مراحل اصالت‌سنجی با اعتبارنامه‌های حساب کاربری در اینجا آمده است:

  1. تنظیمات پلاتفرم Google Auth را برای پروژه‌تان پیکربندی کنید.

    1. صفحه نمانام‌سازی را در کنسول Google Cloud باز کنید.

    2. پروژه‌تان را انتخاب کنید.

    3. فرم را تکمیل کنید و روی ایجاد کلیک کنید.

  2. ازآنجایی‌که Data Manager API از گستره‌های حساس استفاده می‌کند، مراحل زیر الزامی است:

    1. به تنظیمات دسترسی به داده برای پروژه‌تان بروید.

    2. روی افزودن یا برداشتن دامنه‌ها کلیک کنید.

    3. در فهرست دامنه‌ها، Data Manager API را پیدا کنید و چارگوش را برای هر دامنه‌ای که برنامه‌تان نیاز دارد علامت بزنید:

      • .../auth/datamanager: این گستره را برای عملیات استاندارد API، مانند مدیریت داده‌های مشتری، مخاطبان، و رویدادها انتخاب کنید. این گستره اصلی است که در سراسر این راهنما استفاده می‌شود.

      • .../auth/datamanager.partnerlink: این گستره را فقط درصورتی انتخاب کنید که شریک داده‌ای باشید که در حساب‌های تبلیغ‌کننده پیوندهای شریک ایجاد یا حذف می‌کند.

    4. روی به‌روزرسانی کلیک کنید.

    5. روی ذخیره کلیک کنید.

    6. به مخاطب در کنسول Google Cloud بروید و تنظیمات را برای توسعه اولیه پیکربندی کنید:

      • وضعیت انتشار را روی درحال آزمایش تنظیم کنید.
      • نوع کاربر را روی داخلی (اگر پروژه‌تان در سازمان Google Workspace است) یا خارجی (اگر در سازمان Google Workspace نیست) تنظیم کنید.
      • اگر از خارجی استفاده می‌کنید، «حساب‌های Google» را که برای تولید اعتبارنامه استفاده می‌کنید به‌عنوان کاربران آزمایشی اضافه کنید.

      درباره این تنظیمات در مدیریت مخاطبان برنامه بیشتر بدانید.

  3. روی ایجاد کارخواه OAuth2 کلیک کنید تا کارخواه OAuth2 در پروژه ایجاد شود، یا دستورالعمل‌ها را دنبال کنید تا کارخواه OAuth2 رایانه ایجاد شود. اگر ازقبل مشتری OAuth2 رایانه دارید که می‌خواهید از آن برای Data Manager API استفاده کنید، می‌توانید این مرحله را رد کنید.

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

    ایجاد کارخواه OAuth2

    در مرحله آخر، روی بارگیری پیکربندی کارخواه کلیک کنید و مکان بارگیری انتخابی‌تان را یادداشت کنید.

  4. با اجرای فرمان زیر، فایل ADC محلی ایجاد کنید. این فرمان یک جریان وب را راه‌اندازی می‌کند که در آن از شما خواسته می‌شود به سیستم «حساب Google» که با میانای برنامه‌سازی کاربردی استفاده می‌کنید وارد شوید.

    PATH_TO_CLIENT_JSON را با نام فایل JSON که بارگیری کردید جایگزین کنید.

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    اگر می‌خواهید از اطلاعات کاربری یکسانی برای Data Manager API و Google Ads API استفاده کنید، دامنه Google Ads API را در فهرست --scopes بگنجانید:

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

    اگر می‌خواهید از اطلاعات کاربری یکسانی برای Data Manager API و Display & Video 360 API استفاده کنید، دامنه Display & Video 360 API را در فهرست --scopes اضافه کنید:

    gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="PATH_TO_CLIENT_JSON"

  5. بااستفاده از فرمان زیر، تأیید کنید که اطلاعات اعتباری به‌درستی راه‌اندازی شده است. اگر موفقیت‌آمیز باشد، فرمان یک کد دسترسی را در کنسول چاپ می‌کند.

    gcloud auth application-default print-access-token

حساب سرویس

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

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

    ایجاد حساب سرویس

  2. نقش IAM مصرف‌کننده استفاده از سرویس (roles/serviceusage.serviceUsageConsumer) را به حساب سرویس اعطا کنید که شامل اجازه serviceusage.services.use است که به حساب سرویس اجازه می‌دهد درخواست‌های API را برای پروژه ارسال کند.

    gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:SERVICE_ACCOUNT_EMAIL" \
  --role="roles/serviceusage.serviceUsageConsumer"

  3. به «حساب Google» خود نقش IAM ایجادکننده نشان حساب سرویس (roles/iam.serviceAccountTokenCreator) را در حساب سرویس اعطا کنید.

    gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
  --member="user:USER_EMAIL" \
  --role="roles/iam.serviceAccountTokenCreator"

  4. با اجرای فرمان زیر، ADC خود را پیکربندی کنید:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform"

    اگر می‌خواهید از اطلاعات کاربری یکسانی برای Data Manager API و Google Ads API استفاده کنید، دامنه Google Ads API را در فهرست --scopes بگنجانید:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform"

    اگر می‌خواهید از اطلاعات کاربری یکسانی برای Data Manager API و Display & Video 360 API استفاده کنید، دامنه Display & Video 360 API را در فهرست --scopes اضافه کنید:

    gcloud auth application-default login \
  --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform"

    وقتی از شما خواسته شد به سیستم وارد شوید، با «حساب Google» خودتان که نقش «ایجادکننده کد حساب سرویس» را دارد به سیستم وارد شوید.

  5. بااستفاده از فرمان زیر، تأیید کنید که اطلاعات اعتباری به‌درستی راه‌اندازی شده است. اگر موفقیت‌آمیز باشد، فرمان کد دسترسی را در کنسول چاپ می‌کند.

    gcloud auth application-default print-access-token --scopes="https://www.googleapis.com/auth/datamanager"

برای کسب اطلاعات بیشتر درباره اصالت‌سنجی و اطلاعات کاربری برای برنامه‌تان، به روش‌های اصالت‌سنجی در Google و نحوه عملکرد «اطلاعات کاربری پیش‌فرض برنامه» مراجعه کنید.

راه‌اندازی دسترسی به حساب

حساب کاربر

برگه مربوط به مورد استفاده‌تان را انتخاب کنید.

  • اگر از اطلاعات اعتباری «حساب Google» استفاده می‌کنید که کاربر حساب‌های تبلیغ‌کننده‌ای است که می‌خواهید مدیریت کنید، تبلیغ‌کننده را انتخاب کنید.
  • اگر از اطلاعات کاربری «حساب Google» استفاده می‌کنید که کاربر حساب شریک داده است و می‌خواهید حساب‌های آگهی‌دهنده‌ای را که پیوند شریک به حساب شریک داده دارند مدیریت کنید، شریک داده را انتخاب کنید. حساب‌های شریک داده فقط پس‌از طی کردن فرایند تأیید صادر می‌شوند. برای شروع، فرم علاقه‌مندی را تکمیل کنید.

آگهی‌دهنده

به ایمیل مرتبط با کاربر دسترسی به Destination را اعطا کنید.

دستورالعمل‌ها را دنبال کنید تا ایمیل کاربر را به حساب Google Ads یا حساب مدیر Google Ads اصلی اضافه کنید.

Display & Video 360

دستورالعمل‌ها را دنبال کنید تا ایمیل کاربر را به حساب اضافه کنید.

Google Analytics

دستورالعمل‌ها را دنبال کنید تا ایمیل کاربر را به حساب اضافه کنید.

شریک داده

به ایمیل منسوب به کاربر اجازه دهید به حساب شریک داده شما دسترسی داشته باشد. معمولاً شرکای داده از حساب سرویس برای دسترسی به API استفاده می‌کنند. بااین‌حال، اگر از حساب کاربری برای آزمایش یا اهداف دیگر استفاده می‌کنید، باید به حساب کاربری‌تان اجازه دسترسی به حساب شریک داده را بدهید.

با دنبال کردن این دستورالعمل‌ها، ایمیل کاربر را ازطریق میانای کاربری Google Ads به حساب شریک داده اضافه کنید.

حساب سرویس

برگه مربوط به مورد استفاده‌تان را انتخاب کنید.

  • اگر از اطلاعات اعتباری «حساب Google» استفاده می‌کنید که کاربر حساب‌های تبلیغ‌کننده‌ای است که می‌خواهید مدیریت کنید، تبلیغ‌کننده را انتخاب کنید.
  • اگر از اطلاعات کاربری «حساب Google» استفاده می‌کنید که کاربر حساب شریک داده است و می‌خواهید حساب‌های آگهی‌دهنده‌ای را که پیوند شریک به حساب شریک داده دارند مدیریت کنید، شریک داده را انتخاب کنید. حساب‌های شریک داده فقط پس‌از طی کردن فرایند تأیید صادر می‌شوند. برای شروع، فرم علاقه‌مندی را تکمیل کنید.

آگهی‌دهنده

به ایمیل مرتبط با حساب سرویس خود اجازه دسترسی به Destination را بدهید.

راه‌اندازی دسترسی به حساب را تکمیل کنید تا حساب سرویس را به حساب Google Ads یا حساب مدیر Google Ads اصلی اضافه کنید.

Display & Video 360

دستورالعمل‌ها را دنبال کنید تا کاربر Display & Video 360 مرتبط با حساب سرویس را ایجاد کنید.

Google Analytics

دستورالعمل‌ها را دنبال کنید تا ایمیل حساب سرویس را به حساب اضافه کنید.

شریک داده

به ایمیل مرتبط با حساب سرویس خود اجازه دسترسی به حساب شریک داده خود را بدهید.

دسترسی به حساب شریک داده ازطریق میانای کاربری Google Ads مدیریت می‌شود. برای افزودن حساب سرویس و تنظیم سطح دسترسی آن، مراحل موجود در راه‌اندازی دسترسی به حساب را دنبال کنید.

مراحل بعدی

بعدی
نصب کتابخانه کارخواه