Tổng quan

Thư viện ứng dụng Python được lưu trữ trên GitHub và gói này có trên PyPI.

Yêu cầu

Thư viện này yêu cầu phiên bản Python 3.8 trở lên.

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

Trước khi cài đặt thư viện, bạn cần có mã của nhà phát triển và mã khách hàng của khách hàng. Hướng dẫn về cách lấy các tệp này được nêu trong phần các điều kiện tiên quyết. Xin lưu ý rằng bạn sẽ tạo các mã thông báo OAuth2 bắt buộc khác trong các bước sau.

Khả năng tương thích của thời gian chạy và phần phụ thuộc

Thư viện ứng dụng Python duy trì khả năng tương thích với môi trường thời gian chạy Python trong thời gian Các phiên bản được hỗ trợ do trang web Python Software Foundation, ngoại trừ các phiên bản có trạng thái "tính năng" hoặc "tiền phát hành".

Khi sử dụng các phiên bản mới của môi trường thời gian chạy Python, chúng tôi dự định phát hành phiên bản mới của thư viện ứng dụng Python tương thích với môi trường thời gian chạy mới nhất vào cuối quý sau khi phát hành. Ví dụ: nếu một môi trường thời gian chạy mới được phát hành vào tháng 10, thì phiên bản tương thích của thư viện ứng dụng Python sẽ có sẵn vào cuối tháng 3 năm sau.

Chúng tôi không hỗ trợ các môi trường thời gian chạy Python đã hết hạn sử dụng (EOL) sau ngày hết hạn sử dụng trong mục Phiên bản không được hỗ trợ trên python.org.

Chúng tôi có thể phát hành một phiên bản thư viện ứng dụng Python không tương thích với các môi trường thời gian chạy Python không được hỗ trợ bất cứ lúc nào sau khi các phiên bản đó đạt đến EOL.

Đối với các phần phụ thuộc, (cụ thể là các gói do Google duy trì liệt kê theo yêu cầu bởi thư viện ứng dụng Python), chúng tôi sẽ duy trì khả năng tương thích với các gói do Google duy trì và được coi là "được hỗ trợ" theo Chính sách về thay đổi có thể gây lỗi của OSS.

Để xem danh sách đầy đủ các môi trường thời gian chạy và phần phụ thuộc được hỗ trợ của Python, hãy xem Trang Phần phụ thuộc.

Cài đặt

Hãy làm theo hướng dẫn trong phần cài đặt của chúng tôi để cài đặt thư viện từ PyPi và quay lại trang này.

Cấu hình

Sau khi cài đặt thư viện, bạn cần thiết lập cấu hình cho thư viện đó. Có nhiều cách để định cấu hình thư viện, như được mô tả trong cấu hình.

Xác thực

Sau khi chọn một loại cấu hình, bạn có thể tiếp tục tạo các mã thông báo OAuth2 còn lại cần thiết để gửi yêu cầu đến API. Có nhiều các luồng OAuth2 được hỗ trợ, được ghi lại trong danh sách bên dưới. Để biết thông tin chi tiết về sự khác biệt giữa các luồng và giúp quyết định xem luồng nào là tốt nhất cho hãy xem tài liệu về OAuth.

Tạo yêu cầu API

Sau khi tích hợp mã thông báo OAuth2 vào cấu hình của mình, bạn để đưa ra yêu cầu API. Hãy tham khảo ví dụ về lấy chiến dịch để biết một cách đơn giản để kiểm thử xem thư viện có được định cấu hình đúng cách để tạo các yêu cầu API hay không.

Để chạy mẫu get_campaigns.py, trong thư mục gốc của thư viện ứng dụng googleads-python được cài đặt cục bộ, hãy chạy lệnh sau:

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

Tài nguyên khác

Sau khi bạn có thể tạo yêu cầu API, hãy tiếp tục sử dụng thư viện ứng dụng theo các cách sau: