Method: customers.googleAds.search

Trả về tất cả các hàng khớp với truy vấn tìm kiếm.

Danh sách các lỗi đã gửi: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

Yêu cầu HTTP

POST https://googleads.googleapis.com/v15/customers/{customerId}/googleAds:search

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Các tham số
customerId

string

Bắt buộc. Mã của khách hàng được truy vấn.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "query": string,
  "pageToken": string,
  "pageSize": integer,
  "validateOnly": boolean,
  "returnTotalResultsCount": boolean,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Các trường
query

string

Bắt buộc. Chuỗi truy vấn.
pageToken

string

Mã thông báo của trang cần truy xuất. Nếu không được chỉ định, hệ thống sẽ trả về trang kết quả đầu tiên. Sử dụng giá trị thu được từ nextPageToken trong phản hồi trước để yêu cầu trang kết quả tiếp theo.
pageSize

integer

Số phần tử cần truy xuất trong một trang. Khi một trang được yêu cầu quá lớn, máy chủ có thể quyết định giới hạn thêm số lượng tài nguyên được trả về.
validateOnly

boolean

Nếu đúng thì yêu cầu sẽ được xác thực nhưng không được thực thi.
returnTotalResultsCount

boolean

Nếu đúng, tổng số kết quả khớp với truy vấn bỏ qua mệnh đề LIMIT sẽ được đưa vào phản hồi. Mặc định là sai.
summaryRowSetting

enum (SummaryRowSetting)

Xác định xem hàng tóm tắt có được trả về hay không. Theo mặc định, hàng tóm tắt không được trả về. Nếu được yêu cầu, hàng tóm tắt sẽ tự được gửi trong phản hồi sau khi tất cả kết quả truy vấn khác được trả về.

Nội dung phản hồi

Tin nhắn trả lời cho GoogleAdsService.Search.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "queryResourceConsumption": string
}
Các trường
results[]

object (GoogleAdsRow)

Danh sách hàng khớp với truy vấn.
nextPageToken

string

Mã thông báo phân trang dùng để truy xuất trang kết quả tiếp theo. Truyền nội dung của chuỗi này dưới dạng thuộc tính pageToken của yêu cầu tiếp theo. nextPageToken không được trả về cho trang cuối cùng.
totalResultsCount

string (int64 format)

Tổng số kết quả khớp với truy vấn bỏ qua mệnh đề LIMIT.
fieldMask

string (FieldMask format)

Trường mặt nạ biểu thị những trường mà người dùng đã yêu cầu.

Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: "user.displayName,photo"
summaryRow

object (GoogleAdsRow)

Hàng tóm tắt chứa thông tin tóm tắt về các chỉ số trong kết quả. Tóm tắt chỉ số nghĩa là tổng hợp các chỉ số trên tất cả các kết quả. Ở đây, dữ liệu tổng hợp có thể là tổng, trung bình, tỷ lệ, v.v.
queryResourceConsumption

string (int64 format)

Lượng tài nguyên được sử dụng để phân phát truy vấn.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/adwords

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.