リソース: GiftCardClass
JSON 表現 |
---|
{ "kind": string, "merchantName": string, "programLogo": { object ( |
フィールド | |
---|---|
kind |
リソースの種類を指定します。値: 固定文字列 |
merchantName |
販売者名(「Adam's Apparel」など)。小さな画面でも文字列全体が表示されるように、最初の 20 文字の後に省略記号を表示できます。 |
programLogo |
ギフトカード プログラムまたは会社のロゴ。このロゴは、アプリの詳細ビューとリストビューの両方に表示されます。 |
pinLabel |
PIN について表示するラベル(「4 桁の PIN」など)。 |
eventNumberLabel |
イベント番号に対して表示するラベル(「ターゲット イベント #」など)。 |
allowBarcodeRedemption |
販売者がバーコードを使用したギフトカードの利用をサポートしているかどうかを指定します。true の場合、アプリの [Gift card details] 画面にギフトカードのバーコードが表示されます。false の場合、バーコードは表示されません。 |
localizedMerchantName |
MerchantName の翻訳文字列。小さな画面でも文字列全体が表示されるように、最初の 20 文字の後に省略記号を表示できます。 |
localizedPinLabel |
pinLabel の翻訳文字列。 |
localizedEventNumberLabel |
eventNumberLabel の翻訳文字列。 |
cardNumberLabel |
カード番号に表示するラベル(「カード番号」など)。 |
localizedCardNumberLabel |
cardNumberLabel の翻訳文字列。 |
classTemplateInfo |
クラスをどのように表示するかに関するテンプレート情報。設定しない場合、デフォルトのフィールド セットが表示されます。 |
id |
必須。クラスの一意の識別子。この ID は、発行者のすべてのクラスで一意である必要があります。この値は issuer ID の形式にする必要があります。identifier。前者は Google が発行し、後者は貴社が選択します。一意の識別子には、英数字、「.」、「_」、「-」のみを使用してください。 |
version |
非推奨 |
issuerName |
必須。発行者の名前。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。 |
messages[] |
アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受け取ります。これらのフィールドの最大数は 10 です。 |
allowMultipleUsersPerObject |
非推奨です。 |
homepageUri |
アプリケーションのホームページの URI。このフィールドに URI を設定すると、linksModuleData に URI を設定した場合の動作はまったく同じになります(オブジェクトがレンダリングされると、通常はオブジェクトの linksModuleData セクションと考えられる場所にホームページへのリンクが表示されます)。 |
locations[] |
注: 現在、このフィールドで位置情報通知をトリガーすることはサポートされていません。 |
reviewStatus |
必須。クラスのステータス。このフィールドは、insert、patch、または update 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 が指定されている場合は、代わりにそのオブジェクトが使用されます。 |
メソッド |
|
---|---|
|
指定されたクラス ID のギフトカード クラスにメッセージを追加します。 |
|
指定されたクラス ID のギフトカード クラスを返します。 |
|
指定された ID とプロパティのギフトカード クラスを挿入します。 |
|
指定された発行者 ID のすべてのギフトカード クラスのリストを返します。 |
|
指定されたクラス ID のギフトカード クラスを更新します。 |
|
指定されたクラス ID のギフトカード クラスを更新します。 |