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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}

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)

binaryRewardsTierLabel の翻訳文字列。

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)

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

string

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

object (Image)

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

object (Image)

サポート終了。

boolean

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

string

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

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

このクラスを参照する同じオブジェクトを複数のユーザーとデバイスが保存するかどうかを指定します。

object (CallbackOptions)

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

object (SecurityAnimation)

セキュリティ アニメーションに関するオプションの情報。これが設定されている場合、パスの詳細にセキュリティ アニメーションがレンダリングされます。

enum (ViewUnlockRequirement)

ポイントカードのロック解除要件オプションを表示します。

object (Image)

ポイント プログラムまたは会社のワイドロゴ。指定すると、カードビューの左上にあるプログラムロゴの代わりに使用されます。

object (AppLinkData)

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