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)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
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[]
(deprecated)

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 です（#ffcc00 など）。rrggbb は 16 進数の RGB トリプレットです。#fc0 など、RGB トリプレットの省略形 #rgb も使用できます。
localizedIssuerName

object (LocalizedString)

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

enum (MultipleDevicesAndHoldersAllowedStatus)

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

object (CallbackOptions)

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

object (SecurityAnimation)

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

enum (ViewUnlockRequirement)

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

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

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

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)

POST リクエストで登録サイトの URL に送信されるユーザーデータ。この情報は、エンコードされて共有されます。販売店のサイトでは、検出可能なプログラムのユーザー登録で、この情報が事前に入力されます。

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 のレガシー エイリアス。サポート終了。

メソッド

addmessage

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

get

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

insert

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

list

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

patch

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

update

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