Method: exchanges.orders.products.patch

商品を更新します。

HTTP リクエスト

PATCH https://dv360seller.googleapis.com/v1beta1/{product.name=exchanges/*/orders/*/products/*}

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

パスパラメータ

パラメータ
product.name

string

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

リクエストの本文

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

JSON 表現 
{
  "product": {
    "name": string,
    "displayName": string,
    "externalDealId": string,
    "transactionType": enum (TransactionType),
    "pricingType": enum (PricingType),
    "updateTime": string,
    "startTime": string,
    "endTime": string,
    "rateDetails": {
      "rateType": enum (RateType),
      "rate": {
        object (Money)
      },
      "unitsPurchasedCount": string
    },
    "creativeConfig": [
      {
        "creativeType": enum (CreativeType),
        "dimensionCreativeConfig": {
          object (DimensionCreativeConfig)
        },
        "durationCreativeConfig": {
          object (DurationCreativeConfig)
        }
      }
    ],
    "makegood": boolean,
    "makegoodDetails": {
      "originalExternalDealId": string,
      "reason": string
    },
    "creativeSource": enum (CreativeSource),
    "mediumType": enum (MediumType),
    "audienceTargetingConfig": {
      "audienceType": enum (AudienceType)
    },
    "targetingCriteria": {
      "selectedTargetingOptions": [
        {
          object (SelectedTargetingOption)
        }
      ]
    },
    "forecastResult": {
      "forecasts": [
        {
          object (Forecast)
        }
      ]
    },
    "errorDetails": {
      "message": string,
      "instantDealErrorStatus": enum (InstantDealErrorStatus)
    },
    "frequencyCap": {
      "timeUnit": enum (TimeUnit),
      "maxImpressions": string
    },
    "program": string,
    "buyerCustomParameters": {
      string: string,
      ...
    },
    "etag": string
  },
  "updateMask": string
}
フィールド
product.displayName

string

プロダクトの表示名。

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

string

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

enum (TransactionType)

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

enum (PricingType)

プロダクトの料金タイプ。必須。
product.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"。
product.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"。
product.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"。
product.rateDetails

object (RateDetails)

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

object (CreativeConfig)

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

boolean

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

object (MakegoodDetails)

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

enum (CreativeSource)

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

enum (MediumType)

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

object (AudienceTargetingConfig)

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

object (TargetingCriteria)

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

object (ForecastResult)

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

object (ErrorDetails)

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

object (FrequencyCap)

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

string

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

map (key: string, value: string)

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

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

string

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

string (FieldMask format)

更新するフィールドを制御するマスク。必須。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

レスポンスの本文

成功した場合、レスポンスの本文には Product のインスタンスが含まれます。

認可スコープ

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

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

詳細については、OAuth 2.0 Overview をご覧ください。