Cấu trúc API

Hướng dẫn này giới thiệu các thành phần chính tạo nên Google Ads API. Google Ads API bao gồm tài nguyên và dịch vụ. Tài nguyên đại diện cho một thực thể Google Ads, trong khi các dịch vụ truy xuất và thao tác với các thực thể Google Ads.

Hệ phân cấp đối tượng

Bạn có thể xem tài khoản Google Ads như một hệ phân cấp các đối tượng.

Mô hình chiến dịch

  • Tài nguyên cấp cao nhất của một tài khoản là khách hàng.

  • Mỗi khách hàng chứa một hoặc nhiều chiến dịch đang hoạt động.

  • Mỗi chiến dịch chứa một hoặc nhiều nhóm quảng cáo, được dùng để nhóm quảng cáo thành các bộ sưu tập hợp lý.

  • Quảng cáo của nhóm quảng cáo là quảng cáo mà bạn đang chạy trong một nhóm quảng cáo. Ngoại trừ chiến dịch Quảng cáo ứng dụng (chỉ có thể có một quảng cáo nhóm quảng cáo cho mỗi nhóm quảng cáo), mỗi nhóm quảng cáo đều chứa một hoặc nhiều quảng cáo nhóm quảng cáo.

Chiến dịch Tối đa hoá hiệu suất sử dụng một cấu trúc khác so với các loại chiến dịch khác: thay vì nhóm quảng cáo và quảng cáo nhóm quảng cáo, chiến dịch Tối đa hoá hiệu suất chứa nhóm thành phần. Bạn liên kết các thành phần mẫu quảng cáo với một nhóm thành phần bằng cách sử dụng AssetGroupAsset và đính kèm tín hiệu về đối tượng hoặc chủ đề tìm kiếm bằng cách sử dụng AssetGroupSignal.

Bạn có thể đính kèm một hoặc nhiều tài nguyên AdGroupCriterion hoặc CampaignCriterion vào một nhóm quảng cáo hoặc chiến dịch. Đây là những tiêu chí xác định cách quảng cáo được kích hoạt.

Có nhiều loại tiêu chí, chẳng hạn như từ khoá, độ tuổi và vị trí. Tiêu chí được xác định ở cấp chiến dịch sẽ ảnh hưởng đến tất cả các tài nguyên khác trong chiến dịch. Bạn cũng có thể chỉ định ngân sách, cũng như ngày và giờ bắt đầu và kết thúc cho chiến dịch hoặc cho từng quảng cáo bằng cách sử dụng AdGroupAd.start_date_time và AdGroupAd.end_date_time.

Cuối cùng, bạn có thể đính kèm thành phần ở cấp tài khoản, chiến dịch, nhóm quảng cáo hoặc nhóm thành phần. Thành phần giúp bạn cung cấp thêm thông tin cho quảng cáo, chẳng hạn như số điện thoại, địa chỉ đường phố hoặc chương trình khuyến mãi. Xem Tổng quan về thành phần.

Tài nguyên

Tài nguyên đại diện cho các thực thể trong tài khoản Google Ads của bạn. Campaign và AdGroup là hai ví dụ về tài nguyên.

Mã đối tượng

Mỗi đối tượng trong Google Ads đều được xác định bằng mã nhận dạng riêng. Một số mã nhận dạng này là duy nhất trên toàn cầu đối với tất cả tài khoản Google Ads, trong khi những mã nhận dạng khác chỉ duy nhất trong một phạm vi giới hạn.

Mã đối tượng Phạm vi của tính duy nhất Có phải là duy nhất trên toàn cầu không?
ID ngân sách Toàn cầu Có
Mã chiến dịch Toàn cầu Có
ID Nhóm Quảng cáo Toàn cầu Có
Mã quảng cáo Nhóm quảng cáo Không, nhưng cặp (AdGroupId, AdId) là duy nhất trên toàn cầu. Bạn không được phép chia sẻ một AdId trên nhiều nhóm quảng cáo.
Mã AdGroupCriterion Nhóm quảng cáo Không, nhưng cặp (AdGroupId, CriterionId) là duy nhất trên toàn cầu
Mã CampaignCriterion Chiến dịch Không, nhưng cặp (CampaignId, CriterionId) là duy nhất trên toàn cầu
ID nhãn Khách hàng Không, nhưng cặp (CustomerId, LabelId) là duy nhất trên toàn cầu
Mã nhận dạng UserList Toàn cầu Có
Mã tài sản Toàn cầu Có

Các quy tắc về mã nhận dạng này có thể hữu ích khi bạn thiết kế bộ nhớ cục bộ cho các đối tượng Google Ads.

Một số đối tượng có thể được dùng cho nhiều loại thực thể. Trong những trường hợp như vậy, đối tượng sẽ chứa một trường type mô tả nội dung của đối tượng. Ví dụ: AdGroupAd có thể đề cập đến một đối tượng như quảng cáo tìm kiếm thích ứng, quảng cáo khách sạn hoặc quảng cáo Tạo nhu cầu. Bạn có thể truy cập vào giá trị này thông qua trường AdGroupAd.ad.type và trả về một giá trị trong enum AdType. Xin lưu ý rằng khả năng thay đổi có thể khác nhau tuỳ theo phiên bản (ví dụ: VideoResponsiveAdInfo trên Ad có thể thay đổi trong phiên bản 24 trở lên).

Tên tài nguyên

Mỗi tài nguyên được xác định riêng biệt bằng một chuỗi resource_name nối tài nguyên và các tài nguyên mẹ của tài nguyên đó thành một đường dẫn. Ví dụ: tên tài nguyên chiến dịch có dạng:

customers/customer_id/campaigns/campaign_id

Vì vậy, đối với chiến dịch có mã 987654 trong tài khoản Google Ads có mã khách hàng 1234567, resource_name sẽ là:

customers/1234567/campaigns/987654

Dịch vụ

Các dịch vụ cho phép bạn truy xuất và sửa đổi các thực thể Google Ads. Có 3 loại dịch vụ: dịch vụ sửa đổi, dịch vụ truy xuất đối tượng và số liệu thống kê, và dịch vụ truy xuất siêu dữ liệu.

Sửa đổi (đột biến) đối tượng

Các dịch vụ dành riêng cho tài nguyên sẽ sửa đổi các thực thể của một loại tài nguyên được liên kết bằng cách sử dụng yêu cầu mutate. Bạn cũng có thể sử dụng GoogleAdsService.Mutate để thực hiện các đột biến nguyên tử trên nhiều loại tài nguyên trong một yêu cầu duy nhất (chẳng hạn như tạo ngân sách chiến dịch, chiến dịch và nhóm quảng cáo cùng nhau).

Ví dụ về các dịch vụ dành riêng cho tài nguyên:

Mỗi yêu cầu mutate phải bao gồm các đối tượng operation tương ứng. Ví dụ: phương thức CampaignService.MutateCampaigns yêu cầu một hoặc nhiều phiên bản của CampaignOperation. Hãy xem phần Đối tượng thay đổi để biết nội dung thảo luận chi tiết về các thao tác.

Đột biến đồng thời

Không được phép sửa đổi một đối tượng Google Ads đồng thời bằng nhiều nguồn. Điều này có thể gây ra lỗi nếu bạn có nhiều người dùng cập nhật cùng một đối tượng bằng ứng dụng của bạn, hoặc nếu bạn đang biến đổi các đối tượng Google Ads song song bằng nhiều luồng. Điều này bao gồm việc cập nhật đối tượng từ nhiều luồng trong cùng một ứng dụng hoặc từ các ứng dụng khác nhau (ví dụ: ứng dụng của bạn và một phiên giao diện người dùng Google Ads đồng thời).

API không cung cấp cách khoá một đối tượng trước khi cập nhật; nếu hai nguồn cố gắng đồng thời thay đổi một đối tượng, API sẽ tạo ra một DatabaseError.CONCURRENT_MODIFICATION_ERROR.

Thao tác biến đổi không đồng bộ so với đồng bộ

Các phương thức biến đổi của Google Ads API có tính đồng bộ. Các lệnh gọi API chỉ trả về một phản hồi sau khi các đối tượng bị thay đổi, yêu cầu bạn phải đợi phản hồi cho từng yêu cầu. Mặc dù phương pháp này tương đối đơn giản để mã hoá, nhưng có thể ảnh hưởng tiêu cực đến việc cân bằng tải và lãng phí tài nguyên nếu các quy trình buộc phải đợi các lệnh gọi hoàn tất.

Một phương pháp thay thế là biến đổi các đối tượng không đồng bộ bằng cách sử dụng BatchJobService. Phương pháp này thực hiện các lô thao tác trên nhiều dịch vụ mà không cần chờ hoàn tất. Sau khi bạn gửi một lô công việc, các máy chủ Google Ads API sẽ thực thi các thao tác không đồng bộ, giải phóng các quy trình để thực hiện các thao tác khác. Bạn có thể định kỳ kiểm tra trạng thái của lệnh để biết lệnh đã hoàn tất hay chưa.

Hãy xem Hướng dẫn xử lý hàng loạt để biết thêm thông tin về quy trình xử lý không đồng bộ.

Xác thực thay đổi

Hầu hết các yêu cầu biến đổi đều có thể được xác thực mà không cần thực sự thực thi lệnh gọi đối với dữ liệu thực. Bạn có thể kiểm thử yêu cầu đối với các tham số bị thiếu và giá trị trường không chính xác mà không cần thực sự thực thi thao tác.

Để sử dụng tính năng này, hãy đặt trường boolean validate_only không bắt buộc của yêu cầu thành true. Yêu cầu được xác thực đầy đủ như thể sẽ được thực thi, nhưng quá trình thực thi cuối cùng sẽ bị bỏ qua. Nếu không tìm thấy lỗi, phản hồi sẽ được trả về mà không có kết quả nào được điền sẵn (results trống). Nếu quá trình xác thực không thành công, thì theo mặc định, yêu cầu sẽ không thành công với lỗi RPC GoogleAdsFailure (partial_failure = false) hoặc trả về một phản hồi bình thường với các lỗi dành riêng cho thao tác trong partial_failure_error khi partial_failure = true.

validate_only đặc biệt hữu ích trong việc kiểm thử quảng cáo để phát hiện các lỗi vi phạm chính sách thường gặp. Quảng cáo sẽ tự động bị từ chối nếu vi phạm các chính sách như có từ, dấu câu, cách viết hoa hoặc độ dài cụ thể. Một quảng cáo không hợp lệ có thể khiến toàn bộ lô không thành công. Việc kiểm thử một quảng cáo mới trong một yêu cầu validate_only có thể cho thấy mọi lỗi vi phạm như vậy. Hãy tham khảo ví dụ về mã để xử lý lỗi vi phạm chính sách để xem cách thực hiện.

Nhận các đối tượng và số liệu thống kê về hiệu suất

GoogleAdsService là dịch vụ duy nhất, hợp nhất để truy xuất các đối tượng và số liệu thống kê về hiệu suất.

Tất cả các yêu cầu Search và SearchStream cho GoogleAdsService đều yêu cầu một truy vấn chỉ định tài nguyên cần truy vấn, các thuộc tính tài nguyên và chỉ số hiệu suất cần truy xuất, các vị từ cần dùng để lọc yêu cầu và các phân đoạn cần dùng để chia nhỏ thêm số liệu thống kê về hiệu suất. Để biết thêm thông tin về định dạng truy vấn, hãy xem hướng dẫn về Ngôn ngữ truy vấn của Google Ads.

Truy xuất siêu dữ liệu

GoogleAdsFieldService truy xuất siêu dữ liệu về các tài nguyên trong Google Ads API, chẳng hạn như các thuộc tính có sẵn cho một tài nguyên và kiểu dữ liệu của tài nguyên đó. Hãy xem Hướng dẫn về siêu dữ liệu tài nguyên để biết thông tin chi tiết về cách truy vấn dịch vụ này.

Dịch vụ này cung cấp thông tin cần thiết để tạo một truy vấn đến GoogleAdsService. Để thuận tiện, thông tin do GoogleAdsFieldService trả về cũng có trong tài liệu tham khảo về các trường.