در اینجا نحوه راهاندازی دسترسی به Data Manager API با کیت توسعه نرمافزار یا REST آورده شده است.
پیشنیازها
پروژه Google Cloud یا «حساب Google» که میخواهید مالک پروژه باشد.
- اگر پروژهای ندارید، فرایند راهاندازی در بخش بعدی پروژهای برایتان ایجاد میکند.
اگر ازقبل پروژه دارید، مطمئن شوید «حساب Google» شما نقشی داشته باشد که بتواند میاناهای برنامهسازی کاربردی را در پروژه فعال کند، مثل مالک، ویرایشگر، یا سرپرست استفاده از سرویس. برای بررسی نقش خود، صفحه IAM را در کنسول Google Cloud باز کنید، پروژه خود را انتخاب کنید، و «حساب Google» خود را در فهرست پیدا کنید.
برای جزئیات بیشتر، مشاهده دسترسی فعلی را ببینید.
Google Cloud CLI نصب شده باشد.
فعال کردن میانای برنامهسازی کاربردی
اگر قبلاً این کار را نکردهاید، با کلیک کردن روی فعال کردن Data Manager API یا با دنبال کردن دستورالعملها برای انجام دستی این مرحله، Data Manager API را در پروژه Google Cloud خود فعال کنید.
فعال کردن Data Manager APIاگر نمیتوانید Data Manager API را پیدا کنید یا فعال کردن Data Manager API ناموفق است، بررسی کنید «حساب Google» شما پیشنیازها را برآورده میکند یا نه.
راهاندازی اصالتسنجی
میتوانید از هریک از روشهای اصالتسنجی در Google بهجز کلیدهای API استفاده کنید. توصیه میکنیم نحوه انتخاب روش اصالتسنجی مناسب برای مورد استفادهتان را مرور کنید تا تصمیم بگیرید کدام رویکرد برای مورد استفاده شما مناسب است.
دو روش اصالتسنجی رایج عبارتاند از حسابهای کاربری و حسابهای سرویس:
- حسابهای کاربر: نشاندهنده افرادی است که مستقیماً با سرویسها و واسطهای برنامهسازی کاربردی Google تعامل دارند.
- حسابهای خدمات: برنامهها را بهعنوان کاربر نشان میدهند، نه افراد. این کلیدها به برنامههایتان اجازه میدهند اصالتسنجی و صدور مجوز را مدیریت کنند. برای مثال، اگر برنامهای نیاز به دسترسی به منابع Google Cloud داشته باشد.
یکپارچهسازی شما میتواند از اطلاعات اعتباری پیشفرض برنامه (ADC) برای یافتن خودکار اطلاعات اعتباری از محیط استفاده کند، بنابراین لازم نیست کد کارخواه را برای اصالتسنجی تغییر دهید.
برای راهاندازی ADC، حساب کاربر یا حساب سرویس را انتخاب کنید:
حساب کاربر
در اینجا مراحل اصالتسنجی با اطلاعات اعتباری حساب کاربری آمده است:
تنظیمات پلاتفرم اصالتسنجی Google را برای پروژهتان پیکربندی کنید.
صفحه نمانامسازی را در کنسول Google Cloud باز کنید.
پروژهتان را انتخاب کنید.
فرم را تکمیل کنید و روی ایجاد کلیک کنید.
ازآنجاییکه Data Manager API از گسترههای حساس استفاده میکند، مراحل زیر الزامی است:
به تنظیمات دسترسی به داده برای پروژهتان بروید.
روی افزودن یا برداشتن محدودهها کلیک کنید.
در فهرست دامنهها، Data Manager API را پیدا کنید و چارگوش را برای هر دامنهای که برنامهتان نیاز دارد علامت بزنید:
.../auth/datamanager: این محدوده را برای عملیات استاندارد API انتخاب کنید، مثلاً مدیریت دادههای مشتری، مخاطبان، و رویدادها. این گستره اصلی است که در سراسر این راهنما استفاده میشود..../auth/datamanager.partnerlink: این محدوده را فقط درصورتی انتخاب کنید که شریک دادهای باشید که درحال ایجاد یا حذف پیوندهای شریک در حسابهای تبلیغکننده است.
روی بهروزرسانی کلیک کنید.
روی ذخیره کلیک کنید.
در کنسول Google Cloud به مخاطب بروید و تنظیمات توسعه اولیه را پیکربندی کنید:
- وضعیت انتشار را روی آزمایش تنظیم کنید.
- نوع کاربر را روی داخلی (اگر پروژه شما در سازمان Google Workspace است) یا خارجی (اگر در سازمان Google Workspace نیست) تنظیم کنید.
- اگر از خارجی استفاده میکنید، «حسابهای Google» را که برای تولید اطلاعات اعتباری استفاده میکنید بهعنوان کاربران آزمایشی اضافه کنید.
درباره این تنظیمات در مدیریت مخاطبان برنامه بیشتر بدانید.
برای ایجاد کارخواه OAuth2 در پروژه، روی ایجاد کارخواه OAuth2 کلیک کنید، یا برای ایجاد کارخواه OAuth2 رایانه، دستورالعملها را دنبال کنید. اگر ازقبل مشتری OAuth2 رایانه دارید که میخواهید از آن برای Data Manager API استفاده کنید، میتوانید این مرحله را رد کنید.
اگر روی ایجاد کارخواه OAuth2 کلیک کردید، وقتی از شما خواسته شد کارخواه OAuth خود را پیکربندی کنید، برنامه رایانه را انتخاب کنید تا بتوانید از کارخواه در مراحل باقیمانده استفاده کنید.
ایجاد کارخواه OAuth2در مرحله آخر، روی بارگیری پیکربندی کارخواه کلیک کنید و مکان بارگیری انتخابیتان را یادداشت کنید.
با اجرای فرمان زیر، فایل ADC محلی ایجاد کنید. این فرمان جریان وبی راهاندازی میکند که در آن از شما خواسته میشود به سیستم «حساب Google» که با 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"اگر میخواهید از اطلاعات کاربری یکسانی برای 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"بااستفاده از فرمان زیر، تأیید کنید اطلاعات اعتباری بهدرستی تنظیم شده است. اگر موفقیتآمیز باشد، فرمان یک کد دسترسی را در کنسول چاپ میکند.
gcloud auth application-default print-access-token
حساب سرویس
در اینجا مراحل ایجاد حساب خدمات و استفاده از جعل هویت حساب خدمات برای اصالتسنجی در محیط توسعه محلی آمده است. این مراحل بهجای کلیدهای حساب سرویس از جعل هویت استفاده میکنند زیرا اگر کلیدهای حساب سرویس بهدقت مدیریت نشوند، میتوانند به یک خطر امنیتی تبدیل شوند.
روی دکمه ایجاد حساب سرویس در زیر کلیک کنید یا دستورالعملها را برای انتخاب یا ایجاد حساب سرویس دنبال کنید.
ایجاد حساب سرویسنقش 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"نقش IAM سازنده نشان سرویس حساب را به حساب Google خودتان در حساب خدماتی (
roles/iam.serviceAccountTokenCreator) اعطا کنید.gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \ --member="user:USER_EMAIL" \ --role="roles/iam.serviceAccountTokenCreator"با اجرای فرمان زیر، 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» خودتان که نقش «ایجادکننده کد حساب سرویس» را دارد به سیستم وارد شوید.
بااستفاده از فرمان زیر، تأیید کنید که اطلاعات اعتباری بهدرستی راهاندازی شده است. اگر موفقیتآمیز باشد، فرمان کد دسترسی را در کنسول چاپ میکند.
gcloud auth application-default print-access-token --scopes="https://www.googleapis.com/auth/datamanager"
برای کسب اطلاعات بیشتر درباره اصالتسنجی و اطلاعات اعتباری برنامهتان، به روشهای اصالتسنجی در Google و نحوه عملکرد اطلاعات اعتباری پیشفرض برنامه مراجعه کنید.
راهاندازی دسترسی به حساب
حساب کاربری
برگهای را که با مورد استفاده شما مطابقت دارد انتخاب کنید.
- اگر از اطلاعات اعتباری «حساب Google» استفاده میکنید که کاربر حسابهای تبلیغکنندهای است که میخواهید مدیریت کنید، تبلیغکننده را انتخاب کنید.
- اگر از اطلاعات کاربری «حساب Google» استفاده میکنید که کاربر حساب شریک داده است و میخواهید حسابهای آگهیدهندهای را که پیوند شریک به حساب شریک داده دارند مدیریت کنید، شریک داده را انتخاب کنید. حسابهای شریک داده فقط پساز طی کردن فرایند تأیید صادر میشوند. برای شروع، فرم علاقهمندی را تکمیل کنید.
آگهیدهنده
به ایمیل مرتبط با کاربر دسترسی به
Destination را اعطا کنید.
Google Ads
دستورالعملها را دنبال کنید تا ایمیل کاربر را به حساب Google Ads یا حساب مدیر Google Ads والد اضافه کنید.
Display & Video 360
برای افزودن ایمیل کاربر به حساب، دستورالعملها را دنبال کنید.
Google Analytics
دستورالعملها را دنبال کنید تا ایمیل کاربر را به حساب اضافه کنید.
شریک داده
به ایمیل منسوب به کاربر اجازه دهید به حساب شریک داده شما دسترسی داشته باشد. معمولاً شرکای داده از حساب سرویس برای دسترسی به API استفاده میکنند. بااینحال، اگر از حساب کاربری برای آزمایش یا اهداف دیگر استفاده میکنید، باید به حساب کاربری خود اجازه دهید به حساب شریک داده دسترسی داشته باشد.
ایمیل کاربر را ازطریق واسط کاربر Google Ads به حساب شریک داده اضافه کنید با دنبال کردن این دستورالعملها.
حساب سرویس
برگه مربوط به مورد استفادهتان را انتخاب کنید.
- اگر از اطلاعات اعتباری «حساب Google» استفاده میکنید که کاربر در حسابهای تبلیغکنندهای است که میخواهید مدیریت کنید، تبلیغکننده را انتخاب کنید.
- اگر از اطلاعات کاربری «حساب Google» استفاده میکنید که کاربر حساب شریک داده است و میخواهید حسابهای آگهیدهندهای را که پیوند شریک به حساب شریک داده دارند مدیریت کنید، شریک داده را انتخاب کنید. حسابهای شریک داده فقط پساز طی کردن فرایند تأیید صادر میشوند. برای شروع، فرم علاقهمندی را تکمیل کنید.
آگهیدهنده
به ایمیل مرتبط با حساب سرویس خود اجازه دسترسی به
Destination را بدهید.
Google Ads
راهاندازی دسترسی به حساب را تکمیل کنید تا حساب سرویس را به حساب Google Ads یا حساب مدیر Google Ads اصلی اضافه کنید.
Display & Video 360
دستورالعملها را دنبال کنید تا کاربر Display & Video 360 مرتبط با حساب سرویس را ایجاد کنید.
Google Analytics
دستورالعملها را دنبال کنید تا ایمیل حساب سرویس را به حساب اضافه کنید.
شریک داده
به ایمیل مرتبط با حساب سرویس خود اجازه دهید به حساب شریک داده شما دسترسی داشته باشد.
دسترسی به حساب شریک داده ازطریق میانای کاربری Google Ads مدیریت میشود. برای افزودن حساب سرویس و تنظیم سطح دسترسی آن، مراحل راهاندازی دسترسی حساب را دنبال کنید.
مراحل بعدی
- کتابخانه کارخواه را نصب کنید و نمونههای کد را اجرا کنید تا اولین درخواست Data Manager API را امتحان کنید.
- با نحوه پیکربندی اصالتسنجی هنگام استقرار در تولید آشنا شوید.