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

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

ما ستتعرّف عليه

في هذا الدليل السريع، ستستخدم نصًا برمجيًا بلغة Python لإجراء ما يلي:

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

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

لتنفيذ هذه الخطوات السريعة، عليك تنفيذ ما يلي:

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

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

إعداد OAuth

  • اتّبِع الخطوات لضبط بروتوكول OAuth ل التطبيقات المثبَّتة. يشبه هذا المسار مسار OAuth لـ تطبيقات خادم الويب. عند ضبط معرِّف عميل OAuth:
    • يجب أن يكون نوع التطبيق هو تطبيق متوافق مع الكمبيوتر المكتبي.
    • بعد إنشاء معرِّف العميل، نزِّل سر العميل بتنسيق JSON ، وامنح الملف الاسم: client_secrets.json.
    • عند ضبط النطاقات لواجهة برمجة التطبيقات Data Portability API، يُرجى العِلم أنّه يستخدم دليل البدء السريع هذا مجموعات الموارد التالية:

إعداد لغة Python

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

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

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

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

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

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

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

نص برمجي لبدء استخدام Data Portability API في Python

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

python3 data-portability-quickstart.py

لاستخدام نطاقات مختلفة، حدِّدها باستخدام --resources، على سبيل المثال:

python3 data-portability-quickstart.py --resources myactivity.shopping myactivity.play

لتطبيق فلترة الوقت، استخدِم النص البرمجي نفسه مع علامتَي start_time وend_time. على سبيل المثال:

python3 data-portability-quickstart.py --start_time 2023-01-01T12:00:00Z --end_time 2024-01-01T12:00:00Z

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