Method: targetingTypes.targetingOptions.search

指定した検索キーワードに基づいて特定のタイプのターゲティング オプションを検索します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
targetingType

enum (TargetingType)

必須。取得するターゲティング オプションのタイプ。

次の値が利用できます。

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

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.
}
フィールド
advertiserId

string (int64 format)

必須。広告主様へのこのリクエストのコンテキストです。
pageSize

integer

リクエストされたページサイズです。 1～200 の値にしてください。指定しない場合のデフォルトは 100 です。無効な値が指定されている場合は、エラーコード INVALID_ARGUMENT を返します。
pageToken

string

サーバーが返す必要がある結果のページを特定するトークンです。 通常、これは前回の targetingOptions.search メソッドの呼び出しで返された nextPageToken の値です。指定しない場合、結果の最初のページが返されます。
共用体フィールド search_terms。ターゲティング オプションを検索するクエリ。search_terms で入力できるのは 1 つのフィールドのみで、targeting_type に対応している必要があります。search_terms は次のいずれかになります。
poiSearchTerms

object (PoiSearchTerms)

スポットのターゲティング オプションの検索キーワード。targetingType が TARGETING_TYPE_POI の場合にのみ使用できます。
businessChainSearchTerms

object (BusinessChainSearchTerms)

ビジネス チェーンのターゲティング オプションの検索キーワード。targetingType が TARGETING_TYPE_BUSINESS_CHAIN の場合にのみ使用できます。
geoRegionSearchTerms

object (GeoRegionSearchTerms)

地域ターゲティング オプションの検索キーワード。targetingType が TARGETING_TYPE_GEO_REGION の場合にのみ使用できます。

レスポンスの本文

targetingOptions.search に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
フィールド
targetingOptions[]

object (TargetingOption)

検索条件に一致するターゲティング オプションのリスト。

空の場合、このリストは存在しません。
nextPageToken

string

結果の次のページを取得するためのトークン。 結果の次のページを取得するには、この値を後続の targetingOptions.search メソッド呼び出しの pageToken フィールドに渡します。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

PoiSearchTerms

スポットのターゲティング オプションの検索キーワード。

JSON 表現 
{
  "poiQuery": string
}
フィールド
poiQuery

string

目的のスポットの名前、番地、座標の検索クエリ。クエリには接頭辞を指定できます（例:「Times squar」、「40.7505045,-73.99562」、「315 W 44th St」など

BusinessChainSearchTerms

ビジネス チェーンのターゲティング オプションの検索キーワード。

少なくとも 1 つのフィールドに値を入力する必要があります。

JSON 表現 
{
  "businessChainQuery": string,
  "regionQuery": string
}
フィールド
businessChainQuery

string

目的のビジネス チェーンの検索クエリ。クエリはビジネスの正式名称である必要があります（例:「KFC」、「メルセデス ベンツ」。
regionQuery

string

目的の地域の検索クエリ（例:「シアトル」、「米国」。

GeoRegionSearchTerms

地域ターゲティング オプションの検索キーワード。

JSON 表現 
{
  "geoRegionQuery": string
}
フィールド
geoRegionQuery

string

目的の地域の検索クエリ。クエリには接頭辞を指定できます（例:「New Yor」、「Seattle」、「USA」など