REST Resource: offerclass

{
  "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)
    }
  ]
}

string

リソースの種類を示します。値は固定文字列 "walletobjects#offerClass" です。

string

必須。「T シャツ 20% オフ」などのクーポンのタイトル。小さな画面でも文字列全体が表示されるように、60 文字以下にすることをおすすめします。

enum (RedemptionChannel)

必須。このクーポンに適用可能なプロモーション利用チャネル。

string

必須。クーポンの提供元（アグリゲータ名または販売者名）。小さな画面でも文字列全体が表示されるように、12 文字以下にすることをおすすめします。

object (Image)

クーポンのタイトル画像。この画像は、アプリの詳細ビューとリストビューの両方に表示されます。

string

クーポンの詳細。

string

「Adam's Apparel で T シャツ 20% オフ」などのクーポン特典の注意事項や条件。

object (Uri)

クーポンのヘルプリンク（http://myownpersonaldomain.com/help など）

object (LocalizedString)

タイトルの翻訳文字列。小さな画面でも文字列全体が表示されるように、60 文字以下にすることをおすすめします。

object (LocalizedString)

プロバイダの翻訳文字列。小さな画面でも文字列全体が表示されるように、12 文字以下にすることをおすすめします。

object (LocalizedString)

詳細の翻訳文字列。

object (LocalizedString)

sensitivePrint の翻訳文字列。

string

クーポン タイトルの短縮バージョン（「20% オフ」など）。クーポンの内容がすぐにわかるようにユーザーに表示されます。20 文字以下にすることをおすすめします。

object (LocalizedString)

短いタイトルの翻訳文字列。20 文字以下にすることをおすすめします。

object (ClassTemplateInfo)

クラスの表示方法に関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。

string

必須。クラスの一意の識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier の形式にする必要があります。前の部分は Google が発行するものであり、後の部分はご自身で選択するものです。一意の識別子には、英数字、「.」、「_」、「-」のみを使用してください。

string (int64 format)

非推奨

string

必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。

object (Message)

アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。

boolean

非推奨です。multipleDevicesAndHoldersAllowedStatus を代わりに使用してください。

object (Uri)

アプリケーションのホームページの URI。このフィールドに URI を指定したときの動作は、linksModuleData に URI を指定したときの動作とまったく同じです（オブジェクトがレンダリングされると、通常はそのオブジェクトの linksModuleData セクションと考えられる場所にホームページのリンクが表示されます）。

object (LatLongPoint)

注: 現在、このフィールドはジオフェンス通知のトリガーには対応していません。

enum (ReviewStatus)

必須。クラスのステータス。このフィールドは、draft またはクラスの現在のステータスに設定できます。このフィールドは、insert、patch、または update API 呼び出しを使用して、draft または underReview に設定できます。レビュー ステータスが draft から変更されると、その後 draft に戻すことはできません。

クラスが開発中の場合は、このフィールドを draft のままにしてください。draft クラスはオブジェクトの作成には使用できません。

クラスを使用する準備ができている場合は、このフィールドを underReview に設定する必要があります。プラットフォームはこのフィールドを自動的に approved に設定し、オブジェクトの作成と移行にすぐに利用できるようにします。

すでに approved とマークされたクラスを更新する場合、このフィールドを underReview に設定しておく必要があります。

object (Review)

クラスが approved または rejected とマークされたときにプラットフォームによって設定されるレビュー コメント。

object (InfoModuleData)

非推奨です。代わりに textModulesData を使用してください。

object (ImageModuleData)

画像モジュールのデータ。表示されるフィールドの最大数は、オブジェクト レベルでは 1 個、クラス オブジェクト レベルでは 1 個です。

object (TextModuleData)

テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。

object (LinksModuleData)

リンク モジュールのデータ。リンク モジュールのデータがオブジェクトにも定義されている場合、両方が表示されます。

string (int64 format)

スマートタップ経由でパスを利用できるクーポン発行者を特定します。クーポン発行者は発行者 ID で識別されます。クーポン発行元には、少なくとも 1 つのスマートタップ キーが設定されている必要があります。

パスでスマートタップをサポートするには、enableSmartTap フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドを正しく設定することも必要です。

string

カードの国を表示するために使用される国コード（ユーザーがその国にいない場合）。あるいは、ユーザーのロケールでコンテンツが利用できない場合にローカライズされたコンテンツを表示するために使用される国コード。

object (Image)

カードの前面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% の幅で表示されます。

object (Image)

サポート終了。

boolean

このクラスがスマートタップをサポートするかどうかを指定します。パスでスマートタップをサポートするには、redemptionIssuers フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドも正しく設定する必要があります。

string

カードの背景色。設定されていない場合、ヒーロー画像の主要な色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要な色が使用されます。形式は #rrggbb です（#ffcc00 など）。rrggbb は 16 進数の RGB トリプレットです。#fc0 など、RGB トリプレットの省略形 #rgb も使用できます。

object (LocalizedString)

issuerName の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。

enum (MultipleDevicesAndHoldersAllowedStatus)

複数のユーザーやデバイスについて、このクラスを参照する同じオブジェクトを保存しているかどうかを示します。

object (CallbackOptions)

コールバック オプション。エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用します。このクラスのすべてのオブジェクトは、コールバックの対象となります。

object (SecurityAnimation)

セキュリティ アニメーションに関する情報（省略可）。設定すると、パスの詳細にセキュリティ アニメーションが表示されます。

enum (ViewUnlockRequirement)

特典のロック解除要件のオプションを表示します。

object (Image)

クーポンのワイドなタイトル画像。指定すると、カードビューの左上に表示されるタイトル画像の代わりに使用されます。

enum (NotificationSettingsForUpdates)

このクラスのフィールドの更新で通知をトリガーするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。指定しない場合、通知はトリガーされません。この設定は一時的な設定であり、PATCH リクエストまたは UPDATE リクエストごとに設定する必要があります。設定しない場合、通知はトリガーされません。

object (AppLinkData)

パスの表面にボタンとして表示される、アプリまたはウェブサイトのリンク（省略可）。対応するオブジェクトで AppLinkData が指定されている場合は、代わりにそのオブジェクトが使用されます。

object (ValueAddedModuleData)

オプションの付加価値モジュール データ。クラスあたりの最大数は 10 です。パスの場合は 10 個のみが表示され、オブジェクトのパスから優先的に表示されます。