商品を作る
必要なスコープ: products:write。サブスクを提供していない環境で recurring_interval を指定すると 400 subscription_unavailable。
/productsAuthorizationBearer トークン · header必須管理画面または CLI の cozeni login で発行したクリエイターAPIキー。購入者認証には使わない。
idempotency-keystring必須同じ作成要求の再送では保存した同じキーを使う。
application/jsonnamestring必須price_jpyinteger必須access_typestring購入者限定ページ。省略時もこの種類。access_url が必須で、metadata は送れない。
pageaccess_urlstring<uri>必須descriptionstring | nullMarkdown。前後の空白を除いたコードポイント数で4000字まで。null・空白だけなら説明なし。
recurring_intervalstring | null支払いタイプ。null(省略)は買い切り、month は月額、year は年額のサブスク。作成後は変えられない。
monthyearnulltrial_intervalstring | null無料トライアルの期間の単位。trial_interval_count と両方そろえる。null(両方)でトライアルなし。定期の商品だけ。
dayweekmonthyearnulltrial_interval_countinteger | null無料トライアルの期間の長さ。上限は単位ごと(day 730・week 104・month 24・year 2)。
namestring必須price_jpyinteger必須access_typestring必須機能フラグ。access_url は送れない。metadata は任意(省略時は {})。作成後に変えられない。
featuremetadataExternalFeatureFlagMetadata機能フラグの設定値。50件まで。キーは1〜40字の英数字・_・-(proto は不可)。値は文字列(1〜500字)・数値・真偽値。URLやAPIキーなどの秘匿情報は入れない。
descriptionstring | nullMarkdown。前後の空白を除いたコードポイント数で4000字まで。null・空白だけなら説明なし。
recurring_intervalstring | null支払いタイプ。null(省略)は買い切り、month は月額、year は年額のサブスク。作成後は変えられない。
monthyearnulltrial_intervalstring | null無料トライアルの期間の単位。trial_interval_count と両方そろえる。null(両方)でトライアルなし。定期の商品だけ。
dayweekmonthyearnulltrial_interval_countinteger | null無料トライアルの期間の長さ。上限は単位ごと(day 730・week 104・month 24・year 2)。
公開商品情報。リンクは別APIで取得する。
idstring必須namestring必須price_jpyinteger必須currencystring必須jpyrecurring_intervalstring | null必須支払いタイプ。null(省略)は買い切り、month は月額、year は年額のサブスク。作成後は変えられない。
monthyearnulltrial_intervalstring | null必須無料トライアルの期間の単位。trial_interval_count と両方そろえる。null(両方)でトライアルなし。定期の商品だけ。
dayweekmonthyearnulltrial_interval_countinteger | null必須無料トライアルの期間の長さ。上限は単位ごと(day 730・week 104・month 24・year 2)。
access_urlstring | null必須access_typestring必須pagefeaturefilemetadataExternalFeatureFlagMetadata必須機能フラグの設定値。50件まで。キーは1〜40字の英数字・_・-(proto は不可)。値は文字列(1〜500字)・数値・真偽値。URLやAPIキーなどの秘匿情報は入れない。
descriptionstring | null必須imagesExternalProductImage[]必須プロパティを表示プロパティを非表示
ExternalProductImage の配列idstring必須urlstring<uri>必須content_typestring必須size_bytesinteger必須statusstring必須activearchivedcreated_atstring<date-time>必須updated_atstring<date-time>必須invalid_input。未知フィールド、無効なcursor・入力を含む。
errorobject必須プロパティを表示プロパティを非表示
codestring必須messagestring必須request_idstring必須unauthorized。失効、期限切れ、環境違いを含む。
errorobject必須プロパティを表示プロパティを非表示
codestring必須messagestring必須request_idstring必須insufficient_scope。
errorobject必須プロパティを表示プロパティを非表示
codestring必須messagestring必須request_idstring必須product_not_found / checkout_link_not_found。他人の商品も404。
errorobject必須プロパティを表示プロパティを非表示
codestring必須messagestring必須request_idstring必須idempotency_conflict / product_archived / checkout_link_disabled。
errorobject必須プロパティを表示プロパティを非表示
codestring必須messagestring必須request_idstring必須rate_limited。
errorobject必須プロパティを表示プロパティを非表示
codestring必須messagestring必須request_idstring必須internal。
errorobject必須プロパティを表示プロパティを非表示
codestring必須messagestring必須request_idstring必須unavailable。
errorobject必須プロパティを表示プロパティを非表示
codestring必須messagestring必須request_idstring必須