REST Resource: loyaltyclass

{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "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),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}

string

リソースの種類を指定します。値: 固定文字列 "walletobjects#loyaltyClass"。

string

必須。プログラム名（「Adam's Apparel」など）。小さな画面でも文字列全体が表示されるように、アプリで最初の 20 文字の後に省略記号を表示できます。

object (Image)

必須。ポイント プログラムまたは会社のロゴ。このロゴは、アプリの詳細ビューとリストビューの両方に表示されます。

string

アカウント名のラベル（「会員名」など）。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。

string

アカウント ID のラベル（「メンバー ID」など）。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。

string

特典階層のラベル（「特典階層」など）。小さな画面でも文字列全体が表示されるように、9 文字以下にすることをおすすめします。

string

特典の階層（「ゴールド」、「プラチナ」など）。小さな画面でも文字列全体が表示されるように、7 文字以下にすることをおすすめします。

object (LocalizedString)

programName の翻訳文字列。小さな画面でも文字列全体が表示されるように、アプリで最初の 20 文字の後に省略記号を表示できます。

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

特典のサブ階層のラベル（「特典階層」など）。

object (LocalizedString)

secondaryRewardsTierLabel の翻訳文字列。

string

特典のサブ階層（「ゴールド」、「プラチナ」など）。

object (LocalizedString)

secondaryRewardsTier の翻訳文字列。

object (DiscoverableProgram)

Google Pay アプリ内でクラスが検出され、インスタンス化される方法。

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)

必須。クラスのステータス。このフィールドは、挿入、パッチ、更新の 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 と、オブジェクト レベルの smartTapRedemptionValue、barcode.value, oraccountId のいずれかのフィールドも正しく設定する必要があります。

string

カードの国を表示する（ユーザーがその国にいない場合）およびユーザーの言語 / 地域でコンテンツが利用できないときにローカライズされたコンテンツを表示するために使用される国コード。

object (Image)

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

object (Image)

サポート終了。

boolean

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

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 です。1 つのパスでは 10 のみが表示され、オブジェクトからのものが優先されます。