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
    },
    "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.etag

string

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

string (FieldMask format)

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

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

レスポンスの本文

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

認可スコープ

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

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

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