Python स्क्रिप्ट का इस्तेमाल करके, Data Portability API को कॉल करना

इस क्विकस्टार्ट में, आपको अपने खाते के लिए OAuth टोकन मिलता है. साथ ही, Python स्क्रिप्ट का इस्तेमाल करके, Data Portability API के एंडपॉइंट को अनुरोध भेजे जाते हैं.

आपको ये सब सीखने को मिलेगा

इस क्विकस्टार्ट में, Python स्क्रिप्ट का इस्तेमाल करके:

  • मान्य OAuth टोकन देकर, InitiatePortabilityArchive एंडपॉइंट पर पुष्टि किया गया अनुरोध भेजें. रिस्पॉन्स, एक मान्य job_id है.
  • GetPortabilityArchiveState एंडपॉइंट पर पुष्टि किया गया अनुरोध भेजें और डेटा डाउनलोड करें. जवाब में, जॉब की मान्य स्थिति और जॉब पूरा होने पर, हस्ताक्षर किया गया यूआरएल होना चाहिए.
  • बाद में फिर से इस्तेमाल करने के लिए, समय के हिसाब से ऐक्सेस वाले OAuth टोकन को सेव करें.
  • ResetAuthorization एंडपॉइंट पर पुष्टि किया गया अनुरोध भेजें. इस अनुरोध से, उपयोगकर्ता से मिले सभी OAuth स्कोप रद्द हो जाते हैं.
  • अपने अनुरोध पर टाइम फ़िल्टर लागू करने के लिए, start_time या end_time के साथ मान्य OAuth टोकन देकर, InitiatePortabilityArchive एंडपॉइंट पर पुष्टि किया गया अनुरोध भेजें.

ज़रूरी शर्तें

यह क्विकस्टार्ट चलाने के लिए, आपको ये काम करने होंगे:

  • पुष्टि करें कि आपके लिए डेटा पोर्टेबिलिटी एपीआई उपलब्ध है. इस सुविधा के साथ काम करने वाले देशों और इलाकों की सूची के लिए, "तीसरे पक्ष के साथ अपने डेटा की कॉपी शेयर करना" पेज पर अक्सर पूछे जाने वाले सवाल देखें.
  • Data Portability API के लिए, सेटअप करने के तरीके को पूरा करें. साथ ही, पुष्टि करें कि आपने नए प्रोजेक्ट का इस्तेमाल किया है.
  • आपके संगठन के मालिकाना हक वाले या उसके कंट्रोल वाले खाते का ऐक्सेस पाना. इस खाते की खोज गतिविधि का डेटा, इस शुरुआती निर्देश में एक्सपोर्ट किया जाता है.

इस क्विकस्टार्ट गाइड को शुरू करने से पहले, आपको OAuth, Python, और Python क्लाइंट लाइब्रेरी के लिए OAuth पैकेज भी सेट अप करना होगा.

OAuth सेट अप करना

  • इंस्टॉल किए गए ऐप्लिकेशन के लिए OAuth को कॉन्फ़िगर करने के लिए, यह तरीका अपनाएं. यह फ़्लो, वेब सर्वर ऐप्लिकेशन के लिए OAuth फ़्लो से मिलता-जुलता है. OAuth क्लाइंट आईडी को कॉन्फ़िगर करने पर:
    • ऐप्लिकेशन का टाइप, डेस्कटॉप ऐप्लिकेशन होना चाहिए.
    • क्लाइंट आईडी बनाने के बाद, क्लाइंट पासकोड को JSON फ़ॉर्मैट में डाउनलोड करें और फ़ाइल को यह नाम दें: client_secrets.json.
    • Data Portability API के लिए स्कोप कॉन्फ़िगर करते समय, ध्यान रखें कि यह क्विकस्टार्ट इन रिसॉर्स ग्रुप का इस्तेमाल करता है:

Python सेट अप करना

इस क्विकस्टार्ट में इस्तेमाल की गई स्क्रिप्ट को चलाने के लिए, आपको अपनी लोकल मशीन पर Python सेट अप करना होगा. Python सेटअप करने के लिए:

  • Pip पैकेज मैनेजमेंट टूल और Python 3.11 (या इसके बाद का वर्शन) इंस्टॉल करें.
  • Python के लिए Google API क्लाइंट लाइब्रेरी इंस्टॉल करें.

  • इस कमांड को चलाकर, Python क्लाइंट लाइब्रेरी के लिए google_auth_oauthlib पैकेज इंस्टॉल करें. यह पैकेज, google-auth के साथ oauthlib इंटिग्रेशन उपलब्ध कराता है. google-auth, Python के लिए Google की पुष्टि करने वाली लाइब्रेरी है.

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

स्क्रिप्ट चलाना

यह स्क्रिप्ट, OAuth फ़्लो में localhost रीडायरेक्ट का इस्तेमाल करती है. इस विकल्प के लिए, ऐप्लिकेशन को किसी localhost पोर्ट पर सुनने की ज़रूरत होती है. इसके बाद, 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

स्क्रिप्ट की ओर से की गई कार्रवाइयों के बारे में टिप्पणियों में बताया गया है.