REST Resource: monetization.onetimeproducts.purchaseOptions.offers

リソース: OneTimeProductOffer

1 回限りのアイテムの 1 つの特典。

JSON 表現 
{
  "packageName": string,
  "productId": string,
  "purchaseOptionId": string,
  "offerId": string,
  "state": enum (State),
  "regionalPricingAndAvailabilityConfigs": [
    {
      object (RegionalPricingAndAvailabilityConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  },

  // Union field offer_type can be only one of the following:
  "preOrderOffer": {
    object (OneTimeProductPreOrderOffer)
  },
  "discountedOffer": {
    object (OneTimeProductDiscountedOffer)
  }
  // End of list of possible types for union field offer_type.
}
フィールド
packageName

string

必須。変更不可。親アイテムが属するアプリのパッケージ名。
productId

string

必須。変更不可。この特典が属する親アイテムの ID。
purchaseOptionId

string

必須。変更不可。この特典が追加される購入オプションの ID。
offerId

string

必須。変更不可。このアイテムの特典 ID。購入オプション内で一意にする必要があります。先頭は必ず数字または英小文字にしてください。使用できるのは、英小文字（a ～ z）、数字（0 ～ 9）、ハイフン（-）のみです。63 文字以下で指定してください。
state

enum (State)

出力専用。この特典の現在の状態。リソースを更新してもこのフィールドは変更できません。代わりに専用のエンドポイントを使用してください。
regionalPricingAndAvailabilityConfigs[]

object (RegionalPricingAndAvailabilityConfig)

この特典の地域別価格と提供状況に関する情報のセット。regionCode が同一の重複するエントリは認められません。
offerTags[]

object (OfferTag)

省略可。この特典に対して指定され、Billing Library を通してアプリに返されるカスタムタグのリスト（最大 20 個）。
regionsVersion

object (RegionsVersion)

出力専用。1 回限りのアイテム特典の生成に使用された地域構成のバージョン。
共用体フィールド offer_type。この特典のタイプ。必ず 1 つ設定する必要があります。offer_type は次のいずれかになります。
preOrderOffer

object (OneTimeProductPreOrderOffer)

予約購入特典。
discountedOffer

object (OneTimeProductDiscountedOffer)

割引特典。

州

特典の現在の状態。

列挙型
STATE_UNSPECIFIED デフォルト値。使用しないでください。
DRAFT 特典は今までも現在もユーザーに提供されていません。
ACTIVE 条件にあっている限り、ユーザーは特典を利用できます。
CANCELLED 予約購入固有の状態です。特典はキャンセルされており、ユーザーに提供されていません。この特典に関連するすべての保留中の注文がキャンセルされました。
INACTIVE 割引特典固有の状態です。特典はユーザーに提供されなくなっています。

OneTimeProductPreOrderOffer

予約購入特典固有の設定。

JSON 表現 
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
フィールド
startTime

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"。
endTime

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"。
releaseTime

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"。
priceChangeBehavior

enum (PreOrderPriceChangeBehavior)

必須。変更不可。既存の予約購入に対する価格変更の影響を指定します。

PreOrderPriceChangeBehavior

既存の予約購入に対する価格変更の影響を指定します。

列挙型
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED 価格変更影響未指定。使用しないでください。
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST 購入者は、予約購入時の最初の価格からリリース日の最終的な特典価格までの間の最低価格を請求されます。
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY 予約購入後に価格が変更された場合でも、購入者は予約購入時の価格で購入できます。

OneTimeProductDiscountedOffer

割引特典に固有の設定。

JSON 表現 
{
  "startTime": string,
  "endTime": string,
  "redemptionLimit": string
}
フィールド
startTime

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"。
endTime

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"。
redemptionLimit

string (int64 format)

省略可。この特典を利用できる回数。設定しない場合、または 0 に設定した場合、特典の利用回数は無制限になります。それ以外の場合は、1 ～ 50 の数値にする必要があります（両端を含む）。

RegionalPricingAndAvailabilityConfig

1 回限りのアイテム特典の地域別価格および提供状況の設定。

JSON 表現 
{
  "regionCode": string,
  "availability": enum (Availability),

  // Union field price_override can be only one of the following:
  "noOverride": {
    object (OneTimeProductOfferNoPriceOverrideOptions)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  }
  // End of list of possible types for union field price_override.
}
フィールド
regionCode

string

必須。この設定が適用される地域コード（ISO 3166-2 形式。例: 「US」）。
availability

enum (Availability)

必須。この地域での提供状況。
共用体フィールド price_override。この特典の価格オーバーライド。必ず 1 つ設定する必要があります。price_override は次のいずれかになります。
noOverride

object (OneTimeProductOfferNoPriceOverrideOptions)

この地域での購入オプションで定義される価格が使用されます。
relativeDiscount

number

この特典に対してユーザーが支払う購入オプションの価格に対する割引率。たとえば、この地域における購入オプションの価格が $12 の場合、50% 割引の価格は $6 となります。割引率は、厳密に 0 より大きく 1 より小さな値で指定する必要があります。割引後の価格は、最も近い請求可能な単位に丸められます（例: USD の場合はセント）。割引後の価格が、地域で認められている最低価格よりも低くなった場合は、率での割引は無効とみなされます。
absoluteDiscount

object (Money)

購入オプションの価格から差し引かれる割引の絶対値。

0 から購入オプションの価格までの範囲で指定する必要があります。

OneTimeProductOfferNoPriceOverrideOptions

この型にはフィールドがありません。

1 回限りのアイテム特典のオプション（地域別価格のオーバーライドなし）。

対象

特典の提供状況。

列挙型
AVAILABILITY_UNSPECIFIED 提供状況未指定。使用しないでください。
AVAILABLE 特典はユーザーに提供されています。
NO_LONGER_AVAILABLE 特典はユーザーに提供されなくなっています。この値は、提供状況が以前「AVAILABLE」に設定されていた場合にのみ使用できます。

メソッド

activate

 1 回限りのアイテムの特典を有効にします。

batchDelete

 1 回限りのアイテムの特典を 1 つ以上削除します。

batchGet

 1 回限りのアイテムの特典を 1 つ以上読み込みます。

batchUpdate

 1 回限りのアイテムの特典を 1 つ以上作成または更新します。

batchUpdateStates

 1 回限りのアイテムの特典の状態を一括で更新します。

cancel

 1 回限りのアイテムの特典をキャンセルします。

deactivate

 1 回限りのアイテムの特典を無効にします。

list

 特定のアプリ、アイテム、または購入オプションの全特典のリストを作成します。