リソース: LoyaltyClass
JSON 表現 |
---|
{ "kind": string, "programName": string, "programLogo": { object ( |
フィールド | |
---|---|
kind |
リソースの種類を指定します。値: 固定文字列 |
programName |
必須。プログラム名(「Adam's Apparel」など)。小さな画面でも文字列全体が表示されるように、最初の 20 文字の後に省略記号を表示することがあります。 |
programLogo |
必須。ポイント プログラムまたは会社のロゴ。このロゴは、アプリの詳細ビューとリストビューの両方に表示されます。 |
accountNameLabel |
アカウント名のラベル(「メンバー名」など)。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
accountIdLabel |
アカウント ID のラベル(「メンバー ID」など)。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
rewardsTierLabel |
特典階層のラベル(「特典階層」など)。小さな画面でも文字列全体が表示されるように、9 文字以下にすることをおすすめします。 |
rewardsTier |
特典階層(「ゴールド」や「プラチナ」など)。小さな画面でも文字列全体が表示されるように、7 文字以下にすることをおすすめします。 |
localizedProgramName |
programName の翻訳文字列。小さな画面でも文字列全体が表示されるように、最初の 20 文字の後に省略記号を表示することがあります。 |
localizedAccountNameLabel |
accountNameLabel の翻訳文字列。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
localizedAccountIdLabel |
accountIdLabel の翻訳文字列。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
localizedRewardsTierLabel |
RewardsTierLabel の翻訳文字列。小さな画面でも文字列全体が表示されるように、9 文字以下にすることをおすすめします。 |
localizedRewardsTier |
RewardsTier の翻訳文字列。小さな画面でも文字列全体が表示されるように、7 文字以下にすることをおすすめします。 |
secondaryRewardsTierLabel |
特典のサブ階層のラベル(「特典階層」など)。 |
localizedSecondaryRewardsTierLabel |
secondaryRewardsTierLabel の翻訳文字列。 |
secondaryRewardsTier |
特典のサブ階層(「ゴールド」や「プラチナ」など)。 |
localizedSecondaryRewardsTier |
secondaryRewardsTier の翻訳文字列。 |
discoverableProgram |
Google Pay アプリ内でクラスを検出してインスタンス化する方法に関する情報。 |
classTemplateInfo |
クラスの表示方法に関するテンプレート情報。設定しない場合、表示されるデフォルトのフィールド セットにフォールバックします。 |
id |
必須。クラスの一意の識別子。この ID は、発行者のすべてのクラスに対して一意である必要があります。この値は issuer ID の形式にする必要があります。identifier: 前者は Google が発行し、後者はユーザーが選択したものです。一意の識別子には、英数字、「.」、「_」、「-」のみを使用できます。 |
version |
非推奨 |
issuerName |
必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。これらのフィールドの最大数は 10 です。 |
allowMultipleUsersPerObject |
非推奨です。 |
homepageUri |
アプリケーションのホームページの URI。このフィールドに URI を設定すると、linksModuleData に URI を入力する場合とまったく同じ動作になります(オブジェクトがレンダリングされると、通常そのオブジェクトの linksModuleData セクションと考えられる場所にホームページへのリンクが表示されます)。 |
locations[] |
注: 現在、このフィールドは位置情報に関する通知のトリガーに対応していません。 |
reviewStatus |
必須。クラスのステータス。このフィールドは、挿入、パッチ、更新の API 呼び出しを使用して クラスが開発中の場合は、このフィールドを クラスを使用する準備ができたら、このフィールドを すでに |
review |
クラスが |
infoModuleData |
非推奨です。代わりに textModulesData を使用してください。 |
imageModulesData[] |
画像モジュールのデータ。表示されるこれらのフィールドの最大数は、オブジェクト レベルで 1 個、クラス オブジェクト レベルで 1 個です。 |
textModulesData[] |
テキスト モジュールのデータ。テキスト モジュール データもクラスで定義されている場合は、両方が表示されます。表示されるこれらのフィールドの最大数は、オブジェクトから 10 個、クラスから 10 個です。 |
linksModuleData |
リンク モジュールのデータ。リンク モジュールのデータがオブジェクトにも定義されている場合は、両方が表示されます。 |
redemptionIssuers[] |
スマートタップでパスを利用できるクーポン発行者を識別します。クーポン発行者は発行者 ID で識別されます。クーポン発行者には、少なくとも 1 つのスマートタップ キーが設定されている必要があります。 パスでスマートタップをサポートするには、 |
countryCode |
カードの国を表示するために使用される国コード(ユーザーがその国にいない場合)。また、ユーザーのロケールでコンテンツが利用できない場合に、ローカライズされたコンテンツを表示するために使用される国コード。 |
heroImage |
カードの表面に表示されるオプションのバナー画像。存在しない場合は、何も表示されません。画像は 100% の幅で表示されます。 |
wordMark |
廃止されました。 |
enableSmartTap |
このクラスがスマートタップをサポートしているかどうかを指定します。パスでスマートタップをサポートするには、 |
hexBackgroundColor |
カードの背景色。設定しない場合、ヒーロー画像のドミナント カラーが使用されます。ヒーロー画像が設定されていない場合は、ロゴのドミナント カラーが使用されます。形式は #rrggbb です。ここで、rrggbb は 16 進数の RGB トリプレットです(例: |
localizedIssuerName |
IssuerName の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
multipleDevicesAndHoldersAllowedStatus |
このクラスを参照する同じオブジェクトを複数のユーザーとデバイスで保存するかどうかを指定します。 |
callbackOptions |
エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに、発行元をコールバックするために使用するコールバック オプション。このクラスのすべてのオブジェクトはコールバックの対象となります。 |
securityAnimation |
セキュリティ アニメーションに関する省略可能な情報。これが設定されている場合、セキュリティ アニメーションがパスの詳細にレンダリングされます。 |
viewUnlockRequirement |
ポイントカードのロック解除要件のオプションを表示します。 |
wideProgramLogo |
ポイント プログラムまたは会社のワイドロゴ。指定すると、カードビューの左上のプログラムロゴの代わりに使用されます。 |
appLinkData |
パスの前面にボタンとして表示される、省略可能なアプリまたはウェブサイトのリンク。代わりに使用される対応オブジェクトに AppLinkData が指定されている場合。 |
DiscoverableProgram
Android Pay アプリ内でクラスを検出してインスタンス化する方法に関する情報。ポイント プログラムまたはギフトカード プログラムを検索してスキャンするか、手動で入力します。
JSON 表現 |
---|
{ "merchantSignupInfo": { object ( |
フィールド | |
---|---|
merchantSignupInfo |
販売者のサイトからこのプログラムに登録し、貴重な情報を提供できること。MERCHANT_HOSTED_SIGNUP が有効な場合に使用します。 |
merchantSigninInfo |
販売者のサイトからこのプログラムにログインして価値ある情報を追加できるかどうかに関する情報。MERCHANT_HOSTED_SIGNIN が有効な場合に使用されます。 |
state |
検出可能なプログラムの可視性状態。 |
DiscoverableProgramMerchantSignupInfo
販売者がホストするプログラムへの登録フローに関する情報。
JSON 表現 |
---|
{ "signupWebsite": { object ( |
フィールド | |
---|---|
signupWebsite |
販売者の登録サイトにユーザーを誘導する URL。 |
signupSharedDatas[] |
登録ウェブサイトの URL への POST リクエストで送信されるユーザーデータ。この情報はエンコードされて共有され、検出可能なプログラムへのユーザー登録に使用されるフィールドを販売者のウェブサイトで事前入力できるようになります。 |
DiscoverableProgramMerchantSigninInfo
販売者がホストするプログラムのログインフローに関する情報です。
JSON 表現 |
---|
{
"signinWebsite": {
object ( |
フィールド | |
---|---|
signinWebsite |
ユーザーを販売者のログインサイトに誘導する URL です。 |
状態
列挙型 | |
---|---|
STATE_UNSPECIFIED |
|
TRUSTED_TESTERS |
発行者アカウントにアクセスできるテスターにのみ表示されます。 |
trustedTesters |
|
LIVE |
すべてのユーザーに表示。 |
live |
|
DISABLED |
非表示。 |
disabled |
|
メソッド |
|
---|---|
|
指定されたクラス ID のポイントクラスにメッセージを追加します。 |
|
指定されたクラス ID のポイントクラスを返します。 |
|
指定された ID とプロパティのポイントクラスを挿入します。 |
|
指定された発行者 ID のすべてのポイントクラスのリストを返します。 |
|
指定されたクラス ID のポイントクラスを更新します。 |
|
指定されたクラス ID のポイントクラスを更新します。 |