Offer

ユーザーに提供される特典のデータプランの詳細。

JSON 表現
{
  "planName": string,
  "planId": string,
  "planDescription": string,
  "promoMessage": string,
  "overusagePolicy": enum (OverUsagePolicy),
  "maxRateKbps": string,
  "cost": {
    object (Money)
  },
  "duration": string,
  "offerContext": string,
  "trafficCategories": [
    enum (PlanModuleTrafficCategory)
  ],
  "connectionType": enum (ConnectionType),
  "refreshPeriod": enum (RefreshPeriod),
  "offerType": enum (OfferType),

  // Union field quota can be only one of the following:
  "quotaBytes": string,
  "quotaMinutes": integer
  // End of list of possible types for union field quota.
}
フィールド
planName

string

必須。ユーザーへの特典を識別する文字列。

planId

string

必須。オファーを一意に識別して、ユーザーが希望する場合は購入に使用できる固有の文字列です。

planDescription

string

必須。ユーザーに特典を説明する長い文字列。

promoMessage

string

プロモーションを説明する文字列。

overusagePolicy

enum (OverUsagePolicy)

指定された量を超える量のメールをユーザーが最終的に使用する場合に、どうするかを決定します。現在サポートされているオプションは、スロットル、ブロック、従量課金制で、ユーザー アカウントから残高を差し引きます。

maxRateKbps

string (int64 format)

プランがユーザーに提供する最大帯域幅。特典が提示される際に、ユーザーに情報が提示されることがあります。

cost

object (Money)

必須。このプランの費用。

duration

string (Duration format)

プランがアクティブになった後に、プランが有効な秒数。

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

offerContext

string

特典リクエストのコンテキスト。TransactionRequest メッセージで使用されます。

trafficCategories[]

enum (PlanModuleTrafficCategory)

このプランのモジュールに対して課金されるトラフィック カテゴリのリスト。

connectionType

enum (ConnectionType)

この特典の一環として拡張された接続タイプ。

refreshPeriod

enum (RefreshPeriod)

このプランの特典の更新期間、またはプランが割り当てを更新しない場合は REFRESH_PERIOD_NONE。割り当てを更新するプランは、更新期間ごとに 1 回行われます。

offerType

enum (OfferType)

特典の種類を特定する。特典の種類に応じて、特典のユーザー エクスペリエンスはカスタマイズできます。

共用体フィールド quota。プランの割り当て情報。quota_bytes、quota_minutes のいずれかにする必要があります。quota は次のいずれかになります。
quotaBytes

string (int64 format)

パッケージの割り当て(バイト単位)。

quotaMinutes

integer

パッケージの割り当て(分単位)。