REST Resource: offerclass

リソース: OfferClass

JSON 表現 
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    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),
  "wideTitleImage": {
    object (Image)
  }
}
フィールド
kind
(deprecated)

string

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

string

必須。特典のタイトル（「T シャツ 20% オフ」など）。小さな画面でも文字列全体が表示されるように、60 文字以下にすることをおすすめします。
redemptionChannel

enum (RedemptionChannel)

必須。この特典に適用されるクーポン利用チャネル。
provider

string

必須。オファーのプロバイダ（アグリゲータ名または販売者名）。小さな画面でも文字列全体が表示されるように、12 文字以下にすることをおすすめします。
titleImage

object (Image)

特典のタイトル画像。この画像は、アプリの詳細ビューとリストビューの両方に表示されます。
details

string

オファーの詳細。
finePrint

string

「Adam's Apparel の T シャツが 20% オフ」など、特典の注意事項や条件。
helpUri

object (Uri)

特典のヘルプリンク（例: http://myownpersonaldomain.com/help）
localizedTitle

object (LocalizedString)

タイトルの翻訳文字列。小さな画面でも文字列全体が表示されるように、60 文字以下にすることをおすすめします。
localizedProvider

object (LocalizedString)

プロバイダの翻訳文字列。小さな画面でも文字列全体が表示されるように、12 文字以下にすることをおすすめします。
localizedDetails

object (LocalizedString)

詳細の翻訳文字列。
localizedFinePrint

object (LocalizedString)

FinPrint の翻訳文字列。
shortTitle

string

特典のタイトルの短縮版（「20% オフ」など）は、特典の内容にすばやく触れられるようにユーザーに表示されます。推奨される最大文字数は 20 文字です。
localizedShortTitle

object (LocalizedString)

短いタイトルの翻訳文字列。推奨される最大文字数は 20 文字です。
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)

必須。クラスのステータス。このフィールドは、draft またはクラスのステータスに設定できます。このフィールドは、挿入、パッチ、更新の 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)

特典のロック解除要件のオプションを表示します。
wideTitleImage

object (Image)

商品情報のワイドなタイトル画像。指定すると、カードビューの左上にあるタイトル画像の代わりに使用されます。

RedemptionChannel

列挙型
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

INSTORE のレガシー エイリアス。廃止されました。
ONLINE
online

ONLINE のレガシー エイリアス。廃止されました。
BOTH
both

BOTH のレガシー エイリアス。廃止されました。
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

TEMPORARY_PRICE_REDUCTION のレガシー エイリアス。廃止されました。

Methods

addmessage

 指定されたクラス ID のクーポンクラスにメッセージを追加します。

get

 指定されたクラス ID のクーポンクラスを返します。

insert

 指定された ID とプロパティのクーポンクラスを挿入します。

list

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

patch

 指定されたクラス ID のクーポンクラスを更新します。

update

 指定されたクラス ID のクーポンクラスを更新します。