Looker Studio API

Looker Studio API به شما امکان می دهد دارایی های Looker Studio را جستجو و مدیریت کنید.

مورد اصلی استفاده از API این است که به سازمان‌های Google Workspace یا Cloud Identity اجازه می‌دهد مدیریت و انتقال دارایی‌های Looker Studio را خودکار کنند.

نکته کلیدی: API فقط برای کاربرانی در دسترس است که متعلق به سازمانی با Google Workspace یا Cloud Identity هستند.

بررسی اجمالی نیازمندی ها

برای استفاده از Looker Studio API مراحل زیر لازم است:

1. یک برنامه را برای استفاده از API پیکربندی کنید .
2. از کنسول Google Admin برای مجوز دادن به برنامه استفاده کنید .
3. توکن های دسترسی OAuth 2.0 را دریافت کنید و با API تماس بگیرید .

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

• برنامه های داخلی توسعه یافته برای یک سازمان. سازمان برنامه را برای همه کاربران سازمان خود پیکربندی و مجوز می دهد.
• برنامه های شخص ثالث توسعه یافته برای کاربران/مشتریان خارجی (یعنی توسعه دهنده و کاربران متعلق به سازمان های مختلف هستند). برنامه‌نویس برنامه را پیکربندی می‌کند اما سازمان کاربر به برنامه شخص ثالث مجوز می‌دهد.

1. یک برنامه را برای استفاده از API پیکربندی کنید

برای پیکربندی برنامه خود موارد زیر را تکمیل کنید:

• API را فعال کنید
• یک مشتری OAuth ایجاد کنید

API را فعال کنید

برای فعال کردن یک API برای پروژه خود:

1. Looker Studio API را در Google API Console باز کنید.
2. اگر از شما خواسته شد، یک پروژه را انتخاب کنید یا یک پروژه جدید ایجاد کنید.
3. روی Enable کلیک کنید.
4. اگر از شما خواسته شد، شرایط سرویس API را بخوانید و بپذیرید.

یک مشتری OAuth ایجاد کنید

مراحل زیر برای ایجاد یک OAuth Client دستورالعمل های کلی هستند و باید مطابق با نیازهای برنامه شما تنظیم شوند.

مهم: محدوده Looker Studio را به OAuth Client خود اضافه نکنید. زمانی که مدیر Workspace برنامه را تأیید کرد، دامنه‌ها توسط مدیر Workspace اضافه می‌شود.

1. به پیکربندی صفحه رضایت OAuth بروید.
   1. Internal را انتخاب کنید، روی ایجاد کلیک کنید.
   2. فیلدهای الزامی را پر کنید، روی ذخیره کلیک کنید.
2. به اعتبارنامه ها بروید.
   1. روی CREATE CREDENTIALS کلیک کنید.
   2. شناسه مشتری OAuth را انتخاب کنید.
   3. Application Type مناسب را انتخاب کنید. (برنامه وب رایج ترین است).
   4. فیلدهای الزامی را پر کنید، روی ایجاد کلیک کنید.
3. به شناسه مشتری توجه داشته باشید زیرا برای مجوز برنامه استفاده می شود.

2. مجوز برنامه برای یک سازمان

برنامه‌هایی که از Looker Studio API استفاده می‌کنند، فقط می‌توانند کاربران Google Workspace را در مواردی که سازمان کاربر با استفاده از تفویض اختیار در دامنه دامنه برای کنترل دسترسی API مجاز کرده باشد، احراز هویت کنند و مجوز دهند.

تفویض اختیار در دامنه دامنه را با شناسه مشتری OAuth برنامه و محدوده های مورد نیاز برنامه پیکربندی کنید.

مهم: مراحل زیر باید توسط یک مدیر Workspace تکمیل شود. سرپرست به شناسه مشتری OAuth برنامه و لیستی از محدوده های OAuth مورد نیاز برنامه نیاز دارد.

1. وارد کنسول Google Admin خود شوید و به نمایندگی گسترده دامنه بروید.
2. در API clients ، روی افزودن جدید کلیک کنید.
3. Client ID برنامه را برای مجوز وارد کنید (یعنی برنامه ای که از Looker Studio API استفاده می کند).
4. همه دامنه های OAuth مورد نیاز برنامه را وارد کنید. در صورت استفاده از Looker Studio API برای مدیریت دارایی ها، معمولاً دامنه های زیر درخواست می شود:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. روی تأیید کلیک کنید.

توجه: اگر برنامه شما نیازی به مدیریت دارایی‌های Looker Studio ندارد، به جای https://www.googleapis.com/auth/datastudio از https://www.googleapis.com/auth/datastudio.readonly محدوده محدودتر استفاده کنید. https://www.googleapis.com/auth/datastudio .

پس از تأیید برنامه، هر کاربر Workspace متعلق به سازمان به طور خودکار مجاز به استفاده از برنامه با Looker Studio API خواهد بود.

3. به دست آوردن توکن های دسترسی OAuth 2.0 و فراخوانی API

پس از توسعه و تأیید برنامه، دسترسی لازم برای تماس با API برای کاربران Workspace را خواهید داشت. برای جزئیات کار با Google API با استفاده از OAuth به استفاده از OAuth 2.0 برای دسترسی به Google API مراجعه کنید. برای عملیات موجود به مرجع API مراجعه کنید.

عیب یابی

گفتگوی OAuth وجود ندارد

اگر سازمان کاربری برنامه را مجاز کرده باشد، کاربران آن سازمان هنگام تأیید برنامه، کادر گفتگوی OAuth نشان داده نمی‌شوند. تنها استثنا در صورتی است که برنامه برای دامنه‌های Google API اضافی که سرپرست Workspace پیکربندی نکرده است، درخواست مجوز کند، در این صورت گفتگوی OAuth به کاربران نشان داده می‌شود.

خطای 400: invalid_scope

اگر کاربر هنگام تلاش برای مجوز دادن به برنامه، پیام Error 400: invalid_scope را دریافت کرد، سازمان کاربر به برنامه اجازه نداده یا به اشتباه آن را تأیید نکرده است. برای حل این مشکل، کاربر باید درخواست کند که سازمانش مجوز برنامه را صادر کند.