Method: customers.searchAds360.search

Trả về mọi dòng phù hợp với cụm từ tìm kiếm.

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

Yêu cầu HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:search

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

Tham số đường dẫn

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)
}
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ị nhận đượ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 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, 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ự 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 phản hồi cho SearchAds360Service.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 (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
Trường
results[]

object (SearchAds360Row)

Danh sách các hàng phù hợp với truy vấn.

nextPageToken

string

Mã thông báo phân trang được 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ị các 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 (SearchAds360Row)

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ả kết quả. Ở đây, dữ liệu tổng hợp có thể là tổng, trung bình, tỷ lệ, v.v.

customColumnHeaders[]

object (CustomColumnHeader)

Tiêu đề của các cột tuỳ chỉnh trong kết quả.

conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

Các tiêu đề của chỉ số tuỳ chỉnh về lượt chuyển đổi trong kết quả.

conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

Tiêu đề của phương diện tuỳ chỉnh lượt chuyển đổi trong kết quả.

rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

Tiêu đề của các chỉ số lượt chuyển đổi sự kiện chưa qua xử lý trong kết quả.

rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

Tiêu đề của phương diện lượt chuyển đổi sự kiện chưa qua xử lý trong kết quả.

Phạm vi uỷ quyền

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

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