تهيئة دمج واجهة مستخدم Drive

لعرض تطبيقك في Google Drive عند إنشاء المستخدم لملف أو فتحه، يجب أولاً إعداد تكامل واجهة مستخدم Drive. يجب أيضًا ضبط الإعدادات لإدراج تطبيقك في Google Workspace Marketplace.

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

قبل استخدام Google APIs، عليك تفعيلها في مشروع على Google Cloud. يمكنك تشغيل واجهة برمجة تطبيقات واحدة أو أكثر في مشروع Google Cloud واحد.

لبدء الدمج مع واجهة مستخدم Google Drive، يجب تمكين واجهة برمجة تطبيقات Drive. ويتيح لك هذا إمكانية الدخول إلى واجهة برمجة التطبيقات وميزات تكامل واجهة المستخدم.

• في Google Cloud Console، فعِّل Google Drive API.

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

إعداد دمج واجهة مستخدم Drive

1. في وحدة تحكُّم Google API، انتقِل إلى القائمة menu > واجهات برمجة التطبيقات والخدمات > تفعيل واجهات برمجة التطبيقات والخدمات.

   الانتقال إلى واجهات برمجة التطبيقات والخدمات التي تم تفعيلها

2. في أسفل لوحة بيانات واجهات برمجة التطبيقات والخدمات، انقر على واجهة برمجة تطبيقات Google Drive. تظهر صفحة تهيئة واجهة برمجة تطبيقات Google Drive.
3. اختَر علامة التبويب دمج واجهة مستخدم Drive.
4. (اختياري) أدخل اسمًا في الحقل اسم التطبيق. يتم عرض اسم التطبيق للمستخدمين في علامة التبويب "إدارة التطبيقات" ضمن إعدادات Drive.
5. (اختياري) أدخل وصفًا قصيرًا من سطر واحد في حقل الوصف القصير. يتم عرض الوصف المختصر للمستخدمين في علامة التبويب "إدارة التطبيقات" ضمن إعدادات Drive.
6. (اختياري) أدخل وصفًا كاملاً في الحقل وصف مفصل.

7. حمِّل رمز تطبيق واحدًا أو أكثر لعرضه في قائمة مستخدم لتطبيقات Drive المرتبطة وفي قائمة السياقات "فتح باستخدام". يجب أن تكون الرموز بتنسيق PNG بخلفية شفافة. قد يستغرق ظهور الرموز في Drive ما يصل إلى 24 ساعة.

8. لاستخدام عنصر القائمة "فتح باستخدام" في واجهة مستخدم Drive، أدخل عنوان URL لتطبيقك في الحقل فتح عنوان URL. يتم استخدام عنوان URL هذا من خلال قائمة سياقات "فتح باستخدام".

   • يجب أن يحتوي عنوان URL هذا على اسم نطاق مؤهل تمامًا، لأن العنوان localhost لا يعمل.
   • يجب إثبات ملكية عنوان URL هذا قبل أن تتمكن من إدراج تطبيقك في Google Workspace Marketplace.
   • بشكل تلقائي، يتم إلحاق معلّمة طلب بحث state بعنوان URL هذا لتمرير البيانات من واجهة مستخدم Drive إلى تطبيقك. وللحصول على معلومات عن محتوى المعلمة state، يمكنك الاطّلاع على المعلمة state.

9. (اختياري) أدخل أنواع MIME الافتراضية وامتدادات الملفات في الحقلين أنواع MIME الافتراضية وامتدادات الملفات الافتراضية. تمثل أنواع MIME الافتراضية وامتدادات الملفات الملفات التي تم تصميم تطبيقك بشكل فريد لفتحها. على سبيل المثال، قد يفتح التطبيق تنسيقًا مدمجًا لوضع الصور وتعديلها. لا تدرج سوى أنواع الوسائط العادية وتأكد من خلوها من الأخطاء الإملائية والأخطاء الإملائية. إذا كان تطبيقك لا يفتح سوى الاختصارات أو ملفات الاختصارات التابعة لجهات خارجية، يمكنك ترك نوع MIME فارغًا.

10. (اختياري) أدخِل أنواع MIME الثانوية وامتدادات الملفات في حقلي أنواع MIME الثانوية وامتدادات الملفات الثانوية. تمثل أنواع MIME الثانوية وامتدادات الملفات الملفات التي يمكن أن يفتحها تطبيقك، ولكنها ليست خاصة بتطبيقك. على سبيل المثال، قد يكون تطبيقك تطبيقًا لتعديل الصور يفتح صور PNG وJPG. لا تدرج سوى أنواع الوسائط العادية وتأكد من خلوها من الأخطاء الإملائية والأخطاء الإملائية. إذا كان تطبيقك لا يفتح سوى الاختصارات أو ملفات الاختصارات التابعة لجهات خارجية، يمكنك ترك نوع MIME فارغًا.

11. لاستخدام الزر واجهة مستخدم "جديد" في Drive واجعل المستخدمين ينشئون ملفًا باستخدام تطبيقك، حدد المربع إنشاء ملفات. يظهر الحقلان عنوان URL جديد وحقل اسم المستند الاختياري.

    • يجب أن يحتوي عنوان URL هذا على اسم نطاق مؤهل تمامًا، لأن العنوان localhost لا يعمل.
    • يجب إثبات ملكية عنوان URL هذا قبل أن تتمكن من إدراج تطبيقك في Google Workspace Marketplace.
    • بشكل تلقائي، يتم إلحاق معلّمة طلب بحث state بعنوان URL هذا لتمرير البيانات من واجهة مستخدم Drive إلى تطبيقك. وللحصول على معلومات عن محتوى المعلمة state، يمكنك الاطّلاع على المعلمة state.

12. أدخل عنوان URL في الحقل عنوان URL جديد. يتم استخدام عنوان URL هذا من خلال الزر "جديد" لإعادة توجيه المستخدم إلى تطبيقك.

13. (اختياري) إذا كنت تريد أن يفتح تطبيقك الملفات المتوافقة مع Google Workspace، ضَع علامة في المربّع استيراد.

14. (اختياري) في حال كان على تطبيقك إدارة الملفات في مساحات التخزين السحابي المشتركة، ضع علامة في المربّع دعم مساحات التخزين السحابي المشتركة. لمزيد من المعلومات عن كيفية دعم مساحات Drive المشتركة في تطبيقك، يُرجى الاطِّلاع على تنفيذ دعم مساحات Drive المشتركة.

15. انقر على إرسال.

طلب نطاق drive.install

للسماح للتطبيقات بالظهور كخيار في القائمة "فتح باستخدام" أو القائمة "جديد"، اطلب نطاق https://www.googleapis.com/auth/drive.install للدمج مع واجهة مستخدم Drive. عند طلب هذا النطاق، يتلقى المستخدمون مربع حوار يشبه ما يلي:

لمزيد من المعلومات حول النطاقات التي يمكنك طلبها لتطبيقات Drive، وكيفية طلبها، راجع معلومات المصادقة والمصادقة المتعلقة بواجهة برمجة التطبيقات.

المعلَمة state

تلقائيًا، يتم إلحاق معلّمة state بكلٍّ من عنوان URL المفتوح وعنوان URL الجديد لتمرير البيانات من واجهة مستخدم Drive إلى تطبيقك. تحتوي هذه المعلّمة على سلسلة بترميز JSON مع متغيرات النموذج وبيانات حول الطلب إلى تطبيقك. تعتمد المتغيرات المضمّنة على نوع عنوان URL المستخدَم (عنوان URL المفتوح أو عنوان URL الجديد):

متغير النموذج	الوصف	تطبيق عنوان URL
{ids}	يتم فتح قائمة مفصولة بفواصل من معرّفات الملفات.	فتح عنوان URL
{exportIds}	قائمة مفصولة بفواصل من معرّفات الملفات التي يتم تصديرها (تُستخدم فقط عند فتح مستندات Google المضمّنة).	فتح عنوان URL
{resourceKeys}	قاموس JSON لمعرّفات الملفات التي تم ربطها بمفاتيح الموارد الخاصة بها.	فتح عنوان URL
{folderId}	رقم تعريف المجلد الرئيسي.	عنوان URL جديد
{folderResourceKey}	مفتاح المورد للمجلد الرئيسي.	عنوان URL جديد
{userId}	معرّف الملف الشخصي الذي يعرّف المستخدم.	فتح عنوان URL وعنوان URL جديد
{action}	الإجراء الذي يتم تنفيذه. تكون القيمة open عند استخدام عنوان URL مفتوح أو create عند استخدام عنوان URL جديد.	فتح عنوان URL وعنوان URL جديد

المعلمة state بترميز URL، لذلك يجب أن يتعامل تطبيقك مع أحرف الإلغاء ويحللها كملف JSON. يمكن للتطبيقات اكتشاف القيمة create في المعلمة state للتحقق من طلب إنشاء ملف.

مثال على معلومات الحالة بتنسيق JSON لعنوان URL جديد

معلومات state الخاصة بعنوان URL الجديد هي:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

مثال على معلومات الحالة بتنسيق JSON لعنوان URL مفتوح

معلومات state الخاصة بعنوان URL المفتوح هي:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

يتم استخدام أرقام التعريف ومفاتيح الموارد لجلب البيانات الوصفية للملف وتنزيل محتوى الملف. بعد حصول تطبيقك على معرّف الملف ورمز الدخول، يمكنه التحقّق من الأذونات وجلب البيانات الوصفية للملف وتنزيل محتوى الملف على النحو الموضّح في طريقة files.get.

مواضيع ذات صلة

يجب أن يكون التطبيق المثبّت قادرًا على إنشاء الإجراءات التي يتم تشغيلها من واجهة مستخدم Drive وإدارتها وفتحها. للتعرُّف على المزيد من المعلومات، يُرجى الاطِّلاع على الزر "جديد " على"واجهة مستخدم Drive" أو الدمج مع قائمة السياقات "فتح باستخدام" في واجهة مستخدم Drive.