Method: targetingTypes.targetingOptions.search

Tìm kiếm các lựa chọn nhắm mục tiêu thuộc một loại nhất định dựa trên cụm từ tìm kiếm nhất định.

Yêu cầu HTTP

POST https://displayvideo.googleapis.com/v4/targetingTypes/{targetingType}/targetingOptions:search

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

Tham số đường dẫn

Thông số
targetingType

enum (TargetingType)

Bắt buộc. Loại tuỳ chọn nhắm mục tiêu cần truy xuất.

Các giá trị được chấp nhận là:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

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
{
  "advertiserId": string,
  "pageSize": integer,
  "pageToken": string,

  // Union field search_terms can be only one of the following:
  "poiSearchTerms": {
    object (PoiSearchTerms)
  },
  "businessChainSearchTerms": {
    object (BusinessChainSearchTerms)
  },
  "geoRegionSearchTerms": {
    object (GeoRegionSearchTerms)
  }
  // End of list of possible types for union field search_terms.
}
Trường
advertiserId

string (int64 format)

Bắt buộc. Nhà quảng cáo mà yêu cầu này được đưa ra trong ngữ cảnh của họ.

pageSize

integer

Kích thước trang được yêu cầu. Phải nằm trong khoảng từ 1 đến 200. Nếu không chỉ định, giá trị mặc định sẽ là 100. Trả về mã lỗi INVALID_ARGUMENT nếu bạn chỉ định một giá trị không hợp lệ.

pageToken

string

Mã thông báo xác định trang kết quả mà máy chủ sẽ trả về. Thông thường, đây là giá trị của nextPageToken được trả về từ lệnh gọi trước đó đến phương thức targetingOptions.search. Nếu không được chỉ định, trang kết quả đầu tiên sẽ được trả về.

Trường hợp hợp nhất search_terms. Truy vấn để tìm kiếm các tuỳ chọn nhắm mục tiêu. Bạn chỉ có thể điền một trường trong search_terms và trường đó phải tương ứng với targeting_type. search_terms chỉ có thể là một trong những loại sau:
poiSearchTerms

object (PoiSearchTerms)

Cụm từ tìm kiếm cho các tuỳ chọn nhắm mục tiêu theo địa điểm yêu thích. Chỉ có thể sử dụng khi targetingTypeTARGETING_TYPE_POI.

businessChainSearchTerms

object (BusinessChainSearchTerms)

Cụm từ tìm kiếm cho các lựa chọn nhắm mục tiêu theo Chuỗi doanh nghiệp. Chỉ có thể sử dụng khi targetingTypeTARGETING_TYPE_BUSINESS_CHAIN.

geoRegionSearchTerms

object (GeoRegionSearchTerms)

Cụm từ tìm kiếm cho các lựa chọn nhắm mục tiêu theo khu vực địa lý. Chỉ có thể sử dụng khi targetingTypeTARGETING_TYPE_GEO_REGION.

Nội dung phản hồi

Thông báo phản hồi cho targetingOptions.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
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
Trường
targetingOptions[]

object (TargetingOption)

Danh sách các lựa chọn nhắm mục tiêu phù hợp với tiêu chí tìm kiếm.

Danh sách này sẽ không xuất hiện nếu trống.

nextPageToken

string

Mã thông báo để truy xuất trang kết quả tiếp theo. Truyền giá trị này trong trường pageToken trong lệnh gọi tiếp theo đến phương thức targetingOptions.search để truy xuất trang kết quả tiếp theo.

Phạm vi uỷ quyền

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

  • https://www.googleapis.com/auth/display-video

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

PoiSearchTerms

Cụm từ tìm kiếm cho các tuỳ chọn nhắm mục tiêu theo địa điểm yêu thích.

Biểu diễn dưới dạng JSON
{
  "poiQuery": string
}
Trường
poiQuery

string

Cụm từ tìm kiếm cho tên, địa chỉ đường phố hoặc toạ độ của POI mong muốn. Truy vấn có thể là một tiền tố, ví dụ: "Times Square", "40.7505045,-73.99562", "315 W 44th St", v.v.

BusinessChainSearchTerms

Cụm từ tìm kiếm cho các lựa chọn nhắm mục tiêu theo Chuỗi doanh nghiệp.

Bạn phải điền vào ít nhất một trong các trường này.

Biểu diễn dưới dạng JSON
{
  "businessChainQuery": string,
  "regionQuery": string
}
Trường
businessChainQuery

string

Cụm từ tìm kiếm cho chuỗi doanh nghiệp mong muốn. Truy vấn phải là tên đầy đủ của doanh nghiệp, ví dụ: "KFC", "mercedes-benz".

regionQuery

string

Cụm từ tìm kiếm cho khu vực địa lý mong muốn, ví dụ: "Seattle", "Hoa Kỳ".

GeoRegionSearchTerms

Cụm từ tìm kiếm cho các lựa chọn nhắm mục tiêu theo khu vực địa lý.

Biểu diễn dưới dạng JSON
{
  "geoRegionQuery": string
}
Trường
geoRegionQuery

string

Cụm từ tìm kiếm cho khu vực địa lý mong muốn. Truy vấn có thể là một tiền tố, ví dụ: "New Yor", "Seattle", "USA", v.v.