Data Studio API

تتيح لك واجهة برمجة تطبيقات الاستوديو Data Studio API البحث عن مواد العرض في "مركز البيانات" وإدارتها.

حالة الاستخدام الأساسية لواجهة برمجة التطبيقات هي السماح لمؤسسات Google Workspace أو Cloud Identity بأتمتة إدارة ونقل مواد عرض Data Studio.

ملاحظة مهمة: لا تتوفّر واجهة برمجة التطبيقات إلا للمستخدمين الذين ينتمون إلى مؤسسة لديها Google Workspace أو Cloud Identity.

نظرة عامة حول المتطلبات

يجب اتّباع الخطوات التالية لاستخدام Data Studio API:

1. ضبط تطبيق لاستخدام واجهة برمجة التطبيقات
2. استخدام "وحدة تحكّم المشرف في Google" لمنح الإذن للتطبيق
3. الحصول على رموز الدخول إلى OAuth 2.0 واستدعاء واجهة برمجة التطبيقات

يمكن أن تنفّذ المؤسسة نفسها أو مؤسسات مختلفة الخطوات المذكورة أعلاه استنادًا إلى السيناريوهات الشائعة التالية:

• التطبيقات الداخلية التي تم تطويرها لمؤسسة تضبط المؤسسة التطبيق وتمنحه الإذن بالوصول إلى بيانات جميع المستخدمين في المؤسسة.
• التطبيقات التابعة لجهات خارجية التي تم تطويرها للمستخدمين/العملاء الخارجيين (أي أنّ المطوّر والمستخدمين ينتمون إلى مؤسسات مختلفة) يضبط المطوِّر التطبيق، ولكن مؤسسة المستخدم هي التي تمنح الإذن باستخدام تطبيق تابع لجهة خارجية.

1. ضبط تطبيق لاستخدام واجهة برمجة التطبيقات

أكمِل الخطوات التالية لإعداد تطبيقك:

• تفعيل واجهة برمجة التطبيقات
• إنشاء عميل OAuth

تفعيل واجهة برمجة التطبيقات

لتفعيل واجهة برمجة تطبيقات لمشروعك، اتّبِع الخطوات التالية:

1. افتح [واجهة برمجة تطبيقات الاستوديو] في Google API Console.
2. اختَر مشروعًا أو أنشِئ مشروعًا جديدًا إذا طُلب منك ذلك.
3. انقر على تفعيل.
4. إذا طُلب منك ذلك، اقرأ بنود خدمة واجهة برمجة التطبيقات ووافِق عليها.

إنشاء عميل OAuth

الخطوات التالية لإنشاء عميل OAuth هي إرشادات عامة ويجب تعديلها لتلبية متطلبات تطبيقك.

ملاحظة مهمة: لا تُضِف نطاقات مركز البيانات إلى عميل OAuth. سيضيف مشرف Workspace النطاقات عند منح التطبيق الإذن بالوصول إلى البيانات.

1. انتقِل إلى إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth.
   1. اختَر داخلي، ثم انقر على إنشاء.
   2. املأ الحقول المطلوبة، ثم انقر على حفظ.
2. انتقِل إلى بيانات الاعتماد.
   1. انقر على إنشاء بيانات اعتماد.
   2. اختَر معرّف عميل OAuth.
   3. اختَر Application Type المناسب. (تطبيق الويب هو الأكثر شيوعًا).
   4. املأ الحقول المطلوبة، ثم انقر على إنشاء.
3. دوِّن معرّف العميل لأنّه يُستخدَم للسماح بالتطبيق.

2. تفويض التطبيق لمؤسسة

لا يمكن للتطبيقات التي تستخدم واجهة برمجة التطبيقات Data Studio إلا مصادقة مستخدمي Google Workspace ومنحهم الإذن بالوصول إلى البيانات، وذلك في حال سمحت مؤسسة المستخدم للتطبيق باستخدام تفويض على مستوى النطاق للتحكّم في إمكانية الوصول إلى واجهة برمجة التطبيقات.

اضبط التفويض على مستوى النطاق باستخدام معرّف العميل OAuth الخاص بالتطبيق والنطاقات التي يتطلبها التطبيق.

ملاحظة مهمة: يجب أن يكمل مشرف Workspace الخطوات التالية. سيحتاج المشرف إلى معرّف عميل OAuth الخاص بالتطبيق وقائمة بنطاقات OAuth التي يتطلّبها التطبيق.

1. سجِّل الدخول إلى "وحدة تحكّم المشرف في Google" وانتقِل إلى التفويض على مستوى النطاق.
2. في API clients، انقر على إضافة جديد.
3. أدخِل Client ID التطبيق لمنحه الإذن (أي التطبيق الذي يستخدم واجهة برمجة تطبيقات مركز البيانات).
4. أدخِل جميع نطاقات OAuth التي يتطلّبها التطبيق. يتم عادةً طلب النطاقات التالية عند استخدام واجهة برمجة تطبيقات مركز البيانات لإدارة مواد العرض:
   • https://www.googleapis.com/auth/datastudio
   • https://www.googleapis.com/auth/userinfo.profile
5. انقر على تفويض.

ملاحظة: إذا لم يكن تطبيقك بحاجة إلى إدارة مواد عرض "مركز البيانات"، ننصحك باستخدام النطاق https://www.googleapis.com/auth/datastudio.readonly الأكثر تقييدًا بدلاً من https://www.googleapis.com/auth/datastudio.

بعد منح الإذن للتطبيق، سيتم تلقائيًا منح الإذن لأي مستخدم في Workspace تابع للمؤسسة لاستخدام التطبيق مع واجهة برمجة تطبيقات Data Studio.

3- الحصول على رموز الدخول عبر OAuth 2.0 واستدعاء واجهة برمجة التطبيقات

بعد تطوير التطبيق ومنحه الإذن، سيصبح بإمكانك الوصول إلى واجهة برمجة التطبيقات الخاصة بمستخدمي Workspace. لمزيد من التفاصيل حول استخدام بروتوكول OAuth مع Google APIs، يُرجى الاطّلاع على استخدام بروتوكول OAuth 2.0 للدخول إلى Google APIs. يُرجى الرجوع إلى مرجع واجهة برمجة التطبيقات للاطّلاع على العمليات المتاحة.

تحديد المشاكل وحلّها

مربّع حوار OAuth غير متوفّر

إذا فوّضت المؤسسة التطبيق، لن يظهر مربع حوار OAuth لمستخدمي هذه المؤسسة عند تفويض التطبيق، إلا إذا طلب التطبيق تفويضًا لنطاقات إضافية من Google API لم يضبطها مشرف Workspace، وفي هذه الحالة سيظهر مربع حوار OAuth للمستخدمين.

الخطأ 400: invalid_scope

إذا تلقّى المستخدم رسالة Error 400: invalid_scope عند محاولة تفويض التطبيق، يعني ذلك أنّ مؤسسة المستخدم لم تفوّض التطبيق أو فوّضته بشكل غير صحيح. لحلّ المشكلة، على المستخدم أن يطلب من مؤسسته تفويض التطبيق.