Cách sử dụng cơ bản của thư viện ứng dụng như sau:
Cài đặt
Bạn nên cài đặt thư viện bằng Bundler. Thêm một dòng vào Gemfile (thay thế x.y.z bằng số phiên bản bạn muốn sử dụng):
gem 'google-ads-googleads', '~> x.y.z'
Sau đó, hãy chạy:
bundle install
Lệnh này sử dụng Bundler để cập nhật Gemfile.lock, khoá phiên bản chính xác của gem và tất cả phần phụ thuộc của gem đã được cài đặt. Toán tử phiên bản bi quan "~> x.y.z" đảm bảo rằng bundle install hoặc bundle update chỉ cài đặt các phiên bản bản vá mới trong chuỗi x.y.*, vì vậy, bạn phải chọn các phiên bản nhỏ hoặc phiên bản lớn mới theo cách thủ công bằng cách cập nhật Gemfile.
Các lựa chọn cài đặt khác
Nếu không sử dụng Bundler, bạn có thể dùng một trong các lựa chọn sau:
Cài đặt thư viện này bằng RubyGems:
gem install google-ads-googleadsTải gem xuống từ trang Bản phát hành rồi cài đặt từ tệp cục bộ:
gem install google-ads-googleads-[version].gem
Thiết lập phương thức xác thực
Để xác thực các lệnh gọi API, hãy định cấu hình tệp google_ads_config.rb và làm theo hướng dẫn trên trang Xác thực và uỷ quyền.
Cách sử dụng
Kể từ phiên bản google-ads-googleads v41.1.0, gem hỗ trợ Bundler autorequire (Bundler.require). Trong các phiên bản trước v41.1.0 (hoặc khi không sử dụng Bundler.require), hãy yêu cầu rõ ràng gem trong mã của bạn:
require 'google/ads/google_ads'
Khởi chạy ứng dụng (tải cấu hình từ ~/google_ads_config.rb theo mặc định) và tìm nạp một dịch vụ cụ thể, chẳng hạn như CampaignService:
# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new
# Fetch the CampaignService client.
campaign_service = client.service.campaign
Hãy xem các ví dụ trên GitHub để biết thêm thông tin minh hoạ chi tiết về cách sử dụng thư viện.
Sau khi bạn đã quen với các ví dụ, hãy khám phá các factory, nơi cung cấp một tập hợp các phương thức tiện lợi cấp cao để làm việc với Google Ads API.
Xử lý lỗi
Không phải lệnh gọi API nào cũng thành công. Máy chủ sẽ đưa ra các ngoại lệ nếu lệnh gọi API của bạn không thành công. Bạn cần phải ghi lại các lỗi API và xử lý chúng một cách thích hợp.
Một thực thể Google::Ads::GoogleAds::Errors::GoogleAdsError sẽ được tạo khi xảy ra lỗi API. Hàm này chứa thông tin chi tiết giúp bạn xác định vấn đề và bạn có thể thiết lập một hàm trợ giúp để xử lý lỗi. Xem ví dụ về trình xử lý lỗi trên GitHub.