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

REST Resource: transitclass

リソース: TransitClass <ph type="x-smartling-placeholder">
- JSON 表現
- TransitType
- ActivationOptions <ph type="x-smartling-placeholder">
  - JSON 表現
メソッド

リソース: TransitClass

JSON 表現

JSON 表現
{ "transitOperatorName": { object (`LocalizedString`) }, "logo": { object (`Image`) }, "transitType": enum (`TransitType`), "watermark": { object (`Image`) }, "languageOverride": string, "customTransitTerminusNameLabel": { object (`LocalizedString`) }, "customTicketNumberLabel": { object (`LocalizedString`) }, "customRouteRestrictionsLabel": { object (`LocalizedString`) }, "customRouteRestrictionsDetailsLabel": { object (`LocalizedString`) }, "customTimeRestrictionsLabel": { object (`LocalizedString`) }, "customOtherRestrictionsLabel": { object (`LocalizedString`) }, "customPurchaseReceiptNumberLabel": { object (`LocalizedString`) }, "customConfirmationCodeLabel": { object (`LocalizedString`) }, "customPurchaseFaceValueLabel": { object (`LocalizedString`) }, "customPurchasePriceLabel": { object (`LocalizedString`) }, "customDiscountMessageLabel": { object (`LocalizedString`) }, "customCarriageLabel": { object (`LocalizedString`) }, "customSeatLabel": { object (`LocalizedString`) }, "customCoachLabel": { object (`LocalizedString`) }, "customPlatformLabel": { object (`LocalizedString`) }, "customZoneLabel": { object (`LocalizedString`) }, "customFareClassLabel": { object (`LocalizedString`) }, "customConcessionCategoryLabel": { object (`LocalizedString`) }, "customFareNameLabel": { object (`LocalizedString`) }, "classTemplateInfo": { object (`ClassTemplateInfo`) }, "enableSingleLegItinerary": boolean, "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`) }, "activationOptions": { object (`ActivationOptions`) }, "viewUnlockRequirement": enum (`ViewUnlockRequirement`), "wideLogo": { object (`Image`) }, "appLinkData": { object (`AppLinkData`) } }

{
  "transitOperatorName": {
    object (LocalizedString)
  },
  "logo": {
    object (Image)
  },
  "transitType": enum (TransitType),
  "watermark": {
    object (Image)
  },
  "languageOverride": string,
  "customTransitTerminusNameLabel": {
    object (LocalizedString)
  },
  "customTicketNumberLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsLabel": {
    object (LocalizedString)
  },
  "customRouteRestrictionsDetailsLabel": {
    object (LocalizedString)
  },
  "customTimeRestrictionsLabel": {
    object (LocalizedString)
  },
  "customOtherRestrictionsLabel": {
    object (LocalizedString)
  },
  "customPurchaseReceiptNumberLabel": {
    object (LocalizedString)
  },
  "customConfirmationCodeLabel": {
    object (LocalizedString)
  },
  "customPurchaseFaceValueLabel": {
    object (LocalizedString)
  },
  "customPurchasePriceLabel": {
    object (LocalizedString)
  },
  "customDiscountMessageLabel": {
    object (LocalizedString)
  },
  "customCarriageLabel": {
    object (LocalizedString)
  },
  "customSeatLabel": {
    object (LocalizedString)
  },
  "customCoachLabel": {
    object (LocalizedString)
  },
  "customPlatformLabel": {
    object (LocalizedString)
  },
  "customZoneLabel": {
    object (LocalizedString)
  },
  "customFareClassLabel": {
    object (LocalizedString)
  },
  "customConcessionCategoryLabel": {
    object (LocalizedString)
  },
  "customFareNameLabel": {
    object (LocalizedString)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "enableSingleLegItinerary": boolean,
  "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)
  },
  "activationOptions": {
    object (ActivationOptions)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideLogo": {
    object (Image)
  },
  "appLinkData": {
    object (AppLinkData)
  }
}

フィールド
`transitOperatorName`	`object (LocalizedString)` 交通機関の名前。
`logo`	`object (Image)` 必須。チケットのロゴ画像。この画像は、アプリのカード情報ビューに表示されます。
`transitType`	`enum (TransitType)` 必須。このクラスが表す交通機関のタイプ（「バス」など）。
`watermark`	`object (Image)` ユーザーのデバイスに表示する透かし画像。
`languageOverride`	`string` このフィールドが存在する場合、ユーザーのデバイスに配信される乗車券は常にこの言語で表示されます。BCP 47 言語タグを表します。値の例としては、「en-US」、「en-GB」、「de」、「de-AT」などがあります。
`customTransitTerminusNameLabel`	`object (LocalizedString)` 終点名の値（`transitObject.ticketLeg.transitTerminusName`）に使用するカスタムラベル。
`customTicketNumberLabel`	`object (LocalizedString)` チケット番号の値（`transitObject.ticketNumber`）に使用するカスタムラベル。
`customRouteRestrictionsLabel`	`object (LocalizedString)` ルート制限値（`transitObject.ticketRestrictions.routeRestrictions`）に使用するカスタムラベル。
`customRouteRestrictionsDetailsLabel`	`object (LocalizedString)` 利用ルート制限の詳細値（`transitObject.ticketRestrictions.routeRestrictionsDetails`）に使用するカスタムラベル。
`customTimeRestrictionsLabel`	`object (LocalizedString)` 利用時間制限の詳細の値に使用するカスタムラベル（`transitObject.ticketRestrictions.timeRestrictions`）。
`customOtherRestrictionsLabel`	`object (LocalizedString)` 他の制限値（`transitObject.ticketRestrictions.otherRestrictions`）に使用するカスタムラベル。
`customPurchaseReceiptNumberLabel`	`object (LocalizedString)` 購入の領収書番号の値（`transitObject.purchaseDetails.purchaseReceiptNumber`）に使用するカスタムラベル。
`customConfirmationCodeLabel`	`object (LocalizedString)` 確認コードの値（`transitObject.purchaseDetails.confirmationCode`）に使用するカスタムラベル。
`customPurchaseFaceValueLabel`	`object (LocalizedString)` 購入額面金額（`transitObject.purchaseDetails.ticketCost.faceValue`）に使用するカスタムラベル。
`customPurchasePriceLabel`	`object (LocalizedString)` 購入価格の値（`transitObject.purchaseDetails.ticketCost.purchasePrice`）に使用するカスタムラベル。
`customDiscountMessageLabel`	`object (LocalizedString)` 交通機関割引メッセージの値（`transitObject.purchaseDetails.ticketCost.discountMessage`）に使用するカスタムラベル。
`customCarriageLabel`	`object (LocalizedString)` 車両の値（`transitObject.ticketLeg.carriage`）に使用するカスタムラベル。
`customSeatLabel`	`object (LocalizedString)` 座席位置の値（`transitObject.ticketLeg.ticketSeat.seat`）に使用するカスタムラベル。
`customCoachLabel`	`object (LocalizedString)` コーチの値（`transitObject.ticketLeg.ticketSeat.coach`）に使用するカスタムラベル。
`customPlatformLabel`	`object (LocalizedString)` 乗車プラットフォームの値（`transitObject.ticketLeg.platform`）に使用するカスタムラベル。
`customZoneLabel`	`object (LocalizedString)` 乗車ゾーンの値（`transitObject.ticketLeg.zone`）に使用するカスタムラベル。
`customFareClassLabel`	`object (LocalizedString)` 運賃クラス値（`transitObject.ticketLeg.ticketSeat.fareClass`）に使用するカスタムラベル。
`customConcessionCategoryLabel`	`object (LocalizedString)` 交通割引カテゴリの値（`transitObject.concessionCategory`）に使用するカスタムラベル。
`customFareNameLabel`	`object (LocalizedString)` 運賃名の値（`transitObject.ticketLeg.fareName`）に使用するカスタムラベル。
`classTemplateInfo`	`object (ClassTemplateInfo)` クラスをどのように表示するかに関するテンプレート情報。設定しない場合、デフォルトのフィールドセットが表示されます。
`enableSingleLegItinerary`	`boolean` このクラスの片道旅程の表示を制御します。デフォルトでは、複数区間を経由する旅程のみ表示されます。
`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)` 必須。クラスのステータス。このフィールドは、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)` セキュリティアニメーションに関するオプションの情報。これが設定されている場合、パスの詳細にセキュリティアニメーションがレンダリングされます。
`activationOptions`	`object (ActivationOptions)` 有効化可能なチケットの有効化オプション。
`viewUnlockRequirement`	`enum (ViewUnlockRequirement)` 乗車券のロック解除要件オプションを表示します。
`wideLogo`	`object (Image)` チケットのワイドロゴ。指定した場合、カードビューの左上にあるロゴの代わりに使用されます。
`appLinkData`	`object (AppLinkData)` アプリまたはウェブサイトへのリンク。パスの前面にボタンとして表示されるオプションです。対応するオブジェクトで AppLinkData が指定されている場合は、代わりにそのオブジェクトが使用されます。

TransitType

列挙型
`TRANSIT_TYPE_UNSPECIFIED`
`BUS`
`bus`	`BUS` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`RAIL`
`rail`	`RAIL` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`TRAM`
`tram`	`TRAM` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`FERRY`
`ferry`	`FERRY` のレガシーエイリアス。サポート終了。この項目は非推奨です。
`OTHER`
`other`	`OTHER` のレガシーエイリアス。サポート終了。この項目は非推奨です。

ActivationOptions

クラスの ActivationOptions

JSON 表現
{ "activationUrl": string, "allowReactivation": boolean }

フィールド

フィールド
`activationUrl`	`string` REST セマンティクスをサポートする HTTPS URL。ユーザーによってトリガーされる、特定の価値についてパートナーに有効化をリクエストするために使用されます。
`allowReactivation`	`boolean` ユーザーが別のデバイスからアクティベーションコールを行うことを許可するフラグ。これにより、activationStatus が ACTIVATED になっているが、リクエストされたデバイスが現在のデバイスと異なる場合でも、クライアントはアクティベーションボタンを有効なレンダリングにレンダリングできます。

activationUrl

string

REST セマンティクスをサポートする HTTPS URL。ユーザーによってトリガーされる、特定の価値についてパートナーに有効化をリクエストするために使用されます。

allowReactivation

boolean

ユーザーが別のデバイスからアクティベーションコールを行うことを許可するフラグ。これにより、activationStatus が ACTIVATED になっているが、リクエストされたデバイスが現在のデバイスと異なる場合でも、クライアントはアクティベーションボタンを有効なレンダリングにレンダリングできます。

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

REST Resource: transitclass

リソース: TransitClass

TransitType

ActivationOptions

メソッド

`addmessage`

`get`

`insert`

`list`

`patch`

`update`