Bạn nên sử dụng thư viện ứng dụng với Apache Maven (hoặc Gradle).
Tạo một dự án Maven/Gradle mới
Tạo một dự án Maven/Gradle mới trong IDE mà bạn chọn. Các cấu phần phần mềm của chúng tôi được xuất bản lên kho lưu trữ trung tâm Maven.
Phần phụ thuộc Maven là:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>38.0.0</version>
</dependency>
Phần phụ thuộc Gradle là:
implementation 'com.google.api-ads:google-ads:38.0.0'
Bạn cũng có thể xây dựng từ nguồn. Để phục vụ mục đích của hướng dẫn này, giả sử bạn đã thiết lập một dự án có các phần phụ thuộc bắt buộc.
Nếu bạn đang tạo từ nguồn, hãy đảm bảo rằng bạn bật tính năng xử lý chú thích trong IDE.
Lấy thông tin đăng nhập để xác thực bằng API
Để truy cập vào API Google Ads, bạn cần có thông tin đăng nhập OAuth và mã thông báo nhà phát triển API Google Ads. Phần này giải thích định nghĩa, cách sử dụng và cách lấy các giá trị này.
Mã của nhà phát triển (để truy cập vào API)
Mã thông báo của nhà phát triển được liên kết với một tài khoản người quản lý và có thể tìm thấy trong giao diện web của Google Ads.
Mặc dù mã thông báo của nhà phát triển được liên kết với một tài khoản người quản lý, nhưng mã thông báo này không cấp quyền truy cập vào tài khoản đó. Thay vào đó, mã thông báo của nhà phát triển cấp quyền truy cập vào API nói chung và quyền truy cập cấp tài khoản được định cấu hình thông qua OAuth.
Thông tin đăng nhập OAuth (để truy cập vào tài khoản Google Ads)
Để uỷ quyền với tư cách là người dùng Tài khoản Google có quyền truy cập vào tài khoản Google Ads, bạn phải cung cấp một bộ thông tin đăng nhập OAuth.
Có 2 quy trình OAuth thường được dùng: ứng dụng dành cho máy tính (đã cài đặt) hoặc ứng dụng web. Điểm khác biệt chính giữa hai quy trình này là ứng dụng dành cho máy tính phải mở trình duyệt hệ thống và cung cấp URI chuyển hướng cục bộ để xử lý các phản hồi từ máy chủ uỷ quyền của Google, trong khi ứng dụng web có thể chuyển hướng một trình duyệt tuỳ ý của bên thứ ba để hoàn tất quá trình uỷ quyền và gửi thông tin đăng nhập trở lại máy chủ của bạn. Thư viện này cũng hỗ trợ quy trình tài khoản dịch vụ ít được sử dụng hơn.
- Nếu bạn uỷ quyền bằng thông tin đăng nhập của riêng mình (quy trình ứng dụng dành cho máy tính)
- Tham khảo quy trình ứng dụng OAuth dành cho máy tính. Thông tin này bao gồm tất cả thông tin chi tiết bạn cần để uỷ quyền bằng thông tin xác thực của riêng bạn.
- Nếu bạn uỷ quyền với tư cách là người dùng Google bên thứ ba (quy trình trên web)
- Tham khảo quy trình ứng dụng web OAuth. Ví dụ này minh hoạ cách thiết lập uỷ quyền OAuth cho người dùng bên thứ ba tuỳ ý.
- Nếu bạn uỷ quyền với tư cách là người dùng miền Google Apps (quy trình tài khoản dịch vụ)
- Tham khảo quy trình tài khoản dịch vụ OAuth. Ví dụ này minh hoạ cách thiết lập uỷ quyền OAuth cho người dùng trong miền của Google Apps.
Nếu truy cập vào tài khoản khách hàng Google Ads thông qua tài khoản người quản lý Google Ads, bạn cũng phải chỉ định mã khách hàng đăng nhập như mô tả bên dưới.
Mã khách hàng đăng nhập (để truy cập vào tài khoản Google Ads thông qua tài khoản người quản lý)
Bạn có thể chỉ định mã khách hàng của một tài khoản người quản lý cấp quyền truy cập vào tài khoản phân phát. Bạn phải chỉ định thông tin này nếu truy cập vào tài khoản khách hàng thông qua tài khoản người quản lý. Bạn không cần chỉ định tất cả tài khoản người quản lý trên đường dẫn đến mã khách hàng, mà chỉ cần mã người quản lý trên cùng mà bạn đang sử dụng cho quyền truy cập. Để biết thêm thông tin chi tiết, hãy xem tài liệu liên quan.
Định cấu hình thư viện ứng dụng bằng thông tin đăng nhập của bạn
Bạn có thể định cấu hình thư viện ứng dụng bằng tệp cấu hình, biến môi trường hoặc theo phương thức lập trình. Trong hướng dẫn này, chúng ta sẽ sử dụng phương pháp tệp cấu hình và tập trung vào các luồng trên máy tính cũng như trên web. Việc sử dụng tệp cấu hình thường là một phương pháp hay nếu bạn chỉ có một bộ thông tin đăng nhập (ví dụ: bạn quản lý các tài khoản trong một người quản lý duy nhất).
Tạo tệp ~/ads.properties
có nội dung sau:
api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
Thay thế phần giữ chỗ bằng thông tin đăng nhập mà bạn đã nhận được ở bước trước.
Ngoài ra, nếu mã làm mới của bạn là dành cho tài khoản người quản lý, bạn nên chỉ định mã khách hàng của tài khoản này làm khách hàng đăng nhập:
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE
Xác thực thông tin đăng nhập
Để đảm bảo rằng mọi thứ được thiết lập đúng cách, chúng ta sẽ chạy ví dụ GetCampaigns.
Trước tiên, hãy chuyển đến thư mục google-ads-examples
.
cd google-ads-examples
Ví dụ này yêu cầu một thông số --customerId
có giá trị là mã khách hàng tài khoản Google Ads của bạn mà không có dấu gạch ngang.
Cách chạy bằng Gradle:
./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Khám phá các ví dụ khác
Gói examples trong google-ads-examples
có một số ví dụ hữu ích. Hầu hết các ví dụ đều yêu cầu tham số. Bạn có thể truyền các tham số dưới dạng đối số (nên dùng) hoặc chỉnh sửa các giá trị INSERT_XXXXX_HERE
trong mã nguồn. Để xem câu lệnh sử dụng cho một ví dụ, hãy truyền --help
làm đối số duy nhất.
Với Gradle:
./gradlew -q runExample --example="basicoperations.GetCampaigns --help"
Bạn cũng có thể sử dụng tác vụ listExamples
trong Gradle để liệt kê tất cả các ví dụ, ví dụ trong một thư mục con hoặc ví dụ có nội dung mô tả bao gồm một cụm từ tìm kiếm.
# List all examples:
./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
./gradlew -q listExamples --searchTerm='Performance Max'