このページは Cloud Translation API によって翻訳されました。

REST Resource: offerclass

リソース: OfferClass
- JSON 表現
- RedemptionChannel
メソッド

リソース: OfferClass

JSON 表現

JSON 表現
{ "kind": string, "title": string, "redemptionChannel": enum (`RedemptionChannel`), "provider": string, "titleImage": { object (`Image`) }, "details": string, "finePrint": string, "helpUri": { object (`Uri`) }, "localizedTitle": { object (`LocalizedString`) }, "localizedProvider": { object (`LocalizedString`) }, "localizedDetails": { object (`LocalizedString`) }, "localizedFinePrint": { object (`LocalizedString`) }, "shortTitle": string, "localizedShortTitle": { object (`LocalizedString`) }, "classTemplateInfo": { object (`ClassTemplateInfo`) }, "id": string, "version": string, "issuerName": string, "messages": [ { object (`Message`) } ], "allowMultipleUsersPerObject": boolean, "homepageUri": { object (`Uri`) }, "locations": [ { object (`LatLongPoint`) } ], "reviewStatus": enum (`ReviewStatus`), "review": { object (`Review`) }, "infoModuleData": { object (`InfoModuleData`) }, "imageModulesData": [ { object (`ImageModuleData`) } ], "textModulesData": [ { object (`TextModuleData`) } ], "linksModuleData": { object (`LinksModuleData`) }, "redemptionIssuers": [ string ], "countryCode": string, "heroImage": { object (`Image`) }, "wordMark": { object (`Image`) }, "enableSmartTap": boolean, "hexBackgroundColor": string, "localizedIssuerName": { object (`LocalizedString`) }, "multipleDevicesAndHoldersAllowedStatus": enum (`MultipleDevicesAndHoldersAllowedStatus`), "callbackOptions": { object (`CallbackOptions`) }, "securityAnimation": { object (`SecurityAnimation`) }, "viewUnlockRequirement": enum (`ViewUnlockRequirement`), "wideTitleImage": { object (`Image`) }, "notifyPreference": enum (`NotificationSettingsForUpdates`), "appLinkData": { object (`AppLinkData`) }, "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideTitleImage": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

フィールド
`kind (deprecated)`	`string` この項目は非推奨です。リソースの種類を示します。値は固定文字列 `"walletobjects#offerClass"` です。
`title`	`string` 必須。特典のタイトル（「T シャツすべて 20% オフ」など）。小さな画面でも文字列全体が表示されるように、60 文字以下にすることをおすすめします。
`redemptionChannel`	`enum (RedemptionChannel)` 必須。このクーポンに適用可能なプロモーション利用チャネル。
`provider`	`string` 必須。クーポンの提供元（アグリゲータ名または販売者名）。小さな画面でも文字列全体が表示されるように、12 文字以下にすることをおすすめします。
`titleImage`	`object (Image)` クーポンのタイトル画像。この画像は、アプリの詳細ビューとリストビューの両方に表示されます。
`details`	`string` クーポンの詳細。
`finePrint`	`string` 「Adam's Apparel で T シャツ 20% オフ」などのクーポン特典の注意事項や条件。
`helpUri`	`object (Uri)` クーポンのヘルプリンク（`http://myownpersonaldomain.com/help` など）
`localizedTitle`	`object (LocalizedString)` タイトルの翻訳文字列。小さな画面でも文字列全体が表示されるように、60 文字以下にすることをおすすめします。
`localizedProvider`	`object (LocalizedString)` プロバイダの翻訳文字列。小さな画面でも文字列全体が表示されるように、12 文字以下にすることをおすすめします。
`localizedDetails`	`object (LocalizedString)` 詳細の翻訳文字列。
`localizedFinePrint`	`object (LocalizedString)` finePrint の翻訳文字列。
`shortTitle`	`string` クーポンタイトルの短縮バージョン（「20% オフ」など）。クーポンの内容がすぐにわかるようにユーザーに表示されます。20 文字以下にすることをおすすめします。
`localizedShortTitle`	`object (LocalizedString)` 短いタイトルの翻訳文字列。推奨される最大文字数は 20 文字です。
`classTemplateInfo`	`object (ClassTemplateInfo)` クラスをどのように表示するかに関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。
`id`	`string` 必須。クラスの一意識別子。この ID は、発行者のすべてのクラスで一意である必要があります。この値は `issuer ID` の形式にする必要があります。`identifier`。前者は Google が発行し、後者は貴社が選択します。一意識別子には、英数字、「.」、「_」、「-」のみを使用できます。
`version (deprecated)`	`string (int64 format)` この項目は非推奨です。非推奨
`issuerName`	`string` 必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
`messages[]`	`object (Message)` アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受け取ります。このフィールドの最大数は 10 です。
`allowMultipleUsersPerObject (deprecated)`	`boolean` この項目は非推奨です。非推奨です。`multipleDevicesAndHoldersAllowedStatus` を代わりに使用してください。
`homepageUri`	`object (Uri)` アプリケーションのホームページの URI。このフィールドに URI を指定したときの動作は、linksModuleData に URI を指定したときの動作とまったく同じです（オブジェクトがレンダリングされると、通常はそのオブジェクトの linksModuleData セクションと考えられる場所にホームページのリンクが表示されます）。
`locations[] (deprecated)`	`object (LatLongPoint)` この項目は非推奨です。注: 現在、このフィールドはジオフェンス通知のトリガーには対応していません。
`reviewStatus`	`enum (ReviewStatus)` 必須。クラスのステータス。このフィールドは、`draft` またはクラスの現在のステータスに設定できます。このフィールドは、挿入、パッチ、更新の API 呼び出しを使用して `draft` または `underReview` に設定できます。レビューステータスが `draft` から変更されると、その後 `draft` に戻すことはできません。クラスが開発中の場合は、このフィールドを `draft` のままにしてください。`draft` クラスはオブジェクトの作成には使用できません。クラス使用の準備が整ったら、このフィールドを `underReview` に設定する必要があります。プラットフォームはこのフィールドを自動的に `approved` に設定し、オブジェクトの作成と移行にすぐに利用できるようにします。すでに `approved` とマークされたクラスを更新する場合、このフィールドを `underReview` に設定しておく必要があります。
`review`	`object (Review)` クラスが `approved` または `rejected` とマークされたときにプラットフォームによって設定されるレビューコメント。
`infoModuleData (deprecated)`	`object (InfoModuleData)` この項目は非推奨です。非推奨です。代わりに textModulesData を使用してください。
`imageModulesData[]`	`object (ImageModuleData)` 画像モジュールのデータ。表示されるフィールドの最大数は、オブジェクトレベルでは 1 個、クラスオブジェクトレベルでは 1 個です。
`textModulesData[]`	`object (TextModuleData)` テキストモジュールのデータ。テキストモジュールのデータがクラスにも定義されている場合、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。
`linksModuleData`	`object (LinksModuleData)` リンクモジュールのデータ。リンクモジュールのデータがオブジェクトにも定義されている場合、両方が表示されます。
`redemptionIssuers[]`	`string (int64 format)` スマートタップ経由でパスを利用できるクーポン発行者を特定します。クーポン発行者は発行者 ID で識別されます。クーポン発行元には、少なくとも 1 つのスマートタップキーが設定されている必要があります。パスでスマートタップをサポートするには、`enableSmartTap` フィールドとオブジェクトレベルの `smartTapRedemptionLevel` フィールドを正しく設定することも必要です。
`countryCode`	`string` カードの国を表示するために使用される国コード（ユーザーがその国にいない場合）。あるいは、ユーザーのロケールでコンテンツが利用できない場合にローカライズされたコンテンツを表示するために使用される国コード。
`heroImage`	`object (Image)` カードの表面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% 幅で表示されます。
`wordMark (deprecated)`	`object (Image)` この項目は非推奨です。サポート終了。
`enableSmartTap`	`boolean` このクラスがスマートタップをサポートしているかどうかを識別します。パスでスマートタップをサポートするには、`redemptionIssuers` フィールドとオブジェクトレベルの `smartTapRedemptionLevel` フィールドを正しく設定することも必要です。
`hexBackgroundColor`	`string` カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #`rrggbb` です（`#ffcc00` など）。`rrggbb` は 16 進数の RGB トリプレットです。`#fc0` など、RGB トリプレットの省略形 #`rgb` も使用できます。
`localizedIssuerName`	`object (LocalizedString)` issuerName の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
`multipleDevicesAndHoldersAllowedStatus`	`enum (MultipleDevicesAndHoldersAllowedStatus)` 複数のユーザーやデバイスについて、このクラスを参照する同じオブジェクトを保存しているかどうかを示します。
`callbackOptions`	`object (CallbackOptions)` コールバックオプション。エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用します。このクラスのすべてのオブジェクトは、コールバックの対象となります。
`securityAnimation`	`object (SecurityAnimation)` セキュリティアニメーションに関する情報（省略可）。設定すると、パスの詳細にセキュリティアニメーションが表示されます。
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` 特典のロック解除要件のオプションを表示します。
`wideTitleImage`	`object (Image)` クーポンのワイドタイトル画像。指定すると、カードビューの左上に表示されるタイトル画像の代わりに使用されます。
`notifyPreference`	`enum (NotificationSettingsForUpdates)` このクラスのフィールドの更新で通知をトリガーするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。指定しない場合、通知はトリガーされません。この設定は一時的な設定であり、PATCH リクエストまたは UPDATE リクエストごとに設定する必要があります。設定しない場合、通知はトリガーされません。
`appLinkData`	`object (AppLinkData)` パスの表面にボタンとして表示される、アプリまたはウェブサイトのリンク（省略可）。対応するオブジェクトに AppLinkData が指定されている場合は、代わりにそれが使用されます。
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` オプションの付加価値モジュールデータ。クラスあたりの最大数は 10 です。1 つのパスでは 10 のみが表示され、オブジェクトからのものが優先されます。

RedemptionChannel

列挙型
`REDEMPTION_CHANNEL_UNSPECIFIED`
`INSTORE`
`instore`	`INSTORE` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`ONLINE`
`online`	`ONLINE` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`BOTH`
`both`	`BOTH` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`TEMPORARY_PRICE_REDUCTION`
`temporaryPriceReduction`	`TEMPORARY_PRICE_REDUCTION` のレガシーエイリアス。サポート終了。この項目は非推奨です。

メソッド
`addmessage`	指定されたクラス ID のクーポンクラスにメッセージを追加します。
`get`	指定されたクラス ID のクーポンクラスを返します。
`insert`	指定された ID とプロパティのクーポンクラスを挿入します。
`list`	指定された発行者 ID のすべてのクーポンクラスのリストを返します。
`patch`	指定されたクラス ID のクーポンクラスを更新します。
`update`	指定されたクラス ID のクーポンクラスを更新します。

REST Resource: offerclass

リソース: OfferClass

RedemptionChannel

メソッド

`addmessage`

`get`

`insert`

`list`

`patch`

`update`