REST Resource: flightobject

リソース: FlightObject

JSON 表現
{
  "kind": string,
  "classReference": {
    object (FlightClass)
  },
  "passengerName": string,
  "boardingAndSeatingInfo": {
    object (BoardingAndSeatingInfo)
  },
  "reservationInfo": {
    object (ReservationInfo)
  },
  "securityProgramLogo": {
    object (Image)
  },
  "hexBackgroundColor": string,
  "id": string,
  "classId": string,
  "version": string,
  "state": enum (State),
  "barcode": {
    object (Barcode)
  },
  "messages": [
    {
      object (Message)
    }
  ],
  "validTimeInterval": {
    object (TimeInterval)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "hasUsers": boolean,
  "smartTapRedemptionValue": string,
  "hasLinkedDevice": boolean,
  "disableExpirationNotification": boolean,
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "appLinkData": {
    object (AppLinkData)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
フィールド
kind
(deprecated)

string

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

classReference

object (FlightClass)

親クラスの継承されたフィールドのコピー。これらのフィールドは GET 中に取得されます。

passengerName

string

必須。搭乗券に表示される乗客名。

例: 「Dave M Gahan」または「Gahan/Dave」または「GAHAN/DAVEM」

boardingAndSeatingInfo

object (BoardingAndSeatingInfo)

搭乗と座席に関する乗客固有の情報。

reservationInfo

object (ReservationInfo)

必須。フライトの予約に関する情報。

hexBackgroundColor

string

カードの背景色。設定されていない場合、ヒーロー画像の主要な色が使用され、ヒーロー画像が設定されていない場合は、ロゴの主要な色が使用されます。形式は #rrggbb です。ここで、rrggbb は 16 進数の RGB トリプレットです(例: #ffcc00)。#fc0 など、RGB トリプレットの省略形も使用できます。rgb

id

string

必須。オブジェクトの一意の識別子。この ID は、発行者のすべてのオブジェクトで一意である必要があります。この値は issuer ID の形式にする必要があります。identifier。前者は Google が発行し、後者は貴社が選択します。一意の識別子には、英数字、「.」、「_」、「-」のみを使用してください。

classId

string

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

クラス ID は issuer ID の形式にする必要があります。identifier。前者は Google が発行し、後者は貴社が選択します。

version
(deprecated)

string (int64 format)

非推奨

state

enum (State)

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

barcode

object (Barcode)

バーコードのタイプと値。

messages[]

object (Message)

アプリに表示されるメッセージの配列。このオブジェクトのすべてのユーザーが、関連するメッセージを受け取ります。これらのフィールドの最大数は 10 です。

validTimeInterval

object (TimeInterval)

このオブジェクトが active になり、オブジェクトが使用可能になる期間。この期間が経過すると、オブジェクトの状態は expired に変更されます。

locations[]

object (LatLongPoint)

注: 現在、このフィールドで位置情報通知をトリガーすることはサポートされていません。

hasUsers

boolean

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

smartTapRedemptionValue

string

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

hasLinkedDevice

boolean

このオブジェクトが現在 1 つのデバイスにリンクされているかどうか。このフィールドは、ユーザーがオブジェクトを保存し、デバイスにリンクするときにプラットフォームによって設定されます。一部のパートナーによる使用を想定しています。詳細についてはサポートにお問い合わせください。

disableExpirationNotification

boolean

通知を明示的に抑制するかどうかを示します。このフィールドを true に設定した場合、messages フィールドに関係なく、ユーザーへの有効期限通知が抑制されます。デフォルトでは、このフィールドは false に設定されています。

現在のところ、フライトに対してのみ設定できます。

infoModuleData

object (InfoModuleData)

非推奨です。代わりに textModulesData を使用してください。

imageModulesData[]

object (ImageModuleData)

画像モジュール データ。表示されるフィールドの最大数は、オブジェクト レベルでは 1 個、クラス オブジェクト レベルでは 1 個です。

textModulesData[]

object (TextModuleData)

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

rotatingBarcode

object (RotatingBarcode)

ローテーション バーコードのタイプと値。

heroImage

object (Image)

カードの前面に表示されるオプションのバナー画像。何も存在しない場合は、クラスのヒーロー画像が表示されます(存在する場合)。クラスのヒーロー画像も存在しない場合は、何も表示されません。

groupingInfo

object (GroupingInfo)

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

passConstraints

object (PassConstraints)

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

saveRestrictions

object (SaveRestrictions)

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

BoardingAndSeatingInfo

JSON 表現
{
  "kind": string,
  "boardingGroup": string,
  "seatNumber": string,
  "seatClass": string,
  "boardingPrivilegeImage": {
    object (Image)
  },
  "boardingPosition": string,
  "sequenceNumber": string,
  "boardingDoor": enum (BoardingDoor),
  "seatAssignment": {
    object (LocalizedString)
  }
}
フィールド
kind
(deprecated)

string

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

boardingGroup

string

この乗客が搭乗する搭乗グループ(またはゾーン)の値。

例: 「B」

この値のラベルは、このオブジェクトが参照する flightClassboardingPolicy フィールドによって決まります。

seatNumber

string

乗客の座席の値。特定の ID がない場合は、代わりに seatAssignment を使用します。

例: 「25A」

seatClass

string

座席クラスの値。

例: 「エコノミー」または「Economy Plus」

boardingPrivilegeImage

object (Image)

搭乗用バーコードの上に表示される小さな画像。航空会社は、特別な搭乗特典を知らせるためにこの URL を使用できます。セキュリティ・プログラムのロゴも設定されている場合、この画像はそのセキュリティ・プログラムのロゴと並んで表示されます。

boardingPosition

string

乗車位置の値。

例: 「76」

sequenceNumber

string

搭乗券のシーケンス番号。これは通常、乗客がチェックインした順序と一致します。航空会社は、この番号を手動搭乗タグや手荷物タグに使用することがあります。

例: 「49」

boardingDoor

enum (BoardingDoor)

このフィールドは、そのフライトが複数のドアや橋から搭乗し、搭乗券にドアの位置を明示的に印刷する場合にのみ設定します。ほとんどの航空会社は、seatClass で示されるドアやブリッジで、適切なドアまたはブリッジに乗客を誘導します。このような場合は、boardingDoor を設定しないでください。

seatAssignment

object (LocalizedString)

乗客の座席の割り当て。seatNumber で使用する特定の識別子がない場合に使用します。

例: 「Assigned at gate」

BoardingDoor

列挙型
BOARDING_DOOR_UNSPECIFIED
FRONT
front

FRONT のレガシー エイリアス。サポート終了。

BACK
back

BACK のレガシー エイリアス。サポート終了。

ReservationInfo

JSON 表現
{
  "kind": string,
  "confirmationCode": string,
  "eticketNumber": string,
  "frequentFlyerInfo": {
    object (FrequentFlyerInfo)
  }
}
フィールド
kind
(deprecated)

string

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

confirmationCode

string

このフライトにチェックインするには確認コードが必要です。

これは、乗客が空港にあるキオスクでフライトを検索し、搭乗券を印刷する番号です。

eticketNumber

string

E チケット番号。

frequentFlyerInfo

object (FrequentFlyerInfo)

マイレージ会員情報。

FrequentFlyerInfo

JSON 表現
{
  "kind": string,
  "frequentFlyerProgramName": {
    object (LocalizedString)
  },
  "frequentFlyerNumber": string
}
フィールド
kind
(deprecated)

string

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

frequentFlyerProgramName

object (LocalizedString)

マイレージ プログラムの名前。例: 「Lufthansa Miles &もっと見る」

frequentFlyerNumber

string

マイレージ番号。

種類が walletobjects#frequentFlyerInfo のネストされたオブジェクトごとに必須。

メソッド

addmessage

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

get

指定されたオブジェクト ID のフライト オブジェクトを返します。

insert

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

list

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

patch

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

update

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