REST Resource: transitobject

리소스: TransitObject

JSON 표현 
{
  "classReference": {
    object (TransitClass)
  },
  "ticketNumber": string,
  "passengerType": enum (PassengerType),
  "passengerNames": string,
  "tripId": string,
  "ticketStatus": enum (TicketStatus),
  "customTicketStatus": {
    object (LocalizedString)
  },
  "concessionCategory": enum (ConcessionCategory),
  "customConcessionCategory": {
    object (LocalizedString)
  },
  "ticketRestrictions": {
    object (TicketRestrictions)
  },
  "purchaseDetails": {
    object (PurchaseDetails)
  },
  "ticketLeg": {
    object (TicketLeg)
  },
  "ticketLegs": [
    {
      object (TicketLeg)
    }
  ],
  "hexBackgroundColor": string,
  "tripType": enum (TripType),
  "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)
  },
  "activationStatus": {
    object (ActivationStatus)
  },
  "rotatingBarcode": {
    object (RotatingBarcode)
  },
  "deviceContext": {
    object (DeviceContext)
  },
  "heroImage": {
    object (Image)
  },
  "groupingInfo": {
    object (GroupingInfo)
  },
  "passConstraints": {
    object (PassConstraints)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  }
}
필드
classReference

object (TransitClass)

상위 클래스의 상속된 필드 사본입니다. 이러한 필드는 GET 실행 중에 검색됩니다.
ticketNumber

string

티켓의 번호입니다. 대중교통 사업자 시스템에서 티켓의 고유 식별자입니다.
passengerType

enum (PassengerType)

승객 수입니다.
passengerNames

string

티켓이 할당된 승객의 이름입니다. 위의 passengerType 필드는 Google에 이 필드에 대한 컨텍스트를 제공하기 위한 것입니다.
tripId

string

이 ID는 사용자가 동일한 여정에 대해 여러 티켓을 저장한 경우 티켓을 그룹화하는 데 사용됩니다.
ticketStatus

enum (TicketStatus)

티켓의 상태입니다. 표시에 영향을 미치는 상태의 경우 state 필드를 대신 사용하세요.
customTicketStatus

object (LocalizedString)

ticketStatus가 올바른 옵션을 제공하지 않는 경우 티켓 상태 값에 사용할 맞춤 상태입니다. ticketStatus와 customTicketStatus를 모두 설정할 수는 없습니다.
concessionCategory

enum (ConcessionCategory)

티켓의 할인 카테고리입니다.
customConcessionCategory

object (LocalizedString)

concessionCategory가 올바른 옵션을 제공하지 않는 경우 사용할 커스텀 할인 카테고리입니다. concessionCategory와 customConcessionCategory를 모두 설정할 수는 없습니다.
ticketRestrictions

object (TicketRestrictions)

이 티켓 사용에 적용되는 제한사항의 종류에 대한 정보입니다. 예를 들어 사용해야 하는 요일 또는 취할 수 있는 경로를 지정할 수 있습니다.
purchaseDetails

object (PurchaseDetails)

이 티켓의 구매 세부정보입니다.
ticketLeg

object (TicketLeg)

단일 티켓 구간에는 탑승 및 좌석 정보와 함께 출발 및 도착 정보가 포함됩니다. 구간을 두 개 이상 지정하려면 ticketLegs 필드를 대신 사용하세요. ticketLeg와 ticketLegs를 모두 설정할 수는 없습니다.
ticketLegs[]

object (TicketLeg)

각 티켓에는 하나 이상의 구간이 포함될 수 있습니다. 각 구간에는 탑승 및 좌석 정보와 함께 출발 및 도착 정보가 포함됩니다. 구간을 하나만 지정하려면 ticketLeg 필드를 대신 사용하세요. ticketLeg와 ticketLegs를 모두 설정할 수는 없습니다.
hexBackgroundColor

string

카드의 배경 색상입니다. 설정하지 않으면 히어로 이미지의 주요 색상이 사용되며, 히어로 이미지가 설정되지 않은 경우 로고의 주요 색상이 사용됩니다. 형식은 #rrggbb이며 여기서 rrggbb는 #ffcc00와 같은 16진수 RGB 3색입니다. #fc0와 같은 RGB 3색의 축약 버전(#rgb)을 사용할 수도 있습니다.
tripType

enum (TripType)

필수 항목입니다. 이 대중교통 객체가 나타내는 여행의 유형입니다. 패스 제목 또는 출발지와 목적지 사이에 사용할 기호를 결정하는 데 사용됩니다.
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를 통해 스마트 탭 인증 단말기로 전송되는 값입니다. 패스에서 스마트 탭을 지원하려면 클래스 수준 필드 enableSmartTap와 redemptionIssuers도 올바르게 설정해야 합니다. ASCII 문자만 지원됩니다.
hasLinkedDevice

boolean

이 객체가 현재 단일 기기에 연결되어 있는지 여부입니다. 이 필드는 사용자가 객체를 저장하여 기기에 연결할 때 플랫폼에서 설정합니다. 일부 파트너만 사용할 수 있습니다. 자세한 내용은 지원팀에 문의하세요.
disableExpirationNotification

boolean

알림을 명시적으로 억제해야 하는지 여부를 나타냅니다. 이 필드를 true로 설정하면 messages 필드에 관계없이 사용자에게 만료 알림이 표시되지 않습니다. 이 필드의 기본 설정값은 false입니다.

현재는 혜택에만 설정할 수 있습니다.
infoModuleData

object (InfoModuleData)

지원 중단되었습니다. 대신 textModulesData를 사용하세요.
imageModulesData[]

object (ImageModuleData)

이미지 모듈 데이터입니다. 이러한 필드의 최대 개수는 객체 수준에서 1개, 클래스 객체 수준에서 1개입니다.
textModulesData[]

object (TextModuleData)

텍스트 모듈 데이터 텍스트 모듈 데이터가 클래스에도 정의되어 있으면 둘 다 표시됩니다. 이러한 필드의 최대 개수는 객체에서 10개, 클래스에서 10개입니다.
activationStatus

object (ActivationStatus)

객체의 활성화 상태입니다. 클래스에 activationOptions가 설정된 경우 필요합니다.
rotatingBarcode

object (RotatingBarcode)

회전 바코드 유형 및 값입니다.
deviceContext

object (DeviceContext)

객체와 연결된 기기 컨텍스트입니다.
heroImage

object (Image)

카드 앞면에 표시되는 배너 이미지(선택사항)입니다. 클래스 히어로 이미지가 없으면 클래스의 히어로 이미지가 표시됩니다(있는 경우). 클래스의 히어로 이미지도 없으면 아무것도 표시되지 않습니다.
groupingInfo

object (GroupingInfo)

패스가 그룹화되는 방식을 제어하는 정보입니다.
passConstraints

object (PassConstraints)

객체의 제약 조건을 전달합니다. NFC 및 스크린샷 동작 제한이 포함됩니다.
saveRestrictions

object (SaveRestrictions)

사용자가 패스 저장을 시도하기 전에 확인해야 하는 객체에 관한 제한사항입니다. 이 제한은 절약 시간 중에만 적용됩니다. 사용자가 패스를 저장한 후 제한사항이 변경된 경우 이미 저장된 패스에는 새로운 제한사항이 적용되지 않습니다.

PassengerType

열거형
PASSENGER_TYPE_UNSPECIFIED
SINGLE_PASSENGER
singlePassenger

SINGLE_PASSENGER의 기존 별칭입니다. 지원 중단되었습니다.
MULTIPLE_PASSENGERS
multiplePassengers

MULTIPLE_PASSENGERS의 기존 별칭입니다. 지원 중단되었습니다.

TicketStatus

열거형
TICKET_STATUS_UNSPECIFIED
USED
used

USED의 기존 별칭입니다. 지원 중단되었습니다.
REFUNDED
refunded

REFUNDED의 기존 별칭입니다. 지원 중단되었습니다.
EXCHANGED
exchanged

EXCHANGED의 기존 별칭입니다. 지원 중단되었습니다.

ConcessionCategory

열거형
CONCESSION_CATEGORY_UNSPECIFIED
ADULT
adult

ADULT의 기존 별칭입니다. 지원 중단되었습니다.
CHILD
child

CHILD의 기존 별칭입니다. 지원 중단되었습니다.
SENIOR
senior

SENIOR의 기존 별칭입니다. 지원 중단되었습니다.

TicketRestrictions

JSON 표현 
{
  "routeRestrictions": {
    object (LocalizedString)
  },
  "routeRestrictionsDetails": {
    object (LocalizedString)
  },
  "timeRestrictions": {
    object (LocalizedString)
  },
  "otherRestrictions": {
    object (LocalizedString)
  }
}
필드
routeRestrictions

object (LocalizedString)

이용 가능한 경로에 대한 제한사항입니다. 예를 들어 '예약된 CrossCountry 열차 전용' 문자열일 수 있습니다.
routeRestrictionsDetails

object (LocalizedString)

위 routeRestrictions에 관한 세부정보
timeRestrictions

object (LocalizedString)

이 티켓을 사용할 수 있는 시간에 대한 제한입니다.
otherRestrictions

object (LocalizedString)

'경로'에 해당하지 않는 추가 제한 또는 '시간' 카테고리입니다.

PurchaseDetails

JSON 표현 
{
  "purchaseReceiptNumber": string,
  "purchaseDateTime": string,
  "accountId": string,
  "confirmationCode": string,
  "ticketCost": {
    object (TicketCost)
  }
}
필드
purchaseReceiptNumber

string

티켓을 판매한 기관을 통해 티켓 구매를 추적하기 위한 영수증 번호/식별자입니다.
purchaseDateTime

string

티켓 구매 날짜/시간입니다.

오프셋 유무와 관계없이 ISO 8601 확장 형식 날짜/시간입니다. 시간은 최대 나노초 단위로 지정할 수 있습니다. 오프셋은 초 정밀도로 지정할 수 있습니다 (오프셋 초는 ISO 8601의 일부가 아님).

예를 들면 다음과 같습니다.

1985-04-12T23:20:50.52Z은 1985년 4월 12일 23시 20분 50.52초(UTC)입니다.

1985-04-12T19:20:50.52-04:00는 UTC보다 4시간 늦은 1985년 4월 12일 19시 20분 50.52초입니다 (위의 예시와 같은 시점). 이벤트가 뉴욕에서 진행된다면 이 시간은 미 동부 일광 절약 시간 (EDT)에 해당합니다. 일광 절약 시간 (서머 타임)을 시행하는 지역에서는 연중 시기에 따라 오프셋이 다릅니다.

1985-04-12T19:20:50.52는 오프셋 정보가 없는 1985년 4월 12일 19시 20분 50.52초입니다.

오프셋 정보가 없으면 풍부한 기능의 일부를 사용하지 못할 수 있습니다.
accountId

string

티켓을 구매하는 데 사용된 계정의 ID입니다.
confirmationCode

string

구매의 확인 코드입니다. 여러 티켓의 경우 동일할 수 있으며 티켓을 그룹화하는 데 사용됩니다.
ticketCost

object (TicketCost)

티켓의 비용입니다.

TicketCost

JSON 표현 
{
  "faceValue": {
    object (Money)
  },
  "purchasePrice": {
    object (Money)
  },
  "discountMessage": {
    object (LocalizedString)
  }
}
필드
faceValue

object (Money)

티켓의 액면가입니다.
purchasePrice

object (Money)

세금 또는 할인 후 티켓의 실제 구매 가격입니다.
discountMessage

object (LocalizedString)

적용된 모든 종류의 할인을 설명하는 메시지입니다.

TicketLeg

JSON 표현 
{
  "originStationCode": string,
  "originName": {
    object (LocalizedString)
  },
  "destinationStationCode": string,
  "destinationName": {
    object (LocalizedString)
  },
  "departureDateTime": string,
  "arrivalDateTime": string,
  "fareName": {
    object (LocalizedString)
  },
  "carriage": string,
  "platform": string,
  "zone": string,
  "ticketSeat": {
    object (TicketSeat)
  },
  "ticketSeats": [
    {
      object (TicketSeat)
    }
  ],
  "transitOperatorName": {
    object (LocalizedString)
  },
  "transitTerminusName": {
    object (LocalizedString)
  }
}
필드
originStationCode

string

출발지 정거장 코드입니다. destinationStationCode이 있거나 originName가 없는 경우 필수입니다.
originName

object (LocalizedString)

출발지 정거장의 이름입니다. desinationName이 있거나 originStationCode가 없는 경우 필수입니다.
destinationStationCode

string

목적지 정거장 코드입니다.
destinationName

object (LocalizedString)

대상 이름입니다.
departureDateTime

string

출발 날짜/시간입니다. 대중교통 객체에 유효 시간 간격이 설정되지 않은 경우 필요합니다.

오프셋 유무와 관계없이 ISO 8601 확장 형식 날짜/시간입니다. 시간은 최대 나노초 단위로 지정할 수 있습니다. 오프셋은 초 정밀도로 지정할 수 있습니다 (오프셋 초는 ISO 8601의 일부가 아님).

예를 들면 다음과 같습니다.

1985-04-12T23:20:50.52Z은 1985년 4월 12일 23시 20분 50.52초(UTC)입니다.

1985-04-12T19:20:50.52-04:00는 UTC보다 4시간 늦은 1985년 4월 12일 19시 20분 50.52초입니다 (위의 예시와 같은 시점). 이벤트가 뉴욕에서 진행된다면 이 시간은 미 동부 일광 절약 시간 (EDT)에 해당합니다. 일광 절약 시간 (서머 타임)을 시행하는 지역에서는 연중 시기에 따라 오프셋이 다릅니다.

1985-04-12T19:20:50.52는 오프셋 정보가 없는 1985년 4월 12일 19시 20분 50.52초입니다.

날짜/시간에서 오프셋이 없는 부분은 '현지 날짜/시간'으로 간주됩니다. 출발지 정거장의 현지 날짜/시간이어야 합니다. 예를 들어 출발지 정거장에서 2018년 6월 5일 20시에 출발하는 경우 현지 날짜/시간 부분은 2018-06-05T20:00:00이어야 합니다. 출발지 정거장의 현지 날짜/시간이 UTC보다 4시간 느리다면 오프셋 -04:00을 추가할 수 있습니다.

오프셋 정보가 없으면 풍부한 기능의 일부를 사용하지 못할 수 있습니다.
arrivalDateTime

string

도착 날짜/시간입니다.

오프셋 유무와 관계없이 ISO 8601 확장 형식 날짜/시간입니다. 시간은 최대 나노초 단위로 지정할 수 있습니다. 오프셋은 초 정밀도로 지정할 수 있습니다 (오프셋 초는 ISO 8601의 일부가 아님).

예를 들면 다음과 같습니다.

1985-04-12T23:20:50.52Z은 1985년 4월 12일 23시 20분 50.52초(UTC)입니다.

1985-04-12T19:20:50.52-04:00는 UTC보다 4시간 늦은 1985년 4월 12일 19시 20분 50.52초입니다 (위의 예시와 같은 시점). 이벤트가 뉴욕에서 진행된다면 이 시간은 미 동부 일광 절약 시간 (EDT)에 해당합니다. 일광 절약 시간 (서머 타임)을 시행하는 지역에서는 연중 시기에 따라 오프셋이 다릅니다.

1985-04-12T19:20:50.52는 오프셋 정보가 없는 1985년 4월 12일 19시 20분 50.52초입니다.

날짜/시간에서 오프셋이 없는 부분은 '현지 날짜/시간'으로 간주됩니다. 목적지 정거장의 현지 날짜/시간이어야 합니다. 예를 들어 이벤트가 목적지 정거장에서 2018년 6월 5일 20시에 발생한다면 현지 날짜/시간 부분은 2018-06-05T20:00:00이어야 합니다. 목적지 정거장의 현지 날짜/시간이 UTC보다 4시간 느리다면 오프셋 -04:00을 추가할 수 있습니다.

오프셋 정보가 없으면 풍부한 기능의 일부를 사용하지 못할 수 있습니다.
fareName

object (LocalizedString)

이 여행 구간의 요금에 대한 간단한 설명/이름입니다. (예: '상시 일회용')
carriage

string

승객이 탑승해야 하는 열차 또는 선박 이름/번호입니다.
platform

string

승객이 객차에 탑승할 수 있는 승강장 또는 게이트입니다.
zone

string

플랫폼 내 탑승 구역입니다.
ticketSeat

object (TicketSeat)

승객의 지정 좌석입니다. 좌석을 두 개 이상 지정하려면 ticketSeats 필드를 대신 사용하세요. ticketSeat와 ticketSeats를 모두 설정할 수는 없습니다.
ticketSeats[]

object (TicketSeat)

승객의 지정 좌석입니다. 좌석을 하나만 지정하려면 ticketSeat 필드를 대신 사용하세요. ticketSeat와 ticketSeats를 모두 설정할 수는 없습니다.
transitOperatorName

object (LocalizedString)

이 이동 구간을 운영하는 대중교통 운영자의 이름입니다.
transitTerminusName

object (LocalizedString)

기차/버스 등의 종점 정거장 또는 목적지입니다.

TicketSeat

JSON 표현 
{
  "fareClass": enum (FareClass),
  "customFareClass": {
    object (LocalizedString)
  },
  "coach": string,
  "seat": string,
  "seatAssignment": {
    object (LocalizedString)
  }
}
필드
fareClass

enum (FareClass)

발권된 좌석의 요금 체계입니다.
customFareClass

object (LocalizedString)

fareClass가 적용되지 않는 경우 사용할 고객 요금 등급입니다. fareClass와 customFareClass를 모두 설정할 수는 없습니다.
coach

string

발권된 좌석이 위치한 열차 또는 객차의 식별자입니다. 예: '10'
seat

string

발권된 좌석이 위치한 곳의 식별자입니다. 예: '42'. 특정 식별자가 없는 경우 대신 seatAssigment를 사용합니다.
seatAssignment

object (LocalizedString)

승객의 좌석 지정입니다. 예: '특정 좌석 없음'. seat에 사용할 특정 식별자가 없는 경우 사용됩니다.

FareClass

열거형
FARE_CLASS_UNSPECIFIED
ECONOMY
economy

ECONOMY의 기존 별칭입니다. 지원 중단되었습니다.
FIRST
first

FIRST의 기존 별칭입니다. 지원 중단되었습니다.
BUSINESS
business

BUSINESS의 기존 별칭입니다. 지원 중단되었습니다.

TripType

열거형
TRIP_TYPE_UNSPECIFIED
ROUND_TRIP
roundTrip

ROUND_TRIP의 기존 별칭입니다. 지원 중단되었습니다.
ONE_WAY
oneWay

ONE_WAY의 기존 별칭입니다. 지원 중단되었습니다.

ActivationStatus

객체의 활성화 상태입니다. 유가물이 활성화를 지원하는 경우 이 필드에 활성화 상태가 포함됩니다.

JSON 표현 
{
  "state": enum (State)
}
필드
state

enum (State)

주

열거형
UNKNOWN_STATE
NOT_ACTIVATED 활성화되지 않음, 기본 상태입니다.
not_activated

NOT_ACTIVATED의 기존 별칭입니다. 지원 중단되었습니다.
ACTIVATED 활성화됨
activated

ACTIVATED의 기존 별칭입니다. 지원 중단되었습니다.

DeviceContext

객체와 연결된 기기 컨텍스트입니다.

JSON 표현 
{
  "deviceToken": string
}
필드
deviceToken

string

설정하면, 객체가 활성화되었을 때에만 사용 정보가 해당 기기로 반환됩니다. 사용자 기기를 추적하기 위한 안정적인 식별자로 사용해서는 안 됩니다. 동일한 기기의 여러 패스 또는 동일한 기기의 여러 활성화에 따라 변경될 수 있습니다. 이를 설정할 때 호출자는 활성화되는 객체에 hasLinkedDevice도 설정해야 합니다.

메서드

addmessage

 지정된 객체 ID로 참조되는 대중교통 객체에 메시지를 추가합니다.

get

 지정된 객체 ID가 있는 대중교통 객체를 반환합니다.

insert

 지정된 ID와 속성이 있는 대중교통 객체를 삽입합니다.

list

 지정된 발급기관 ID의 모든 대중교통 객체 목록을 반환합니다.

patch

 지정된 객체 ID로 참조되는 대중교통 객체를 업데이트합니다.

update

 지정된 객체 ID로 참조되는 대중교통 객체를 업데이트합니다.