مقدمة: تطوير التطبيقات باستخدام واجهة برمجة التطبيقات Data Portability API

تتيح لك واجهة برمجة التطبيقات Data Portability API إمكانية إنشاء التطبيقات التي تطلب إذنًا من المستخدم لنقل نسخة من البيانات من خدمات Google إلى تطبيقك. وهذا يتيح إمكانية نقل البيانات ويسهل تبديل الخدمات.

إذا كنت تبحث عن معلومات حول كيفية مشاركة المستخدمين للبيانات، يمكنك الاطّلاع على مشاركة نسخة من بياناتك مع جهة خارجية.

المتطلبات الأساسية

قبل إصدار التطبيق، يجب الحصول على موافقة من Google.

يجب أيضًا التحقّق من توفُّر واجهة برمجة التطبيقات Data Portability API للمستخدمين في موقعك الجغرافي. للحصول على قائمة بالبلدان والمناطق التي تتوفر فيها الخدمة، يُرجى الاطّلاع على الأسئلة الشائعة في صفحة "مشاركة نسخة من بياناتك مع جهة خارجية".

سير عمل المطوِّر

هذه هي الخطوات التي تتبعها لإنشاء تطبيق يستخدم واجهة برمجة التطبيقات Data Portability API

1. يمكنك تنفيذ مسار موافقة OAuth للمستخدم. في هذا المثال، يتيح المستخدم الوصول إلى بيانات فيديو YouTube.

   1. ينقر المستخدم على استيراد فيديوهات YouTube ويسجّل الدخول إلى حسابه على Google.

   2. يُعيد التطبيق توجيه المستخدم إلى عنوان URL للموافقة على OAuth. لاحظ أن هذا المثال لعنوان URL مبسط ويفتقد بعض المعلمات:

      https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.googleapis.com/auth/dataportability.myactivity.youtube

   3. ينقر المستخدم على التالي في شاشة موافقة OAuth، ويوافق على مشاركة بياناته، ويمنحه إمكانية الوصول إلى الحساب.

   4. تتم إعادة توجيه المستخدم إلى التطبيق.

   5. يحصل المطوّر على رمز OAuth مميز للمستخدم.

2. يطلب تطبيقك InitiatePortabilityArchive(resources = ["myactivity.youtube"]) مع إرفاق رمز OAuth مميز يحتوي على نطاق OAuth هذا:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   تبدأ هذه المكالمة عملية إنشاء أرشيف البيانات. ينبغي لك بدء أرشيف قابلية التنقل في غضون 24 ساعة من تفويض المستخدم.

3. يستدعي تطبيقك GetPortabilityArchiveState(job_id) مع رمز OAuth مميز مرفق يحتوي على نطاق OAuth هذا:

   https://www.googleapis.com/auth/dataportability.myactivity.youtube

   يمكنك استدعاء هذه الطريقة عدة مرات لاسترداد حالة مهمة الأرشفة. تُرجع الطريقة حالة الوظيفة. إذا كانت الحالة مكتملة، يكون الأرشيف جاهزًا، ويتم تقديم عناوين URL الموقّعة على Cloud Storage. لاحظ أن الوقت الذي يستغرقه إكمال طلب الأرشفة يمكن أن يختلف من دقائق إلى ساعات بناءً على حجم البيانات.

4. نزِّل أرشيف البيانات باستخدام عناوين URL الموقَّعة.

5. يمكنك الاتصال بـ ResetAuthorization() مع إرفاق رمز OAuth مميز لإعادة ضبط الموارد المستنفدة وإزالة جميع موافقات OAuth.

لمزيد من المعلومات عن استخدام طرق واجهة برمجة تطبيقات Data Portability API، يُرجى الاطّلاع على المقالة طرق واجهة برمجة تطبيقات إمكانية نقل بيانات المكالمات.

كيفية تفاعل المستخدمين مع تطبيق Data Portability API

يوضح هذا المخطّط البياني كيفية تفاعل المستخدمين مع تطبيق مُدمَج مع Data Portability API.

1. أولاً، يظهر للمستخدم خيار لاسترداد بياناته.

2. بعد ذلك، يسجِّل المستخدم الدخول إلى حسابه على Google.

3. بعد ذلك، ينقر المستخدم على التالي عندما يُطلب منه مشاركة بياناته، وينقر على حسنًا عندما يُطلب منه قبول سياسة الخصوصية.

4. بعد ذلك، يظهر للمستخدم شاشة طلب موافقة OAuth يتم استخدامها للسماح للتطبيق بالوصول إلى بياناته. تطابق الخيارات هنا نطاقات OAuth التي قمت بتكوينها.

5. بعد السماح بالوصول، يبدأ استيراد البيانات. اعتمادًا على حجم البيانات، يمكن أن يستغرق الطلب عدة دقائق إلى عدة ساعات حتى يكتمل.