REST Resource: sellers.products

リソース: Product

単一の商品。

JSON 表現
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "creativeSpecifications": [
    {
      object (CreativeSpecification)
    }
  ],
  "bookingLeadDuration": string,
  "assignmentLeadDuration": string,
  "minFlightDuration": string,
  "maxFlightDuration": string,
  "slotDuration": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "currencyCode": string
}
フィールド
name

string

商品のリソース名。形式は sellers/{seller}/products/{product} です。例: sellers/seller111/products/product123

externalId

string

このエンティティを外部ソースにマッピングするために使用される ID。

displayName

string

必須。商品の表示名。

UTF-8 でエンコードし、最大サイズを 240 バイトにする必要があります。

description

string

商品を説明する追加の自由形式フィールド。

labels

map (key: string, value: string)

この商品を説明する自由形式のラベルのセット。

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

creativeSpecifications[]

object (CreativeSpecification)

必須。この商品で配信できるクリエイティブのリストです。

bookingLeadDuration

string (Duration format)

必須。商品の予約に必要なリード期間。Now + bookingLeadDuration は掲載期間の開始後である必要があります。

小数点以下 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

assignmentLeadDuration

string (Duration format)

必須。クリエイティブを割り当てるには、リード期間が必要です。

小数点以下 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

minFlightDuration

string (Duration format)

このアイテムの最小掲載期間。

小数点以下 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

maxFlightDuration

string (Duration format)

必須。この商品の最大掲載期間です。

小数点以下 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

slotDuration

string (Duration format)

必須。この商品のスロット期間。

小数点以下 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

createTime

string (Timestamp format)

出力専用。商品の作成タイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

出力専用。商品の最終更新タイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

state

enum (State)

出力専用。この商品の状態。

currencyCode

string

必須。ISO 4217 で定義されている大文字 3 文字の通貨コード。

商品状態に指定できる値。

列挙型
STATE_UNSPECIFIED プロダクトの状態が指定されていないか、このバージョンで不明な場合のデフォルト値。
STATE_ACTIVE プロダクトは有効です。
STATE_DELETED プロダクトが削除されました。

メソッド

create

新しい商品を作成します。

delete

既存の商品を削除します。

get

個々の商品を取得します。

list

商品を一覧表示します。

patch

既存の商品を更新します。