REST Resource: exchanges.orders.products

リソース: Product

プロダクト

JSON 表現 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "program": string,
  "buyerCustomParameters": {
    string: string,
    ...
  },
  "etag": string
}
フィールド
name

string

商品の相対的なリソース名。サーバーによって生成されます。例: 「exchanges/1234/orders/5678/products/abc」。出力専用。
displayName

string

プロダクトの表示名。

UTF-8 でエンコードされ、最大サイズが 240 バイトである必要があります。必須。
externalDealId

string

外部 ID。これはエクスチェンジ システムの取引 ID です。最大 100 文字。使用できる文字は、英数字、アンダースコア、ダッシュ、ドットです。すべての商品で一意である必要があります。必須。
transactionType

enum (TransactionType)

商品の取引タイプ。必須。
pricingType

enum (PricingType)

プロダクトの料金タイプ。必須。
updateTime
(deprecated)

string (Timestamp format)

商品が最後に更新されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
startTime

string (Timestamp format)

この商品が有効になる日時。endTime より前の時刻にする必要があります。開始時間は 1 年先までしか指定できません。必須。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

この商品が無効になる日時。2036 年より後の日付は指定できません。必須。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
rateDetails

object (RateDetails)

料金の詳細。必須。
creativeConfig[]

object (CreativeConfig)

プロダクトのクリエイティブ要件。予約取引タイプのプロダクトに必須です。
makegood
(deprecated)

boolean

商品が埋め合わせ商品かどうかを示します。
makegoodDetails
(deprecated)

object (MakegoodDetails)

商品の埋め合わせの詳細。商品が埋め合わせの場合は必須です。
creativeSource

enum (CreativeSource)

商品のクリエイティブ ソース。省略可。デフォルトは CREATIVE_SOURCE_ADVERTISER です。プロダクトの作成後に変更することはできません。
mediumType

enum (MediumType)

商品のメディアタイプ。下位互換性のために指定されていない場合のデフォルトは DIGITAL です。プロダクトの作成後に変更することはできません。
audienceTargetingConfig

object (AudienceTargetingConfig)

省略可。エクスチェンジの取引単位で適用されるオーディエンス ターゲティングの設定。
targetingCriteria

object (TargetingCriteria)

出力専用。商品ターゲティング条件のリファレンス。インスタント取引のシナリオにのみ適用されます。
forecastResult

object (ForecastResult)

商品の予測結果。ターゲティング条件が空ではなく、予測が指定されていない場合に必要です。インスタント取引のシナリオにのみ適用されます。
errorDetails

object (ErrorDetails)

特定のプロダクト フィールドを更新できない場合は、エラーの詳細を指定する必要があります。ターゲティング条件が原因で予測結果を提供できない場合、または商品に更新を適用できない場合に必要です。インスタント取引のシナリオにのみ適用されます。
frequencyCap

object (FrequencyCap)

出力専用。購入者が選択したフリークエンシー キャップ。インスタント取引のシナリオにのみ適用されます。
program

string

出力専用。購入者がインスタント取引を作成したプログラム。交換の通常のフローの場合は空欄にします。インスタント取引のシナリオにのみ適用されます。
buyerCustomParameters

map (key: string, value: string)

出力専用。インスタント取引リクエストで購入者が設定したカスタム Key-Value パラメータ。インスタント取引のシナリオにのみ適用されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
etag

string

商品を更新するときに指定する必要がある etag。etag フィールドが空でない場合にのみ、更新に指定する必要があります。インスタント取引のシナリオにのみ適用されます。

CreativeConfig

商品のクリエイティブ要件の構成。

JSON 表現 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
フィールド
creativeType

enum (CreativeType)

クリエイティブ タイプ。必須。
dimensionCreativeConfig

object (DimensionCreativeConfig)

ディスプレイ クリエイティブの構成。このフィールドは、ネイティブ クリエイティブ（CREATIVE_TYPE_NATIVE）ではサポートされていません。
durationCreativeConfig

object (DurationCreativeConfig)

動画クリエイティブの構成。

CreativeType

利用可能なクリエイティブ タイプ。

列挙型
CREATIVE_TYPE_UNSPECIFIED クリエイティブ タイプが指定されていません。入力値が無効です。
CREATIVE_TYPE_DISPLAY ディスプレイのクリエイティブ タイプ。
CREATIVE_TYPE_VIDEO 動画のクリエイティブ タイプ。
CREATIVE_TYPE_AUDIO オーディオのクリエイティブ タイプ。
CREATIVE_TYPE_NATIVE ネイティブのクリエイティブ タイプ。これは、RESERVED 取引タイプの商品ではサポートされていません。

DimensionCreativeConfig

ディスプレイ クリエイティブ サイズ（ピクセル単位）。

JSON 表現 
{
  "width": integer,
  "height": integer
}
フィールド
width

integer

ディスプレイ クリエイティブの幅。必須。
height

integer

ディスプレイ クリエイティブの高さ。必須。

DurationCreativeConfig

期間内のクリエイティブの構成。

JSON 表現 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
フィールド
duration

string (Duration format)

動画クリエイティブの長さ（秒単位）。必須

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
durationMatchType

enum (DurationMatchType)

再生時間の一致条件。
skippableMatchType

enum (SkippableMatchType)

動画クリエイティブのスキップ可能なタイプ。

DurationMatchType

動画クリエイティブの再生時間のマッチ条件。

列挙型
DURATION_MATCH_TYPE_UNSPECIFIED このバージョンでは、再生時間の一致条件が指定されていないか、不明です。入力値が無効です。
DURATION_MATCH_TYPE_EQUAL_TO クリエイティブの再生時間は、必要な再生時間と同じにする必要があります。
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO クリエイティブの再生時間は、必要な再生時間以下にする必要があります。

SkippableMatchType

動画クリエイティブがスキップ可能かどうかのマッチ条件。

列挙型
SKIPPABLE_MATCH_TYPE_UNSPECIFIED スキップ可能なタイプが指定されていないか、このバージョンでは不明です。入力値が無効です。
SKIPPABLE_MATCH_TYPE_SKIPPABLE クリエイティブはスキップ可能である必要があります。
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE クリエイティブはスキップ不可である必要があります。
SKIPPABLE_MATCH_TYPE_ANY クリエイティブはスキップ可能またはスキップ不可にできます。

MakegoodDetails

埋め合わせの詳細の構成。

JSON 表現 
{
  "originalExternalDealId": string,
  "reason": string
}
フィールド
originalExternalDealId

string

埋め合わせ広告をリクエストしている元の外部取引 ID。最大 100 文字。使用できる文字は、英数字、アンダースコア、ダッシュ、ドットです。必須。
reason

string

販売者が開始した埋め合わせ広告の理由。最大 250 文字。必須。

CreativeSource

クリエイティブ ソース。クリエイティブの配信元。

列挙型
CREATIVE_SOURCE_UNSPECIFIED このバージョンでは、クリエイティブ ソースが指定されていないか、不明です。入力値が無効です。
CREATIVE_SOURCE_ADVERTISER クリエイティブはディスプレイ＆ビデオ 360 によって配信されます。
CREATIVE_SOURCE_PUBLISHER クリエイティブはパブリッシャーによって配信されます。パブリッシャーがホストするクリエイティブは現在サポートされていません。クリエイティブ ソースを CREATIVE_SOURCE_PUBLISHER に設定しようとするリクエストは失敗します。

AudienceTargetingConfig

オーディエンス ターゲティングの構成。

JSON 表現 
{
  "audienceType": enum (AudienceType)
}
フィールド
audienceType

enum (AudienceType)

オーディエンス タイプ。必須。

AudienceType

オーディエンス タイプ。

列挙型
AUDIENCE_TYPE_UNSPECIFIED オーディエンス タイプが指定されていません。入力として無効です。
AUDIENCE_TYPE_COMMERCE コマース オーディエンスのタイプ。

TargetingCriteria

ターゲティング条件が指定されている。

JSON 表現 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
フィールド
selectedTargetingOptions[]

object (SelectedTargetingOption)

選択したオプション。

SelectedTargetingOption

1 つのターゲティング タイプに対して選択された 1 つまたは複数のターゲティング オプション。

JSON 表現 
{
  "type": enum (TargetingType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of mutually exclusive fields.
}
フィールド
type

enum (TargetingType)

選択したオプションに関連付けられているターゲティング タイプ。
含めることができる選択タイプは 1 つのみです。選択する値は、type フィールドで選択した TargetingType に対応している必要があります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
audienceSelection

object (AudienceSelection)

選択したオーディエンス。
targetingSelection

object (TargetingSelection)

選択したオプション ID の一般的なセット。
相互に排他的なフィールドの終了。

TargetingType

ターゲティング タイプ。

列挙型
TARGETING_TYPE_UNSPECIFIED ターゲティング タイプが指定されていません。入力として無効です。
TARGETING_TYPE_AUDIENCE ターゲティング タイプ: オーディエンス。
TARGETING_TYPE_COUNTRY ターゲティング タイプ: 国。
TARGETING_TYPE_DMA ターゲティング タイプ: DMA。
TARGETING_TYPE_PROGRAMMER ターゲティング タイプ: プログラマー。
TARGETING_TYPE_BRAND ターゲティング タイプ: ブランド。
TARGETING_TYPE_CONTENT_GENRE ターゲティング タイプ: コンテンツ ジャンル。
TARGETING_TYPE_DEVICE ターゲティング タイプ: デバイス。
TARGETING_TYPE_OPERATING_SYSTEM ターゲティング タイプ: オペレーティング システム。
TARGETING_TYPE_RATING ターゲティング タイプの評価。
TARGETING_TYPE_ENVIRONMENT ターゲティング タイプ: 環境。
TARGETING_TYPE_LANGUAGE ターゲティング タイプ: 言語。
TARGETING_TYPE_GEO ターゲティング タイプ: 地域。
TARGETING_TYPE_AGE ターゲティング タイプ: 年齢。
TARGETING_TYPE_GENDER ターゲティング タイプ: 性別。
TARGETING_TYPE_CONTEXTUAL_SEGMENT ターゲティング タイプのコンテキスト セグメント。
TARGETING_TYPE_REQUEST_FORMAT ターゲティング タイプのリクエスト形式。
TARGETING_TYPE_PUBLISHER ターゲティング タイプ: パブリッシャー。
TARGETING_TYPE_INVENTORY_SIZE ターゲティング タイプのサイズ。
TARGETING_TYPE_NETWORK ターゲティング タイプ: ネットワーク。
TARGETING_TYPE_PLATFORM ターゲティング タイプ プラットフォーム。
TARGETING_TYPE_VIDEO_DELIVERY_TYPE ターゲティング タイプ: 動画配信タイプ。
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE ターゲティング タイプ: 動画プレーヤーの最小サイズ。
TARGETING_TYPE_VIDEO_COMPLETION ターゲティング タイプ: 動画プレースメント。
TARGETING_TYPE_VIEWABILITY ターゲティング タイプ: 視認性。
TARGETING_TYPE_REWARDED ターゲティング タイプ: リワード。
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC ターゲティング タイプ: 動画広告の再生時間の上限（秒）。
TARGETING_TYPE_VIDEO_PLACEMENT ターゲティング タイプ: 動画プレースメント。
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD ターゲティング タイプ「動画の再生方法」。
TARGETING_TYPE_APP_ID ターゲティング タイプのアプリ ID。
TARGETING_TYPE_DOMAIN_URL ターゲティング タイプのドメイン URL。
TARGETING_TYPE_CTR ターゲティング タイプのクリック率。
TARGETING_TYPE_DEMOGRAPHICS ターゲティング タイプ: ユーザー属性。
TARGETING_TYPE_RESTRICTED_CATEGORY ターゲティング タイプの制限付きカテゴリ。
TARGETING_TYPE_AD_POSITION ターゲティング タイプの広告の掲載順位。
TARGETING_TYPE_DAY_AND_TIME ターゲティング タイプ: 曜日と時間。
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE ターゲティング タイプ: リテール メディア オーディエンス。

AudienceSelection

選択したオーディエンス ターゲティング オプション。

JSON 表現 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
フィールド
includedOrGroups[]

object (OrGroup)

含まれるオプションは AND で結合されます。含まれる各オプションは、個別のオプションにすることも、OR で結合されたオプションのグループにすることもできます。
excludedOptionIds[]

string (int64 format)

除外されたオプションは OR で結合されます。

OrGroup

OR で結合された選択オプションのグループ。

JSON 表現 
{
  "optionIds": [
    string
  ]
}
フィールド
optionIds[]

string (int64 format)

選択したオプション ID。

TargetingSelection

選択したターゲティング オプションと除外ターゲティング オプション（ほとんどのターゲティング タイプに適用可能）。

JSON 表現 
{
  "optionIds": [
    string
  ],
  "externalIds": [
    string
  ],
  "excludedOptionIds": [
    string
  ],
  "excludedExternalIds": [
    string
  ]
}
フィールド
optionIds[]

string (int64 format)

出力専用。エクスチェンジと共有されている、選択したディスプレイ＆ビデオ 360 のターゲティング オプション ID。2 つのリストが重複しない限り、excludedOptionIds と一緒に返されることがあります。
externalIds[]

string

出力専用。エクスチェンジから提供された、選択したターゲティング オプションの ID。2 つのリストが重複しない限り、excludedExternalIds と一緒に返されることがあります。
excludedOptionIds[]

string (int64 format)

出力専用。エクスチェンジと共有されている、除外されたディスプレイ＆ビデオ 360 のターゲティング オプション ID。2 つのリストが重複しない限り、optionIds とともに返されることがあります。
excludedExternalIds[]

string

出力専用。エクスチェンジから提供された除外ターゲティング オプション ID。2 つのリストが重複しない限り、externalIds と一緒に返されることがあります。

ForecastResult

予測結果が指定されています。

JSON 表現 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
フィールド
forecasts[]

object (Forecast)

予測。forecastCategory は、指定された要素ごとに一意である必要があります。

予測

指定された予測カテゴリの予測。

JSON 表現 
{
  "forecastCategory": enum (ForecastCategory),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of mutually exclusive fields.
}
フィールド
forecastCategory

enum (ForecastCategory)

予測統計が表す、指定された予測カテゴリ。
含めることができる統計データの種類は 1 つのみです。入力するデータは forecastCategory フィールドに対応している必要があります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
number

string (int64 format)

数値データ。
percentage

integer

割合データ。
cpmPrice

object (Money)

CPM 価格データ。
cpmRange

object (CpmRange)

CPM の価格帯データ。
forecastBreakdownData

object (ForecastBreakdownData)

予測の内訳データ。
相互に排他的なフィールドの終了。

ForecastCategory

予測カテゴリ。

列挙型
FORECAST_CATEGORY_UNSPECIFIED カテゴリが指定されていません。入力として無効です。
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES 配信される可能性のあった広告数の合計。数値データ。
FORECAST_CATEGORY_TOTAL_AUDIENCE 視聴者総数。数値データ。
FORECAST_CATEGORY_DIGITAL_TRP デジタル ターゲット視聴率。割合データ。
FORECAST_CATEGORY_SUGGESTED_CPM 推奨 CPM 価格。CPM の範囲または CPM の価格データ。
FORECAST_CATEGORY_UNIQUE_REACH ユニークリーチを予測する。数値データ。
FORECAST_CATEGORY_FORECAST_BREAKDOWN 予測の内訳。予測の内訳データ。

CpmRange

CPM の範囲には、CPM の最小値と最大値が含まれます。

JSON 表現 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
フィールド
minCpm

object (Money)

CPM 範囲の下限。
maxCpm

object (Money)

CPM 範囲の上限。

ForecastBreakdownData

予測の内訳データには、予測の内訳のリストが保持されます。

JSON 表現 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
フィールド
forecastBreakdowns[]

object (ForecastBreakdown)

予測の内訳のリスト。

ForecastBreakdown

選択したターゲティング オプションの予測の内訳。

JSON 表現 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "impressions": string
  // End of mutually exclusive fields.
}
フィールド
selectedTargetingOption

object (SelectedTargetingOption)

1 つのターゲティング タイプに対して選択された 1 つまたは複数のターゲティング オプション。
含めることができる内訳データは 1 種類のみです。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
impressions

string (int64 format)

インプレッション数を予測する。
相互に排他的なフィールドの終了。

ErrorDetails

更新にエラーがある場合に指定されるエラーの詳細。

JSON 表現 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
フィールド
message

string

更新時にエラーが発生したときに指定されるメッセージ。
instantDealErrorStatus

enum (InstantDealErrorStatus)

インスタント取引の更新でエラーが発生した場合に指定されるエラー ステータス。

InstantDealErrorStatus

インスタント取引の更新でエラーが発生した場合に指定されるエラー ステータス。

列挙型
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED 不明なエラー ステータス。
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE エラー ステータスは、在庫がないことを示します。
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE エラー ステータスは、予測が利用できないことを示します。
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT エラー ステータスは、無効な入力フィールドがあることを示します。

FrequencyCap

一定期間内に同じユーザーに同じ広告が表示される回数

JSON 表現 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
フィールド
timeUnit

enum (TimeUnit)

フリークエンシー キャップが適用される単位時間。
maxImpressions

string (int64 format)

この期間中に同じ広告がユーザーに表示される最大回数。

TimeUnit

フリークエンシー キャップが適用される単位時間。

列挙型
TIME_UNIT_UNSPECIFIED 時間単位が指定されていません。
TIME_UNIT_LIFETIME フリークエンシー キャップは全期間に適用されます。
TIME_UNIT_MONTHS フリークエンシー キャップは、指定した月数に適用されます。
TIME_UNIT_WEEKS フリークエンシー キャップは、指定した週数に適用されます。
TIME_UNIT_DAYS フリークエンシー キャップは、指定した日数に適用されます。

メソッド

create

 商品を作成します。

get

 商品を取得します。

list

 商品を一覧表示します。

patch

 商品を更新します。