リソース: LoyaltyClass
JSON 表現 |
---|
{ "kind": string, "programName": string, "programLogo": { object ( |
フィールド | |
---|---|
kind |
リソースの種類を示します。値は固定文字列 |
program |
必須。プログラム名(「Adam's Apparel」など)。小さな画面でも文字列全体が表示されるように、アプリで最初の 20 文字の後に省略記号を表示できます。 |
program |
必須。ポイント プログラムまたは会社のロゴ。このロゴは、アプリの詳細ビューとリストビューの両方に表示されます。 |
account |
アカウント名のラベル(「メンバー名」など)。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
account |
アカウント ID のラベル(「メンバー ID」など)。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
rewards |
特典階層のラベル(「特典階層」など)。小さな画面でも文字列全体が表示されるように、9 文字以下にすることをおすすめします。 |
rewards |
特典階層(「ゴールド」、「プラチナ」など)。小さな画面でも文字列全体が表示されるように、7 文字以下にすることをおすすめします。 |
localized |
programName の翻訳文字列。小さな画面でも文字列全体が表示されるように、アプリで最初の 20 文字の後に省略記号を表示できます。 |
localized |
accountNameLabel の翻訳文字列。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
localized |
accountIdLabel の翻訳文字列。小さな画面でも文字列全体が表示されるように、15 文字以下にすることをおすすめします。 |
localized |
rewardsTierLabel の翻訳文字列。小さな画面でも文字列全体が表示されるように、9 文字以下にすることをおすすめします。 |
localized |
RewardsTier の翻訳文字列。小さな画面でも文字列全体が表示されるように、7 文字以下にすることをおすすめします。 |
secondary |
特典のサブ階層のラベル(「特典階層」など)。 |
localized |
secondaryRewardsTierLabel の翻訳文字列。 |
secondary |
特典のサブ階層(「ゴールド」、「プラチナ」など)。 |
localized |
secondaryRewardsTier の翻訳文字列。 |
discoverable |
Google Pay アプリ内でクラスが検出され、インスタンス化される方法。 |
class |
クラスをどのように表示するかに関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。 |
id |
必須。クラスの一意の識別子。この ID は、発行者のすべてのクラスに対して、一意である必要があります。この値には issuer ID.identifier。前者は Google が発行し、後者は貴社が選択します。一意の識別子には、英数字、「.」、「_」、「-」のみを使用してください。 |
version |
非推奨 |
issuer |
必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受信します。このフィールドの最大数は 10 です。 |
allowMultipleUsersPerObject |
非推奨です。 |
homepage |
アプリケーションのホームページの URI。このフィールドに URI を指定したときの動作は、linksModuleData に URI を指定したときの動作とまったく同じです(オブジェクトがレンダリングされると、通常はそのオブジェクトの linksModuleData セクションと考えられる場所にホームページのリンクが表示されます)。 |
locations[] |
注: 現在、このフィールドはジオフェンス通知のトリガーには対応していません。 |
review |
必須。クラスのステータス。このフィールドは、挿入、パッチ、更新の API 呼び出しを使用して クラスが開発中の場合は、このフィールドを クラスを使用する準備ができている場合は、このフィールドを すでに |
review |
クラスが |
infoModuleData |
非推奨です。代わりに textModulesData を使用してください。 |
image |
画像モジュール データ。このフィールドが表示される数には上限があり、オブジェクト レベルから 1 個、クラス オブジェクト レベルでは 1 個が最大数になります。 |
text |
テキスト モジュールのデータ。テキスト モジュールのデータがクラスにも定義されている場合、両方が表示されます。このフィールドが表示される数には上限があり、オブジェクトから 10 個、クラスから 10 個が最大数になります。 |
links |
リンク モジュールのデータ。リンク モジュールのデータもオブジェクトで定義されている場合は、両方が表示されます。 |
redemption |
スマートタップ経由でパスを利用できるクーポン発行者を特定します。クーポン発行者は発行者 ID で識別されます。クーポン発行者はスマートタップキーを 1 つ以上構成している必要があります。 パスがスマートタップをサポートするには、 |
country |
カードの国を表示する(ユーザーがその国にいない場合)およびユーザーの言語 / 地域でコンテンツが利用できないときにローカライズされたコンテンツを表示するために使用される国コード。 |
hero |
カードの表面に表示されるオプションのバナー画像。バナー画像がない場合は、何も表示されません。画像は 100% の幅で表示されます。 |
wordMark |
サポート終了。 |
enable |
このクラスがスマートタップをサポートしているかどうかを識別します。パスがスマートタップをサポートするには、 |
hex |
カードの背景色。設定されていない場合は、ヒーロー画像の主要色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要色が使用されます。形式は #rrggbb です。ここで、rrggbb は 16 進数の RGB トリプレットです(例: |
localized |
issuerName の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
multiple |
複数のユーザーやデバイスについて、このクラスを参照する同じオブジェクトを保存しているかどうかを示します。 |
callback |
エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用するコールバック オプション。このクラスのすべてのオブジェクトは、コールバックの対象となります。 |
security |
セキュリティ アニメーションに関する情報(省略可)。設定すると、パスの詳細にセキュリティ アニメーションが表示されます。 |
view |
ポイントカードのロック解除要件のオプションを表示します。 |
wide |
ポイント プログラムまたは会社のワイド ロゴ。指定すると、カードビューの左上にあるプログラムロゴの代わりに使用されます。 |
notify |
このクラスのフィールドの更新で通知をトリガーするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。指定しない場合、通知はトリガーされません。この設定は一時的なものであり、PATCH または UPDATE リクエストごとに設定する必要があります。設定しない場合は通知がトリガーされません。 |
app |
パスの表面にボタンとして表示される、アプリまたはウェブサイトのリンク(省略可)。対応するオブジェクトで AppLinkData が指定されている場合は、代わりにそのオブジェクトが使用されます。 |
value |
オプションの付加価値モジュール データ。クラスあたりの最大数は 10 です。パスの場合は 10 個のみが表示され、オブジェクトのパスから優先的に表示されます。 |
DiscoverableProgram
Android Pay アプリ内でクラスが検出され、インスタンス化される方法の詳細。これは、ポイント プログラムまたはギフトカード プログラムを検索し、スキャンするか、手動で入力することによって行います。
JSON 表現 |
---|
{ "merchantSignupInfo": { object ( |
フィールド | |
---|---|
merchant |
販売店のサイトからこのプログラムに登録し、貴重な情報を提供できるかどうか。MERCHANT_HOSTED_SIGNUP が有効な場合に使用します。 |
merchant |
販売店のサイトからこのプログラムにログインし、貴重な情報を提供できるかどうか。MERCHANT_HOSTED_SIGNIN が有効な場合に使用します。 |
state |
検出可能なプログラムの可視性状態。 |
DiscoverableProgramMerchantSignupInfo
販売者がホストするプログラムの登録フローに関する情報。
JSON 表現 |
---|
{ "signupWebsite": { object ( |
フィールド | |
---|---|
signup |
販売店の登録サイトにユーザーを誘導する URL。 |
signup |
POST リクエストで登録サイトの URL に送信されるユーザーデータ。この情報は、エンコードされて共有されます。販売店のサイトでは、検出可能なプログラムのユーザー登録で、この情報が事前に入力されます。 |
DiscoverableProgramMerchantSigninInfo
販売者がホストするプログラムのログインフローに関する情報。
JSON 表現 |
---|
{
"signinWebsite": {
object ( |
フィールド | |
---|---|
signin |
販売店のログインサイトにユーザーを誘導する URL。 |
州
列挙型 | |
---|---|
STATE_UNSPECIFIED |
|
TRUSTED_TESTERS |
発行者アカウントにアクセスできるテスターにのみ表示されます。 |
trustedTesters |
|
LIVE |
全員に表示されます。 |
live |
|
DISABLED |
表示されません。 |
disabled |
|
メソッド |
|
---|---|
|
指定されたクラス ID のポイントクラスにメッセージを追加します。 |
|
指定されたクラス ID のポイントクラスを返します。 |
|
指定された ID とプロパティのポイントクラスを挿入します。 |
|
指定された発行者 ID のすべてのポイントクラスのリストを返します。 |
|
指定されたクラス ID のポイントクラスを更新します。 |
|
指定されたクラス ID のポイントクラスを更新します。 |