دسترسی API را تنظیم کنید

در اینجا نحوه تنظیم دسترسی به API مدیریت داده با SDK یا REST آورده شده است.

پیش‌نیازها

قبل از اینکه بتوانید از Data API استفاده کنید، مطمئن شوید که موارد زیر را دارید:

1. یک پروژه گوگل کلود . می‌توانید از یک پروژه موجود استفاده کنید یا یک پروژه جدید مخصوص رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) ایجاد کنید.

2. یک حساب گوگل که مجوز serviceusage.services.enable را در پروژه Google Cloud شما داشته باشد، یا نقشی داشته باشد که شامل آن مجوز باشد. برای مثال، roles/owner و roles/serviceusage.serviceUsageAdmin هر دو شامل مجوز serviceusage.services.enable هستند. برای بررسی مجوزهای خود، به مشاهده دسترسی فعلی مراجعه کنید.

3. رابط خط فرمان گوگل کلود نصب شد .

فعال کردن API

اگر قبلاً این کار را نکرده‌اید، با کلیک روی «فعال کردن API مدیریت داده» (Enable the Data Manager API) آن را فعال کنید یا دستورالعمل‌ها را برای انجام دستی این مرحله دنبال کنید.

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

اگر نمی‌توانید رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) را پیدا کنید یا فعال کردن رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) با شکست مواجه شد، تأیید کنید که حساب گوگل شما پیش‌نیازها را برآورده می‌کند.

تنظیم احراز هویت

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

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

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

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

برای تنظیم ADC، حساب کاربری یا حساب سرویس را انتخاب کنید:

حساب کاربری

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

1. تنظیمات پلتفرم احراز هویت گوگل (Google Auth Platform) را برای پروژه خود پیکربندی کنید.

   مهم: هر برنامه Google Cloud که برای دریافت اعتبارنامه کاربر برای محدوده API مدیر داده استفاده می‌شود، باید تأیید اعتبار Google OAuth را انجام دهد تا از نمایش صفحه رابط کاربری تأیید نشده برای کاربران خود جلوگیری کند. تأیید اعتبار Google OAuth برای حساب‌های سرویس لازم نیست.

   1. صفحه برندسازی را در کنسول ابری گوگل باز کنید.

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

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

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

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

   2. روی افزودن یا حذف محدوده‌ها کلیک کنید.

   3. کادر کنار Data Manager API را در لیست محدوده‌ها علامت بزنید و روی به‌روزرسانی کلیک کنید.

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

   5. به بخش مخاطبان در کنسول گوگل کلود بروید و وضعیت انتشار و نوع کاربر را به‌روزرسانی کنید. برای کسب اطلاعات بیشتر در مورد این تنظیمات به مدیریت مخاطبان برنامه مراجعه کنید.

3. برای ایجاد یک کلاینت OAuth2 در پروژه، روی «ایجاد کلاینت OAuth2» کلیک کنید، یا دستورالعمل‌ها را برای ایجاد یک کلاینت OAuth2 دسکتاپ دنبال کنید. اگر از قبل یک کلاینت OAuth2 دسکتاپ دارید که می‌خواهید برای API مدیریت داده استفاده کنید، می‌توانید از این مرحله صرف نظر کنید.

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

   ایجاد کلاینت OAuth2

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

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

   به جای 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"
   

   اگر می‌خواهید از اعتبارنامه‌های یکسانی برای API مدیریت داده و API تبلیغات گوگل استفاده کنید، محدوده 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"
   

   اگر می‌خواهید از اعتبارنامه‌های یکسانی برای API مدیریت داده و API نمایش و ویدئو ۳۶۰ استفاده کنید، محدوده‌ی 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. به حساب گوگل خود، نقش IAM مربوط به Service Account Token Creator ( 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"
   

   اگر می‌خواهید از اعتبارنامه‌های یکسانی برای API مدیریت داده و API تبلیغات گوگل استفاده کنید، محدوده 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"
   

   اگر می‌خواهید از اعتبارنامه‌های یکسانی برای API مدیریت داده و API نمایش و ویدئو ۳۶۰ استفاده کنید، محدوده‌ی 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"
   

   وقتی از شما خواسته شد وارد سیستم شوید، به عنوان حساب گوگل خود که نقش Service Account Token Creator را دارد، وارد شوید.

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

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

توجه: دامنه https://www.googleapis.com/auth/datamanager برای همه سرویس‌های موجود در رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) الزامی است.

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

تنظیم دسترسی به حساب کاربری

حساب کاربری

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

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

تبلیغ کننده

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

تبلیغات گوگل

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

نمایش و ویدئو ۳۶۰

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

گوگل آنالیتیکس

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

شریک داده

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

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

حساب کاربری خدمات

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

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

تبلیغ کننده

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

تبلیغات گوگل

تنظیمات دسترسی به حساب را تکمیل کنید تا حساب سرویس به حساب گوگل ادز یا یک حساب والد مدیریت گوگل ادز اضافه شود.

نمایش و ویدئو ۳۶۰

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

گوگل آنالیتیکس

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

شریک داده

به ایمیل مرتبط با حساب سرویس خود، دسترسی به حساب شریک داده خود را اعطا کنید.

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

مراحل بعدی

یک کتابخانه کلاینت نصب کنید و نمونه‌های کد را اجرا کنید تا اولین درخواست API مدیریت داده خود را امتحان کنید.