เรียกใช้ Data Portability API โดยใช้สคริปต์ Python

ในการเริ่มต้นใช้งานอย่างรวดเร็วนี้ คุณจะได้รับโทเค็น 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 ตัวเลือกนี้กำหนดให้แอปพลิเคชันต้องฟังพอร์ต localhost แล้วเปิดเบราว์เซอร์ของระบบเพื่อเริ่มขั้นตอนการให้สิทธิ์ OAuth

คลิกลิงก์นี้เพื่อเปิดสคริปต์ หรือดาวน์โหลดสคริปต์สำเนาโดยคลิกขวาที่ลิงก์

สคริปต์เริ่มต้นใช้งาน Data Portability API ของ Python

หากต้องการเรียกใช้สคริปต์และส่งออกชุดข้อมูลทั้งหมด ให้ป้อนคําสั่งนี้

python3 data-portability-quickstart.py

หากต้องการใช้ขอบเขตอื่น ให้ระบุขอบเขตโดยใช้ --resources เช่น

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

หากต้องการใช้การกรองเวลา ให้ใช้สคริปต์เดียวกันกับ Flag start_time และ end_time เช่น

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

การดำเนินการของสคริปต์จะแสดงอยู่ในความคิดเห็นอย่างละเอียด