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 헬스장', 'AAA 보험'과 같은 업체 이름입니다. 이 필드는 필수이며 패스 상단의 헤더 행에 표시됩니다.
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.alt_text를 설정하고 해당 항목만 표시하도록 허용할 수 있습니다.
heroImage

object (Image)

카드 전면(있는 경우)에 표시되는 배너 이미지입니다. 이미지는 100% 너비로 표시됩니다.
validTimeInterval

object (TimeInterval)

이 객체가 유효하거나 사용 가능한 것으로 간주되는 기간입니다. 이 기간이 지나면 객체가 만료된 것으로 간주되어 사용자 기기에서의 렌더링에 영향을 미칩니다.
imageModulesData[]

object (ImageModuleData)

이미지 모듈 데이터입니다. 두 이미지를 모두 설정하면 클래스의 이미지 하나와 객체 수준의 이미지 중 하나만 렌더링됩니다.
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/다음 알림 중 하나만 지원됩니다. 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로 참조되는 일반 객체를 업데이트합니다.