Bạn nên 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 sẽ được phát hành 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>31.0.0</version>
</dependency>
Phần phụ thuộc Gradle là:
implementation 'com.google.api-ads:google-ads:31.0.0'
Bạn cũng có thể tạo từ nguồn. Vì mục đích của hướng dẫn này, giả định rằng bạn đã thiết lập dự án với các phần phụ thuộc bắt buộc có sẵn.
Lấy thông tin đăng nhập để xác thực với API
Để truy cập vào API Google Ads, bạn phải có thông tin đăng nhập OAuth và mã của 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 những thành phần này.
Mã của người phát triển (để truy cập vào API)
Mã 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ể được tìm thấy trên giao diện web của Google Ads.
Mặc dù mã của nhà phát triển được liên kết với tài khoản người quản lý, nhưng mã này không cấp quyền truy cập vào tài khoản đó. Thay vào đó, mã của nhà phát triển sẽ 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)
Để cho phép với tư cách là người dùng Tài khoản Google có quyền truy cập vào các tài khoản Google Ads, bạn phải cung cấp một bộ thông tin đăng nhập OAuth.
Có hai luồng 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 2 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 xác thực về 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 cho phép bằng thông tin đăng nhập của riêng mình (quy trình trong ứng dụng dành cho máy tính)
- Hãy tham khảo quy trình cho ứng dụng OAuth dành cho máy tính. Thông tin này bao gồm mọi 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 mình.
- Nếu bạn cho phép với tư cách là người dùng Google bên thứ ba (luồng web)
- Tham khảo quy trình ứng dụng web OAuth. Bài viết này sẽ đưa ra một ví dụ về cách thiết lập tính năng uỷ quyền OAuth cho người dùng bên thứ ba tuỳ ý.
- Nếu bạn cho phép với tư cách là người dùng Miền Google Apps (luồng tài khoản dịch vụ)
- Hãy tham khảo quy trình tài khoản dịch vụ OAuth. Ví dụ này cung cấp một ví dụ về cách thiết lập phương thức uỷ quyền OAuth cho người dùng Miền Google Apps.
Nếu bạn có quyền 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, thì 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ý)
Nếu muốn, hãy chỉ định mã khách hàng của 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 quảng cáo. Bạn phải chỉ định thuộc tính này nếu bạn 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 chỉ định mã người quản lý cấp cao nhất mà bạn đang 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 tôi sẽ sử dụng phương pháp tiếp cận tệp cấu hình và tập trung vào luồng máy tính và luồng web. Nhìn chung, bạn nên sử dụng tệp cấu hình nếu chỉ có một bộ thông tin đăng nhập (ví dụ: bạn quản lý các tài khoản bằng 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 xác thực của bạn có được ở bước trước.
Ngoài ra, nếu mã làm mới của bạn dành cho tài khoản người quản lý, thì 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 mọi thứ được thiết lập chính xác, chúng tôi sẽ chạy ví dụ về GetChiến dịch.
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 tham số --customerId, trong đó giá trị là
mã khách hàng của tài khoản Google Ads không có dấu gạch ngang.
Để chạy với Gradle:
$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"
Khám phá các ví dụ khác
Gói examples (Ví dụ) trong google-ads-examples chứa 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 giá trị INSERT_XXXXX_HERE trong mã nguồn. Để xem ví dụ về câu lệnh sử dụng, 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 thư mục con hoặc các ví dụ trong đó nội dung mô tả có chứa 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'