Gọi API Khả năng di chuyển dữ liệu bằng tập lệnh Python

Trong hướng dẫn nhanh này, bạn sẽ lấy mã thông báo OAuth cho tài khoản của mình và gửi yêu cầu đến các điểm cuối của API Di chuyển dữ liệu bằng tập lệnh Python.

Kiến thức bạn sẽ học được

Trong hướng dẫn bắt đầu nhanh này, bạn sẽ sử dụng tập lệnh Python để:

  • Gửi yêu cầu đã xác thực đến điểm cuối InitiatePortabilityArchive bằng cách cung cấp mã thông báo OAuth hợp lệ. Phản hồi là một job_id hợp lệ.
  • Gửi yêu cầu đã xác thực đến điểm cuối GetPortabilityArchiveState và tải dữ liệu xuống. Phản hồi phải chứa trạng thái công việc hợp lệ và khi công việc hoàn tất, một URL đã ký.
  • Lưu trữ mã thông báo OAuth có quyền truy cập dựa trên thời gian để sử dụng lại sau này.
  • Gửi yêu cầu đã xác thực đến điểm cuối ResetAuthorization. Yêu cầu này sẽ thu hồi tất cả phạm vi OAuth do người dùng cấp.
  • Gửi yêu cầu đã xác thực đến điểm cuối InitiatePortabilityArchive bằng cách cung cấp mã thông báo OAuth hợp lệ cùng với start_time hoặc end_time để áp dụng bộ lọc thời gian cho yêu cầu của bạn.

Điều kiện tiên quyết

Để chạy hướng dẫn bắt đầu nhanh này, bạn cần:

  • Xác minh rằng bạn có thể sử dụng Data Portability API. Để biết danh sách các quốc gia và khu vực được hỗ trợ, hãy xem phần Câu hỏi thường gặp trên trang "Chia sẻ bản sao dữ liệu của bạn với bên thứ ba".
  • Hoàn tất các bước thiết lập cho API Di chuyển dữ liệu và xác minh rằng bạn đang sử dụng một dự án mới.
  • Có quyền truy cập vào tài khoản do tổ chức của bạn sở hữu hoặc kiểm soát. Dữ liệu hoạt động tìm kiếm của tài khoản này sẽ được xuất trong phần hướng dẫn nhanh này.

Trước khi bắt đầu hướng dẫn nhanh này, bạn cũng cần thiết lập OAuth, Python và gói OAuth cho thư viện ứng dụng Python.

Thiết lập OAuth

  • Làm theo các bước để định cấu hình OAuth cho các ứng dụng đã cài đặt. Quy trình này tương tự như quy trình OAuth cho ứng dụng máy chủ web. Khi bạn định cấu hình mã ứng dụng OAuth:
    • Loại ứng dụng phải là Ứng dụng dành cho máy tính.
    • Sau khi bạn tạo mã ứng dụng, hãy tải mã xác thực ứng dụng xuống ở định dạng JSON và đặt tên tệp là: client_secrets.json.
    • Khi bạn định cấu hình phạm vi cho Data Portability API, hãy lưu ý rằng hướng dẫn nhanh này sử dụng các nhóm tài nguyên sau:

Thiết lập Python

Bạn cần thiết lập Python trên máy cục bộ để chạy tập lệnh dùng trong hướng dẫn bắt đầu nhanh này. Cách thiết lập Python:

  • Cài đặt công cụ quản lý gói Pip và Python 3.11 (trở lên).
  • Cài đặt Thư viện ứng dụng API của Google cho Python.

  • Cài đặt gói google_auth_oauthlib cho thư viện ứng dụng Python bằng cách chạy lệnh này. Gói này cung cấp tính năng tích hợp oauthlib với google-auth – thư viện xác thực của Google cho Python.

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

Chạy tập lệnh

Tập lệnh này sử dụng lệnh chuyển hướng localhost trong quy trình OAuth. Tuỳ chọn này yêu cầu ứng dụng nghe trên cổng máy chủ cục bộ, sau đó mở trình duyệt hệ thống để bắt đầu quy trình uỷ quyền OAuth.

Nhấp vào đường liên kết này để mở tập lệnh hoặc tải bản sao tập lệnh xuống bằng cách nhấp chuột phải vào đường liên kết.

Tập lệnh bắt đầu nhanh bằng Python cho Data Portability API

Để chạy tập lệnh và xuất toàn bộ tập hợp dữ liệu, hãy nhập lệnh sau:

python3 data-portability-quickstart.py

Để sử dụng các phạm vi khác nhau, hãy chỉ định các phạm vi đó bằng --resources, ví dụ:

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

Để áp dụng tính năng lọc thời gian, hãy sử dụng cùng một tập lệnh với cờ start_time và end_time. Ví dụ:

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

Các hành động mà tập lệnh thực hiện được nêu chi tiết trong phần nhận xét.