استدعاء واجهة برمجة تطبيقات إمكانية نقل البيانات باستخدام نص برمجي في بايثون

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

المعلومات التي تكتسبها

في دليل البدء السريع هذا، يمكنك استخدام نص Python برمجي من أجل:

• يمكنك إرسال طلب تمت المصادقة عليه إلى نقطة نهاية InitiatePortabilityArchive من خلال توفير رمز OAuth مميز صالح. يجب أن يكون الردّ job_id صالحًا.
• أرسل طلبًا تمت مصادقته إلى نقطة نهاية GetPortabilityArchiveState ونزِّل البيانات. يجب أن تحتوي الاستجابة على حالة مهمة صالحة، وعند اكتمال المهمة، عنوان URL موقَّع.
• إرسال طلب مصادق عليه إلى نقطة نهاية ResetAuthorization يؤدي هذا الطلب إلى إبطال جميع نطاقات OAuth التي يمنحها المستخدم.

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

لتشغيل هذه الأداة السريعة، عليك إجراء ما يلي:

• تأكَّد من توفُّر واجهة برمجة التطبيقات Data Portability API لك. للحصول على قائمة بالبلدان والمناطق التي تتوفر فيها الخدمة، يُرجى الاطّلاع على الأسئلة الشائعة في صفحة "مشاركة نسخة من بياناتك مع جهة خارجية".
• أكمِل خطوات الإعداد لواجهة برمجة تطبيقات Data Portability API، وتأكَّد من أنّك تستخدم مشروعًا جديدًا.
• الحصول على إمكانية الوصول إلى حساب تملكه مؤسستك أو تتحكّم به يتم تصدير بيانات نشاط البحث لهذا الحساب في عملية البدء السريع هذه.

قبل البدء سريعًا في هذه المرحلة الأولى، تحتاج أيضًا إلى إعداد OAuth وPython وحزمة OAuth لمكتبات عملاء Python.

إعداد OAuth

• اتّبِع الخطوات لإعداد بروتوكول OAuth للتطبيقات المثبَّتة. يشبه هذا المسار عملية OAuth في تطبيقات خادم الويب. عند ضبط معرّف عميل OAuth:
  • يجب أن يكون نوع التطبيق تطبيق سطح المكتب.
  • بعد إنشاء معرِّف العميل، يُرجى تنزيل سر العميل بتنسيق JSON وتسمية الملف: client_secrets.json.
  • عند ضبط النطاقات لواجهة برمجة التطبيقات Data Portability API، لاحِظ أنّ عملية البدء السريع هذه تستخدم مجموعات المراجع التالية:
    • myactivity.search: https://www.googleapis.com/auth/dataportability.myactivity.search
    • myactivity.youtube: https://www.googleapis.com/auth/dataportability.myactivity.youtube

إعداد Python

يتعين عليك إعداد Python على جهازك المحلي لتشغيل النص البرمجي المستخدم في هذه البدء السريع. لإعداد Python:

• ثبِّت أداة إدارة الحزم Pip وPython 3.9 (أو إصدار أحدث).
• ثبِّت مكتبة برامج Google API للغة Python.

• ثبِّت حزمة google_auth_oauthlib لمكتبة برامج Python من خلال تنفيذ هذا الأمر. توفر هذه الحزمة دمج oauthlib مع google-auth، وهي مكتبة مصادقة Google للغة بايثون.

  pip install google-auth-oauthlib google-api-python-client --upgrade
  

تشغيل النص البرمجي

يستخدم هذا النص البرمجي إعادة توجيه مضيف محلي في مسار OAuth. يتطلب هذا الخيار من التطبيق الاستماع إلى منفذ المضيف المحلي، ثم فتح متصفح النظام لبدء تدفق تفويض OAuth.

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

نص البدء السريع في Python لواجهة برمجة تطبيقات Data Portability API

ولتشغيل النص البرمجي، أدخِل الأمر التالي:

python3 data-portability-quickstart.py

تتضمّن التعليقات تفاصيل الإجراءات التي اتّخذها النص البرمجي.