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

REST Resource: offerclass

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

リソース: OfferClass

JSON 表現

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`) }, "appLinkData": { object (`AppLinkData`) } }

{
  "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)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}

フィールド
`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)` sensitivePrint の翻訳文字列。
`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` またはクラスのステータスを設定できます。このフィールドは、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 個です。
`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` です。ここで、`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)` クーポンのワイドなタイトル画像。指定すると、カードビューの左上にあるタイトル画像の代わりに使用されます。
`appLinkData`	`object (AppLinkData)` アプリまたはウェブサイトへのリンク。パスの前面にボタンとして表示されるオプションです。対応するオブジェクトで AppLinkData が指定されている場合は、代わりにそのオブジェクトが使用されます。

RedemptionChannel

列挙型
`REDEMPTION_CHANNEL_UNSPECIFIED`
`INSTORE`
`instore`	`INSTORE` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`ONLINE`
`online`	`ONLINE` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`BOTH`
`both`	`BOTH` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`TEMPORARY_PRICE_REDUCTION`
`temporaryPriceReduction`	`TEMPORARY_PRICE_REDUCTION` のレガシーエイリアス。サポート終了。この項目は非推奨です。

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

REST Resource: offerclass

リソース: OfferClass

RedemptionChannel

メソッド

`addmessage`

`get`

`insert`

`list`

`patch`

`update`