REST Resource: loyaltyclass

リソース: LoyaltyClass

JSON 表現 
{
  "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)
  }
}
フィールド
kind
(deprecated)

string

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

string

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

string

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

string

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

string

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

string

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

object (LocalizedString)

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

string

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

object (LocalizedString)

secondaryRewardsTierLabel の翻訳文字列。
secondaryRewardsTier

string

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

object (LocalizedString)

secondaryRewardsTier の翻訳文字列。
discoverableProgram

object (DiscoverableProgram)

Google Pay アプリ内でクラスを検出してインスタンス化する方法に関する情報。
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[]

object (LatLongPoint)

注: 現在、このフィールドは位置情報に関する通知のトリガーに対応していません。
reviewStatus

enum (ReviewStatus)

必須。クラスのステータス。このフィールドは、挿入、パッチ、更新の 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 個です。
redemptionIssuers[]

string (int64 format)

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

パスでスマートタップをサポートするには、enableSmartTap フィールドと、オブジェクト レベルの smartTapRedemptionValue フィールド、barcode.value, oraccountId フィールドも正しく設定する必要があります。
countryCode

string

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

object (Image)

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

object (Image)

廃止されました。
enableSmartTap

boolean

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

string

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

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

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

DiscoverableProgram

Android Pay アプリ内でクラスを検出してインスタンス化する方法に関する情報。ポイント プログラムまたはギフトカード プログラムを検索してスキャンするか、手動で入力します。

JSON 表現 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
フィールド
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

販売者のサイトからこのプログラムに登録し、貴重な情報を提供できること。MERCHANT_HOSTED_SIGNUP が有効な場合に使用します。
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

販売者のサイトからこのプログラムにログインして価値ある情報を追加できるかどうかに関する情報。MERCHANT_HOSTED_SIGNIN が有効な場合に使用されます。
state

enum (State)

検出可能なプログラムの可視性状態。

DiscoverableProgramMerchantSignupInfo

販売者がホストするプログラムへの登録フローに関する情報。

JSON 表現 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
フィールド
signupWebsite

object (Uri)

販売者の登録サイトにユーザーを誘導する URL。
signupSharedDatas[]

enum (SharedDataType)

登録ウェブサイトの URL への POST リクエストで送信されるユーザーデータ。この情報はエンコードされて共有され、検出可能なプログラムへのユーザー登録に使用されるフィールドを販売者のウェブサイトで事前入力できるようになります。

SharedDataType

列挙型
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS 単一行の住所フィールド
ADDRESS_LINE_1 複数行の住所フィールド
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

販売者がホストするプログラムのログインフローに関する情報です。

JSON 表現 
{
  "signinWebsite": {
    object (Uri)
  }
}
フィールド
signinWebsite

object (Uri)

ユーザーを販売者のログインサイトに誘導する URL です。

状態

列挙型
STATE_UNSPECIFIED
TRUSTED_TESTERS 発行者アカウントにアクセスできるテスターにのみ表示されます。
trustedTesters

TRUSTED_TESTERS のレガシー エイリアス。廃止されました。
LIVE すべてのユーザーに表示。
live

LIVE のレガシー エイリアス。廃止されました。
DISABLED 非表示。
disabled

DISABLED のレガシー エイリアス。廃止されました。

Methods

addmessage

 指定されたクラス ID のポイントクラスにメッセージを追加します。

get

 指定されたクラス ID のポイントクラスを返します。

insert

 指定された ID とプロパティのポイントクラスを挿入します。

list

 指定された発行者 ID のすべてのポイントクラスのリストを返します。

patch

 指定されたクラス ID のポイントクラスを更新します。

update

 指定されたクラス ID のポイントクラスを更新します。