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

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

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

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

قبل طرح تطبيقك، يجب أن توافق Google عليه.

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

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

في ما يلي الخطوات التي يجب اتّباعها لإنشاء تطبيق يستخدم 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

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

الخطوات التي يتّخذها المستخدم لتصدير بياناته

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

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

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

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

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