Cấu trúc API

Video: Xem phần nói chuyện về Dịch vụ và tài nguyên trong hội thảo năm 2019

Hướng dẫn này giới thiệu các thành phần chính tạo nên API Google Ads. API Google Ads bao gồm tài nguyêndịch vụ. Tài nguyên đại diện cho một thực thể Google Ads, còn 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 là 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 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, dùng để nhóm quảng cáo của bạn thành các tập hợp hợp lý.

  • Quảng cáo nhóm quảng cáo đại diện cho một quảng cáo mà bạn đang chạy. 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 chứa một hoặc nhiều quảng cáo nhóm quảng cáo.

Bạn có thể đính kèm một hoặc nhiều AdGroupCriterion hoặc CampaignCriterion vào một nhóm quảng cáo hoặc chiến dịch. Đây là các 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í. Các 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 và ngày trên toàn chiến dịch.

Cuối cùng, bạn có thể đính kèm phần mở rộng ở cấp tài khoản, chiến dịch hoặc nhóm quảng cáo. Phần mở rộng cho phé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.

Tài nguyên

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

Mã đối tượng

Mỗi đối tượng trong Google Ads đượ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 trên tất cả tài khoản Google Ads, trong khi một số 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 điểm độc đáo Duy nhất trên toàn cầu?
ID ngân sách Toàn cầu
Mã chiến dịch Toàn cầu
ID Nhóm Quảng cáo Toàn cầu
ID 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
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
Phần mở rộng quảng cáo Chiến dịch Không, nhưng cặp (CampaignId, AdExtensionId) là duy nhất trên toàn cầu
ID nguồn cấp dữ liệu Toàn cầu
Mã mặt hàng trong nguồn cấp dữ liệu Toàn cầu
Mã thuộc tính nguồn cấp dữ liệu Nguồn cấp dữ liệu Không
Mã ánh xạ nguồn cấp dữ liệu Toàn cầu
ID nhãn Toàn cầu
Mã danh sách người dùng Toàn cầu

Các quy tắc mã nhận dạng này có thể hữu ích khi 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ể tham chiếu đến một đối tượng như quảng cáo dạng văn bản, quảng cáo khách sạn hoặc quảng cáo địa phương. Bạn có thể truy cập giá trị này thông qua trường AdGroupAd.ad.type và trả về một giá trị trong enum AdType.

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, chuỗi này nối tài nguyên và tài nguyên mẹ thành một đường dẫn. Ví dụ: tên tài nguyên của chiến dịch có dạng:

customers/customer_id/campaigns/campaign_id

Vì vậy, đối với một 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ụ

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ụ: sửa đổi, truy xuất đối tượng và số liệu thống kê, cũng như dịch vụ truy xuất siêu dữ liệu.

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

Các dịch vụ này 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. Các lớp này cũng cung cấp một yêu cầu get để truy xuất một thực thể tài nguyên duy nhất. Điều này có thể hữu ích khi kiểm tra cấu trúc của một tài nguyên.

Ví dụ về dịch vụ:

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 thực thể của CampaignOperation. Hãy xem phần Thay đổi và kiểm tra đối tượng để thảo luận chi tiết về các thao tác.

Thay đổi đồng thời

Không thể đồng thời sửa đổi một đối tượng Google Ads 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 mình hoặc nếu bạn đang biến đổi song song các đối tượng Google Ads 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ừ nhiều ứng dụng (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á đố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, thì API sẽ tạo ra một DatabaseError.CONCURRENT_MODIFICATION_ERROR.

Phương thức thay đổi không đồng bộ so với đồng bộ

Các phương thức thay đổi của API Google Ads là đồng bộ. Lệnh gọi API chỉ trả về phản hồi sau khi các đối tượng được thay đổi, yêu cầu bạn phải đợi phản hồi cho mỗi yêu cầu. Mặc dù phương pháp này tương đối đơn giản để lập trình, 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 chờ lệnh gọi hoàn tất.

Một phương pháp thay thế là thay đổi các đối tượng một cách không đồng bộ bằng cách sử dụng BatchJobService. Phương thức này thực hiện hàng loạt 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 công việc hàng loạt, máy chủ API Google Ads 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ông việc để biết công việc đã hoàn tất hay chưa.

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

Xác thực thay đổi

Bạn có thể xác thực hầu hết các yêu cầu thay đổi mà không cần thực sự thực thi lệnh gọi dựa trên dữ liệu thực. Bạn có thể kiểm thử yêu cầu về 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. Sau đó, yêu cầu sẽ đượ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, hệ thống sẽ trả về một phản hồi trống. Nếu không xác thực được, thông báo lỗi trong phản hồi sẽ cho biết các điểm lỗi.

validate_only đặc biệt hữu ích trong việc kiểm tra quảng cáo để tìm các lỗi vi phạm chính sách phổ biến. Quảng cáo sẽ tự động bị từ chối nếu vi phạm các chính sách, chẳng hạn 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ệ duy nhất có thể khiến toàn bộ lô quảng cáo không được chấp nhận. Việc thử nghiệm 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 đố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ê hiệu suất.

Tất cả các yêu cầu SearchSearchStream 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 mệnh đề cần dùng để lọc yêu cầu và các phân đoạn cần dùng để phân tích 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 Google Ads.

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

GoogleAdsFieldService truy xuất siêu dữ liệu về tài nguyên trong API Google Ads, chẳng hạn như các thuộc tính có sẵn cho tài nguyên và loại dữ liệu của tài nguyên đó.

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