REST Resource: giftcardclass

リソース: GiftCardClass

JSON 表現 
{
  "kind": string,
  "merchantName": string,
  "programLogo": {
    object (Image)
  },
  "pinLabel": string,
  "eventNumberLabel": string,
  "allowBarcodeRedemption": boolean,
  "localizedMerchantName": {
    object (LocalizedString)
  },
  "localizedPinLabel": {
    object (LocalizedString)
  },
  "localizedEventNumberLabel": {
    object (LocalizedString)
  },
  "cardNumberLabel": string,
  "localizedCardNumberLabel": {
    object (LocalizedString)
  },
  "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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}
フィールド
kind
(deprecated)

string

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

string

販売者名（「Adam's Apparel」など）。小さな画面でも文字列全体が表示されるように、最初の 20 文字の後に省略記号を表示できます。
pinLabel

string

PIN について表示するラベル（「4 桁の PIN」など）。
eventNumberLabel

string

イベント番号に対して表示するラベル（「ターゲット イベント #」など）。
allowBarcodeRedemption

boolean

販売者がバーコードを使用したギフトカードの利用をサポートしているかどうかを指定します。true の場合、アプリの [Gift card details] 画面にギフトカードのバーコードが表示されます。false の場合、バーコードは表示されません。
localizedMerchantName

object (LocalizedString)

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

object (LocalizedString)

pinLabel の翻訳文字列。
localizedEventNumberLabel

object (LocalizedString)

eventNumberLabel の翻訳文字列。
cardNumberLabel

string

カード番号に表示するラベル（「カード番号」など）。
localizedCardNumberLabel

object (LocalizedString)

cardNumberLabel の翻訳文字列。
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)

必須。クラスのステータス。このフィールドは、insert、patch、または update 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 フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドを正しく設定することも必要です。
countryCode

string

カードの国を表示する（ユーザーがその国にいない場合）およびユーザーの言語 / 地域でコンテンツが利用できないときにローカライズされたコンテンツを表示するために使用される国コード。
heroImage

object (Image)

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

object (Image)

サポート終了。
enableSmartTap

boolean

このクラスがスマートタップをサポートしているかどうかを指定します。パスでスマートタップをサポートするには、redemptionIssuers フィールドとオブジェクト レベルの smartTapRedemptionLevel フィールドを正しく設定することも必要です。
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)

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

メソッド

addmessage

 指定されたクラス ID のギフトカード クラスにメッセージを追加します。

get

 指定されたクラス ID のギフトカード クラスを返します。

insert

 指定された ID とプロパティのギフトカード クラスを挿入します。

list

 指定された発行者 ID のすべてのギフトカード クラスのリストを返します。

patch

 指定されたクラス ID のギフトカード クラスを更新します。

update

 指定されたクラス ID のギフトカード クラスを更新します。