REST Resource: flightclass

リソース: FlightClass

JSON 表現
{
  "kind": string,
  "localScheduledDepartureDateTime": string,
  "localEstimatedOrActualDepartureDateTime": string,
  "localBoardingDateTime": string,
  "localScheduledArrivalDateTime": string,
  "localEstimatedOrActualArrivalDateTime": string,
  "flightHeader": {
    object (FlightHeader)
  },
  "origin": {
    object (AirportInfo)
  },
  "destination": {
    object (AirportInfo)
  },
  "flightStatus": enum (FlightStatus),
  "boardingAndSeatingPolicy": {
    object (BoardingAndSeatingPolicy)
  },
  "localGateClosingDateTime": string,
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "languageOverride": string,
  "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),
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
フィールド
kind
(deprecated)

string

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

localScheduledDepartureDateTime

string

必須。航空機がゲート(滑走路ではなく)を出発する予定の日時。

注: 出発時刻の直前にこのフィールドを変更しないでください。出発時刻の更新(遅延など)については、localEstimatedOrActualDepartureDateTime を設定してください。

これは、ISO 8601 拡張形式の日付/時刻で、オフセットなしです。時間はミリ秒単位の精度で指定できます。

例: 2027-03-05T06:30:00

これは、UTC 時間ではなく、空港のローカルの日付/時刻である必要があります。

UTC オフセットが指定されている場合、Google はリクエストを拒否します。タイムゾーンは離陸する空港に基づいて Google によって計算されます。

localEstimatedOrActualDepartureDateTime

string

航空機がゲートから出発する予定時刻、または航空機がゲートから出発した実際の時刻。注: これは滑走路からの離陸時刻ではありません。

このフィールドは、以下の少なくとも 1 つに該当する場合に設定する必要があります。

  • 予定時刻とは異なる場合。Google はこの項目を使用して遅延を計算します。
  • 航空機がすでにゲートから出発している場合。Google はこの項目を使用して航空機が出発した実際の時間をユーザーに通知します。

これは、ISO 8601 拡張形式の日付/時刻で、オフセットなしです。時間はミリ秒単位の精度で指定できます。

例: 2027-03-05T06:30:00

これは、UTC 時間ではなく、空港のローカルの日付/時刻である必要があります。

UTC オフセットが指定されている場合、Google はリクエストを拒否します。タイムゾーンは離陸する空港に基づいて Google によって計算されます。

localBoardingDateTime

string

搭乗券に印刷される搭乗時間。

これは、ISO 8601 拡張形式の日付/時刻で、オフセットなしです。時間はミリ秒単位の精度で指定できます。

例: 2027-03-05T06:30:00

これは、UTC 時間ではなく、空港のローカルの日付/時刻である必要があります。

UTC オフセットが指定されている場合、Google はリクエストを拒否します。タイムゾーンは、出発空港に基づいて Google によって計算されます。

localScheduledArrivalDateTime

string

航空機が目的地のゲート(滑走路ではなく)に到着する予定時刻。

注: フライト時刻の直前にこのフィールドを変更しないでください。出発時刻の更新(遅延など)については、localEstimatedOrActualArrivalDateTime を設定してください。

これは、ISO 8601 拡張形式の日付/時刻で、オフセットなしです。時間はミリ秒単位の精度で指定できます。

例: 2027-03-05T06:30:00

これは、UTC 時間ではなく、空港のローカルの日付/時刻である必要があります。

UTC オフセットが指定されている場合、Google はリクエストを拒否します。タイムゾーンは到着する空港に基づいて Google によって計算されます。

localEstimatedOrActualArrivalDateTime

string

航空機が目的地のゲート(滑走路ではなく)に到達する予定時刻、またはゲートに実際に到着した時刻。

このフィールドは、以下の少なくとも 1 つに該当する場合に設定する必要があります。

  • 予定時刻とは異なる場合。Google はこの情報を使用して遅延を計算します。
  • 航空機がすでにゲートに到着している場合。Google はこの項目を使用して航空機がゲートに到着したことをユーザーに通知します。

これは、ISO 8601 拡張形式の日付/時刻で、オフセットなしです。時間はミリ秒単位の精度で指定できます。

例: 2027-03-05T06:30:00

これは、UTC 時間ではなく、空港のローカルの日付/時刻である必要があります。

UTC オフセットが指定されている場合、Google はリクエストを拒否します。タイムゾーンは、到着空港に基づいて Google によって計算されます。

flightHeader

object (FlightHeader)

必須。航空会社とフライト番号に関する情報。

origin

object (AirportInfo)

必須。出発地の空港。

destination

object (AirportInfo)

必須。目的地の空港。

flightStatus

enum (FlightStatus)

このフライトのステータス。

未設定の場合、FlightStats などの他のソースからのデータに基づいてステータスが計算されます。

注: Google で計算されたステータスは API レスポンスで返されません。

boardingAndSeatingPolicy

object (BoardingAndSeatingPolicy)

搭乗と座席のポリシー。これは、ユーザーに表示されるラベルを示します。

localGateClosingDateTime

string

搭乗券に印刷されるゲート閉鎖時刻。搭乗券に印刷しない場合は、このフィールドを設定しないでください。

これは、ISO 8601 拡張形式の日付/時刻で、オフセットなしです。時刻は、ミリ秒の精度まで指定できます。

例: 2027-03-05T06:30:00

これは、UTC 時間ではなく、空港のローカルの日付/時刻である必要があります。

UTC オフセットが指定されている場合、Google はリクエストを拒否します。タイムゾーンは離陸する空港に基づいて Google によって計算されます。

classTemplateInfo

object (ClassTemplateInfo)

クラスの表示方法に関するテンプレート情報。設定しない場合、デフォルトの表示フィールドになります。

languageOverride

string

このフィールドが存在する場合、ユーザーのデバイスに配信される搭乗券は常にこの言語で表されます。BCP 47 言語タグを表します。たとえば、「en-US」、「en-GB」、「de」、「de-AT」など。

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 個が最大数になります。

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)

搭乗券のロック解除要件のオプションを表示します。

notifyPreference

enum (NotificationSettingsForUpdates)

このクラスのフィールドの更新で通知をトリガーするかどうか。NOTIFY に設定すると、フィールドの更新通知がユーザーに送信されます。これらの通知は、フィールドが許可リストに含まれている場合にのみユーザーに送信されます。指定しない場合、通知はトリガーされません。この設定は一時的なものであり、PATCH または UPDATE リクエストごとに設定する必要があります。設定しない場合は通知がトリガーされません。

valueAddedModuleData[]

object (ValueAddedModuleData)

オプションの付加価値モジュール データ。クラスあたりの最大数は 10 です。パスの場合は 10 個のみが表示され、オブジェクトのパスから優先的に表示されます。

FlightHeader

JSON 表現
{
  "kind": string,
  "carrier": {
    object (FlightCarrier)
  },
  "flightNumber": string,
  "operatingCarrier": {
    object (FlightCarrier)
  },
  "operatingFlightNumber": string,
  "flightNumberDisplayOverride": string
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#flightHeader" です。

carrier

object (FlightCarrier)

航空会社についての情報。これは flightHeader の必須プロパティです。

flightNumber

string

IATA 航空会社コードのないフライト番号。このフィールドに使用できるのは数字のみです。これは flightHeader の必須プロパティです。

例: 「123」

operatingCarrier

object (FlightCarrier)

運航航空会社に関する情報。

operatingFlightNumber

string

運行航空会社が使用する IATA 航空会社コードのないフライト番号。このフィールドに使用できるのは数字のみです。

例: 「234」

flightNumberDisplayOverride

string

フライト番号に使用する値をオーバーライドします。表示に使用されるデフォルト値は、航空会社 + フライト番号です。乗客に別の値を表示する必要がある場合は、このフィールドを使用してデフォルトの動作をオーバーライドします。

例: 「XX1234 / YY576」

FlightCarrier

JSON 表現
{
  "kind": string,
  "carrierIataCode": string,
  "carrierIcaoCode": string,
  "airlineName": {
    object (LocalizedString)
  },
  "airlineLogo": {
    object (Image)
  },
  "airlineAllianceLogo": {
    object (Image)
  },
  "wideAirlineLogo": {
    object (Image)
  }
}
フィールド
kind
(deprecated)

string

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

carrierIataCode

string

運航航空会社ではなく、販売航空会社の 2 文字の IATA 航空会社コード。これか carrierIcaoCode のいずれか 1 つのみを carrieroperatingCarrier に指定する必要があります。

例: Swiss Air は「LX」

carrierIcaoCode

string

運航航空会社ではなく、販売航空会社の 3 文字の ICAO 航空会社コード。carrieroperatingCarrier には、これまたは carrierIataCode のいずれか 1 つを指定する必要があります。

例: Easy Jet は「EZY」

airlineName

object (LocalizedString)

carrierIataCode で指定される航空会社のローカライズされた名前。未設定の場合、FlightClassissuerName または localizedIssuerName が表示目的に使用されます。

例: 「LX」は「Swiss Air」

AirportInfo

JSON 表現
{
  "kind": string,
  "airportIataCode": string,
  "terminal": string,
  "gate": string,
  "airportNameOverride": {
    object (LocalizedString)
  }
}
フィールド
kind
(deprecated)

string

リソースの種類を示します。値は固定文字列 "walletobjects#airportInfo" です。

airportIataCode

string

3 文字の IATA 空港コード。これは、origindestination の必須フィールドです。

例: 「SFO」

terminal

string

ターミナル名。例: 「INTL」、「I」

gate

string

ゲート名。例: 「B59」、「59」

airportNameOverride

object (LocalizedString)

IATA で定義された空港の都市名をオーバーライドするオプション フィールド。デフォルトでは、Google は指定された airportIataCode を受け取り、IATA で定義された正式な空港の都市名にマッピングします。

正式な IATA の空港の都市名は、 IATA の空港の都市名のウェブサイトで確認できます。たとえば、IATA のウェブサイトで、空港の IATA コード「LTN」に対応する空港の都市が「London」であることがわかります。

このフィールドが入力されていない場合は、「London」と表示されます。

ただし、このフィールドにカスタム名(例: 「London Luton」)を入力すると、オーバーライドされます。

FlightStatus

列挙型
FLIGHT_STATUS_UNSPECIFIED
SCHEDULED フライトが定刻どおり、定刻より早く、または遅れて運航されている。
scheduled

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

ACTIVE フライトが進行中です(地上走行、離陸、着陸、空中)。
active

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

LANDED 航空機が最初の目的地に着陸しました。
landed

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

CANCELLED フライトがキャンセルされました。
cancelled

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

REDIRECTED 航空機は飛行中ですが、最初の目的地とは異なる空港に向かっています。
redirected

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

DIVERTED 航空機が最初の目的地とは異なる空港に着陸しました。
diverted

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

BoardingAndSeatingPolicy

JSON 表現
{
  "kind": string,
  "boardingPolicy": enum (BoardingPolicy),
  "seatClassPolicy": enum (SeatClassPolicy)
}
フィールド
kind
(deprecated)

string

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

boardingPolicy

enum (BoardingPolicy)

航空会社の搭乗ポリシーを表します。設定しない場合、デフォルトで zoneBased に設定されます。

seatClassPolicy

enum (SeatClassPolicy)

座席クラスの表示方法を規定する座席ポリシー。未設定の場合、Google はデフォルトで cabinBased を使用します。

BoardingPolicy

列挙型
BOARDING_POLICY_UNSPECIFIED
ZONE_BASED
zoneBased

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

GROUP_BASED
groupBased

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

BOARDING_POLICY_OTHER
boardingPolicyOther

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

SeatClassPolicy

列挙型
SEAT_CLASS_POLICY_UNSPECIFIED
CABIN_BASED
cabinBased

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

CLASS_BASED
classBased

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

TIER_BASED
tierBased

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

SEAT_CLASS_POLICY_OTHER
seatClassPolicyOther

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

メソッド

addmessage

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

get

指定されたクラス ID のフライトクラスを返します。

insert

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

list

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

patch

指定されたクラス ID のフライトクラスを更新します。

update

指定されたクラス ID のフライトクラスを更新します。