REST Resource: offerobject

리소스: OfferObject

JSON 표현
{
  "kind": string,
  "classReference": {
    object (OfferClass)
  },
  "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)
  }
}
필드
kind
(deprecated)

string

리소스 종류를 식별합니다. 값: 고정 문자열 "walletobjects#offerObject".

classReference

object (OfferClass)

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

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

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

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 및 스크린샷 동작 제한을 포함합니다.

방법

addmessage

지정된 객체 ID로 참조되는 쿠폰 객체에 메시지를 추가합니다.

get

지정된 객체 ID가 있는 쿠폰 객체를 반환합니다.

insert

지정된 ID와 속성이 있는 쿠폰 객체를 삽입합니다.

list

지정된 발급기관 ID의 모든 쿠폰 객체 목록을 반환합니다.

patch

지정된 객체 ID로 참조되는 쿠폰 객체를 업데이트합니다.

update

지정된 객체 ID로 참조되는 쿠폰 객체를 업데이트합니다.