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)
  },
  "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)

出力専用。購入者が選択したフリークエンシー キャップ。インスタント ディール シナリオにのみ適用されます。
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 ネイティブのクリエイティブ タイプ。

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 クリエイティブは DV3 によって配信されます。
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

単一のターゲティング タイプで選択されたターゲティング オプション。

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

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
フィールド
type

enum (TargetingType)

選択したオプションに関連付けられているターゲティング タイプ。
共用体フィールド value。含めることができる選択肢のタイプは 1 つのみです。選択した内容は、[type] フィールドで選択した TargetingType に対応している必要があります。value は次のいずれかになります。
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 ターゲティング タイプ動画プレーヤーの最小サイズ。

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

選択した 1 つ以上のオプション ID のセット。ほとんどのターゲティング タイプに適用できます。

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

string (int64 format)

選択したオプションの ID。

ForecastResult

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

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

object (Forecast)

予測。「forecastCategory」は、指定された各要素に対して一意である必要があります。

予測

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

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

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
フィールド
forecastCategory

enum (ForecastCategory)

予測統計が表す指定された予測カテゴリ。
共用体フィールド forecast_data。含めることができる統計データは 1 種類のみです。入力されたデータは、「forecastCategory」フィールドに対応している必要があります。forecast_data は次のいずれかになります。
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)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
フィールド
selectedTargetingOption

object (SelectedTargetingOption)

単一のターゲティング タイプで選択されたターゲティング オプション。
共用体フィールド breakdown_data。内訳データは 1 種類のみ含めることができます。breakdown_data は次のいずれかになります。
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

 商品を更新します。