REST Resource: genericobject

リソース: GenericObject

汎用オブジェクト

JSON 表現 
{
  "genericType": enum (GenericType),
  "cardTitle": {
    object (LocalizedString)
  },
  "subheader": {
    object (LocalizedString)
  },
  "header": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "notifications": {
    object (Notifications)
  },
  "id": string,
  "classId": string,
  "barcode": {
    object (Barcode)
  },
  "heroImage": {
    object (Image)
  },
  "validTimeInterval": {
    object (TimeInterval)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "smartTapRedemptionValue": string,
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "state": enum (State),
  "hasUsers": boolean,
  "passConstraints": {
    object (PassConstraints)
  },
  "wideLogo": {
    object (Image)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
フィールド
genericType

enum (GenericType)

カードが属する GenericType を指定します。
cardTitle

object (LocalizedString)

必須。パスのヘッダー。通常は、「XXX Gym」、「AAA Insurance」などの会社名です。このフィールドは必須で、パスの一番上のヘッダー行に表示されます。
subheader

object (LocalizedString)

パスのタイトルラベル（このパスを使用できる場所など）。パスの詳細ビューのタイトル行のタイトルのすぐ上に表示されます。
header

object (LocalizedString)

必須。パスのタイトル（「50% オフクーポン」など）「ライブラリ カード」または「クーポン」です。このフィールドは必須で、パス詳細ビューのタイトル行に表示されます。
hexBackgroundColor

string

カードの背景色。設定しない場合、ヒーロー画像の主要色が使用されます。ヒーロー画像が設定されていない場合はロゴの主要な色が使用され、ロゴが設定されていない場合は Google によって色が選択されます。
notifications

object (Notifications)

このオブジェクトで有効になっている通知設定。
id

string

必須。オブジェクトの一意の識別子。この ID は、発行者のすべてのオブジェクトで一意である必要があります。この値は issuerID.identifier の形式にする必要があります。issuerID は Google から発行され、identifier はユーザーが選択したものです。一意の識別子には、英数字、.、_、- のみを使用できます。
classId

string

必須。このオブジェクトに関連付けられているクラス。クラスはこのオブジェクトと同じ型で、すでに存在し、承認されている必要があります。

クラス ID は issuerID.identifier の形式にする必要があります。issuerID は Google が発行し、identifier はユーザーが選択したものです。
barcode

object (Barcode)

バーコードのタイプと値。パスにバーコードがない場合は、カード発行会社が Barcode.alternate_text を設定してそれだけを表示できます。
heroImage

object (Image)

カードの前面に表示されるバナー画像（存在する場合）。画像は 100% 幅で表示されます。
validTimeInterval

object (TimeInterval)

このオブジェクトが有効または使用可能と見なされる期間。この期間を過ぎると、オブジェクトは期限切れと見なされ、ユーザーのデバイスでのレンダリングに影響します。
imageModulesData[]

object (ImageModuleData)

画像モジュール データ。両方を設定した場合、クラスの画像とオブジェクト レベルの画像のうち 1 つだけがレンダリングされます。
textModulesData[]

object (TextModuleData)

テキスト モジュールのデータ。クラスで textModulesData も定義されている場合は、両方が表示されます。表示されるフィールドの最大数は、クラスから 10 個、オブジェクトから 10 個です。
groupingInfo

object (GroupingInfo)

パスのグループ化に関する情報。
smartTapRedemptionValue

string

このオブジェクトについて、NFC 経由でスマートタップ認定端末に送信される値。パスでスマートタップをサポートするには、クラスレベルのフィールド enableSmartTap と redemptionIssuers も正しく設定する必要があります。ASCII 文字のみがサポートされています。
rotatingBarcode

object (RotatingBarcode)

ローテーション バーコードの設定/詳細。
state

enum (State)

オブジェクトの状態。このフィールドは、アプリでのオブジェクトの表示方法を決定するために使用されます。たとえば、inactive オブジェクトは「期限切れのパス」に移動されます。できます。指定されていない場合、オブジェクトは ACTIVE とみなされます。
hasUsers

boolean

オブジェクトにユーザーが含まれているかどうかを示します。このフィールドはプラットフォームによって設定されます。
passConstraints

object (PassConstraints)

オブジェクトの制約を渡します。NFC の動作の制限やスクリーンショットの動作などが含まれています。
saveRestrictions

object (SaveRestrictions)

ユーザーがパスの保存を試みる前に確認する必要があるオブジェクトに関する制限。この制限は保存時にのみ適用されます。ユーザーがパスを保存した後に制限が変更された場合、すでに保存されているパスに新しい制限は適用されません。

GenericType

汎用カードのタイプ。

列挙型
GENERIC_TYPE_UNSPECIFIED 未指定の汎用型。
GENERIC_SEASON_PASS シーズンパス
GENERIC_UTILITY_BILLS 公共料金の請求書
GENERIC_PARKING_PASS 駐車パス
GENERIC_VOUCHER クーポン
GENERIC_GYM_MEMBERSHIP ジムの会員カード
GENERIC_LIBRARY_MEMBERSHIP 図書館カード
GENERIC_RESERVATIONS 予約
GENERIC_AUTO_INSURANCE 自動車保険カード
GENERIC_HOME_INSURANCE 住宅保険カード
GENERIC_ENTRY_TICKET 入場チケット
GENERIC_RECEIPT 領収書
GENERIC_OTHER その他のタイプ

通知

オブジェクトで通知を有効にする必要があるかどうかを示します。ExpiryNotification/今後の通知のいずれか 1 つのみがサポートされています。expiryNotification は upcomingNotification よりも優先されます。つまり、expiryNotification が設定されている場合、upcomingNotification フィールドは無視されます。

JSON 表現 
{
  "expiryNotification": {
    object (ExpiryNotification)
  },
  "upcomingNotification": {
    object (UpcomingNotification)
  }
}
フィールド
expiryNotification

object (ExpiryNotification)

通知は、カードの有効期限が切れる前の特定の時刻にトリガーされます。
upcomingNotification

object (UpcomingNotification)

カードが使用可能になる前の特定の時刻に通知がトリガーされます。

ExpiryNotification

カード発行会社が、カードの有効期限の 2 日前に Google ウォレットから有効期限の通知を送信することを希望していることを示します。

JSON 表現 
{
  "enableNotification": boolean
}
フィールド
enableNotification

boolean

オブジェクトの有効期限通知を有効にする必要があるかどうかを示します。

UpcomingNotification

カードが有効または使用可能になる 1 日前に、カード発行会社が Google ウォレットからカード有効性の通知を送信するよう希望することを示します。

JSON 表現 
{
  "enableNotification": boolean
}
フィールド
enableNotification

boolean

オブジェクトで今後の通知を有効にする必要があるかどうかを示します。

メソッド

addmessage

 指定されたオブジェクト ID の汎用オブジェクトにメッセージを追加します。

get

 指定されたオブジェクト ID の汎用オブジェクトを返します。

insert

 指定された ID とプロパティの汎用オブジェクトを挿入します。

list

 指定された発行者 ID のすべての汎用オブジェクトのリストを返します。

patch

 指定されたオブジェクト ID の汎用オブジェクトを更新します。

update

 指定されたオブジェクト ID の汎用オブジェクトを更新します。