このページは Cloud Translation API によって翻訳されました。

REST Resource: giftcardclass

リソース: GiftCardClass
- JSON 表現
メソッド

リソース: GiftCardClass

JSON 表現

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`) }, "notifyPreference": enum (`NotificationSettingsForUpdates`), "appLinkData": { object (`AppLinkData`) }, "valueAddedModuleData": [ { object (`ValueAddedModuleData`) } ] }

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

フィールド
`kind (deprecated)`	`string` この項目は非推奨です。リソースの種類を示します。値は固定文字列 `"walletobjects#giftCardClass"` です。
`merchantName`	`string` 販売者名（「Adam's Apparel」など）。小さな画面でも文字列全体が表示されるように、最初の 20 文字の後に省略記号を表示できます。
`programLogo`	`object (Image)` ギフトカードのプログラムまたは会社のロゴ。このロゴは、アプリの詳細ビューとリストビューの両方に表示されます。
`pinLabel`	`string` PIN について表示するラベル（「4 桁の PIN」など）。
`eventNumberLabel`	`string` イベント番号について表示するラベル（「対象イベント #」など）。
`allowBarcodeRedemption`	`boolean` バーコードを使用したギフトカードの利用をサポートするかどうかを決定します。true の場合、アプリでギフトカード情報画面にギフトカードのバーコードが表示されます。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[] (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 個が最大数になります。
`linksModuleData`	`object (LinksModuleData)` リンクモジュールのデータ。リンクモジュールのデータがオブジェクトにも定義されている場合、両方が表示されます。
`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` です（`#ffcc00` など）。`rrggbb` は 16 進数の RGB トリプレットです。`#fc0` など、RGB トリプレットの省略形も使用できます。`rgb`
`localizedIssuerName`	`object (LocalizedString)` IssuerName の翻訳文字列。小さな画面でも文字列全体が表示されるように、20 文字以下にすることをおすすめします。
`multipleDevicesAndHoldersAllowedStatus`	`enum (MultipleDevicesAndHoldersAllowedStatus)` 複数のユーザーやデバイスについて、このクラスを参照する同じオブジェクトを保存しているかどうかを示します。
`callbackOptions`	`object (CallbackOptions)` エンドユーザーがこのクラスのオブジェクトを保存または削除するたびに発行者をコールバックするために使用するコールバックオプション。このクラスのすべてのオブジェクトは、コールバックの対象となります。
`securityAnimation`	`object (SecurityAnimation)` セキュリティアニメーションに関する情報（省略可）。これが設定されている場合、パスの詳細にセキュリティアニメーションがレンダリングされます。
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` ギフトカードのロック解除要件のオプションを表示します。
`wideProgramLogo`	`object (Image)` ギフトカードのプログラムまたは会社のワイドロゴ。指定すると、カードビューの左上に表示されるプログラムのロゴの代わりに使用されます。
`notifyPreference`	`enum (NotificationSettingsForUpdates)` このクラスのフィールドの更新で通知をトリガーするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。指定しない場合、通知はトリガーされません。この設定は一時的なものであり、PATCH または UPDATE リクエストごとに設定する必要があります。設定しない場合は通知がトリガーされません。
`appLinkData`	`object (AppLinkData)` アプリまたはウェブサイトへのリンク。パスの前面にボタンとして表示されるオプションです。対応するオブジェクトに AppLinkData が指定されている場合は、代わりにそれが使用されます。
`valueAddedModuleData[]`	`object (ValueAddedModuleData)` オプションの付加価値モジュールデータ。クラスは最大 10 名まで参加できます。パスの場合は 10 個のみが表示され、オブジェクトのパスから優先的に表示されます。

メソッド
`addmessage`	指定されたクラス ID のギフトカードクラスにメッセージを追加します。
`get`	指定されたクラス ID のギフトカードクラスを返します。
`insert`	指定された ID とプロパティのギフトカードクラスを挿入します。
`list`	指定された発行者 ID のすべてのギフトカードクラスのリストを返します。
`patch`	指定されたクラス ID のギフトカードクラスを更新します。
`update`	指定されたクラス ID のギフトカードクラスを更新します。

REST Resource: giftcardclass

リソース: GiftCardClass

メソッド

`addmessage`

`get`

`insert`

`list`

`patch`

`update`