Looker Studio API

رابط برنامه‌نویسی کاربردی Looker Studio به شما امکان می‌دهد تا فایل‌های Looker Studio را جستجو و مدیریت کنید.

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

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

مرور کلی الزامات

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

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

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

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

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

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

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

فعال کردن API

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

1. [Looker Studio API] را در کنسول Google API باز کنید.
2. در صورت درخواست، یک پروژه را انتخاب کنید یا یک پروژه جدید ایجاد کنید.
3. روی فعال کردن کلیک کنید.
4. در صورت درخواست، شرایط خدمات API را بخوانید و بپذیرید.

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

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

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

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

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

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

واگذاری اختیارات در سطح دامنه را با استفاده از شناسه کلاینت OAuth برنامه و محدوده‌های مورد نیاز برنامه پیکربندی کنید.

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

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

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

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

۳. دریافت توکن‌های دسترسی OAuth 2.0 و فراخوانی API

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

عیب‌یابی

کادر محاوره‌ای OAuth وجود ندارد

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

خطای ۴۰۰: invalid_scope

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