Method: customers.googleAds.searchStream

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

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

Yêu cầu HTTP

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

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

Tham số đường dẫn

Thông số
customerId

string

Bắt buộc. Mã của khách hàng đang đượ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,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Trường
query

string

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

enum (SummaryRowSetting)

Xác định xem có trả về hàng tóm tắt hay không. Theo mặc định, hàng tóm tắt sẽ không được trả về. Nếu được yêu cầu, hàng tóm tắt sẽ tự gửi trong một 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

Thông báo phản hồi cho GoogleAdsService.SearchStream.

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)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
Trường
results[]

object (GoogleAdsRow)

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

string (FieldMask format)

FieldMask đại diện cho những trường mà người dùng đã yêu cầu.

Đây là danh sách 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ố có nghĩa là tổng hợp các chỉ số trên tất cả kết quả, trong đó tổng hợp có thể là tổng, trung bình, tỷ lệ, v.v.
requestId

string

Mã nhận dạng duy nhất của yêu cầu được dùng cho mục đích gỡ lỗi.
queryResourceConsumption

string (int64 format)

Lượng tài nguyên được sử dụng để phân phát truy vấn. queryResourceConsumption cho hàng Tóm tắt và các phản hồi không phải Tóm tắt được trả về riêng biệt trong các hàng tương ứng. queryResourceConsumption cho các phản hồi không phải Tóm tắt được trả về trong lô kết quả cuối cùng.

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 OAuth 2.0 Overview.

SummaryRowSetting

Enum mô tả chế độ cài đặt hàng tóm tắt về lượt trả lại hàng.

Enum
UNSPECIFIED Chưa chỉ định.
UNKNOWN Biểu thị các giá trị không xác định của hàng tóm tắt về lượt trả lại hàng.
NO_SUMMARY_ROW Không trả về hàng tóm tắt.
SUMMARY_ROW_WITH_RESULTS Trả về hàng tóm tắt cùng với kết quả. Hàng tóm tắt sẽ được trả về trong lô cuối cùng (lô cuối cùng sẽ không chứa kết quả).
SUMMARY_ROW_ONLY Chỉ trả về hàng tóm tắt và không trả về kết quả nào.