REST Resource: loyaltyobject

리소스: LoyaltyObject

JSON 표현 
{
  "kind": string,
  "classReference": {
    object (LoyaltyClass)
  },
  "accountName": string,
  "accountId": string,
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "linkedOfferIds": [
    string
  ],
  "secondaryLoyaltyPoints": {
    object (LoyaltyPoints)
  },
  "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)
  },
  "saveRestrictions": {
    object (SaveRestrictions)
  },
  "linkedObjectIds": [
    string
  ],
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
필드
kind
(deprecated)

string

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

object (LoyaltyClass)

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

string

포인트 계정 소유자 이름(예: 'John Smith')입니다. 전체 문자열이 작은 화면에도 표시될 수 있도록 권장되는 최대 길이는 20자(바이트)입니다.
accountId

string

포인트 계정 식별자입니다. 권장되는 최대 길이는 20자(영문 기준)입니다.
loyaltyPoints

object (LoyaltyPoints)

리워드 포인트의 라벨, 잔액, 유형입니다.
linkedOfferIds[]

string

이 포인트 카드에 연결된 쿠폰 객체의 목록입니다. 혜택 객체가 이미 있어야 합니다.

혜택 객체 ID는 issuer ID 형식을 따라야 합니다.identifier: Google에서 발급하며 후자는 개발자가 선택합니다.
secondaryLoyaltyPoints

object (LoyaltyPoints)

보조 리워드 포인트의 라벨, 잔액, 유형입니다. 기본 포인트에 추가로 표시됩니다.
id

string

필수 항목입니다. 객체의 고유 식별자입니다. 이 ID는 한 발급기관의 모든 객체에서 고유해야 합니다. 이 값은 issuer ID 형식을 따라야 합니다.identifier 형식을 따라야 합니다. 발급기관 ID는 Google에서 발급하며 식별자는 개발자가 직접 선택합니다. 고유 식별자에는 영숫자 문자, '.', '_', '-'만 포함되어야 합니다.
classId

string

필수 항목입니다. 이 객체에 연결된 클래스입니다. 클래스는 이 객체와 유형이 동일해야 하며, 이미 존재하고 승인된 상태여야 합니다.

클래스 ID는 issuer ID 형식을 따라야 합니다.identifier 형식을 따라야 합니다. 발급기관 ID는 Google에서 발급하며 식별자는 개발자가 직접 선택합니다.
version
(deprecated)

string (int64 format)

지원 중단됨
state

enum (State)

필수 항목입니다. 객체 상태입니다. 이 필드는 객체가 앱에 표시되는 방식을 결정하는 데 사용됩니다. 예를 들어 inactive 객체는 '만료된 패스' 섹션으로 이동됩니다.
barcode

object (Barcode)

바코드 유형 및 값입니다.
messages[]

object (Message)

앱에 표시되는 메시지의 배열입니다. 이 객체의 모든 사용자는 관련 메시지를 수신합니다. 이 필드의 최대 개수는 10개입니다.
validTimeInterval

object (TimeInterval)

이 객체가 active 상태가 되어 객체를 사용할 수 있는 기간입니다. 이 기간이 지나면 객체의 상태가 expired로 변경됩니다.
locations[]
(deprecated)

object (LatLongPoint)

참고: 이 필드는 현재 지역 알림을 트리거하는 데 지원되지 않습니다.
hasUsers

boolean

객체에 사용자가 있는지 여부를 나타냅니다. 이 필드는 플랫폼에서 설정합니다.
smartTapRedemptionValue

string

이 객체의 NFC를 통해 스마트 탭 인증 단말기로 전송되는 값입니다. 패스에서 스마트 탭을 지원하려면 클래스 수준 필드 enableSmartTap와 redemptionIssuers도 올바르게 설정해야 합니다. ASCII 문자만 지원됩니다.

이 값이 설정되지 않았지만 클래스 수준 필드 enableSmartTap 및 redemptionIssuers가 올바르게 설정된 경우 barcode.value 또는 accountId 필드가 있는 경우 대체로 사용됩니다.
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 및 스크린샷 동작 제한을 포함합니다.
saveRestrictions

object (SaveRestrictions)

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

string

linkedObjectIds는 이 포인트 제도 객체에 자동으로 연결되어야 하는 이벤트 티켓, 포인트 제도, 혜택, 일반, 기프트 카드, 대중교통, 탑승권과 같은 다른 객체의 목록입니다. 사용자가 이 포인트 카드를 저장한 경우 이러한 연결된 패스를 수신하도록 설정을 사용 중지하지 않는 한 이러한 linkedObjectIds가 사용자의 지갑에 자동으로 푸시됩니다.

linkedObjectIds에 있는 객체가 이미 삽입되어 있는지 확인하세요. 삽입되지 않으면 호출이 실패합니다. 연결된 후에는 연결된 객체를 연결 해제할 수 없습니다. 다른 발급기관에 속한 객체는 연결할 수 없습니다. 단일 객체에 연결할 수 있는 객체 수에는 제한이 있습니다. 한도에 도달하면 호출에서 연결된 새 객체는 자동으로 무시됩니다.

객체 ID는 issuer ID 형식을 따라야 합니다.identifier 형식을 따라야 합니다. 발급기관 ID는 Google에서 발급하며 식별자는 개발자가 직접 선택합니다.
notifyPreference

enum (NotificationSettingsForUpdates)

이 객체의 필드 업데이트가 알림을 트리거해야 하는지 여부입니다. NOTIFY로 설정하면 사용자에게 필드 업데이트 알림을 트리거하려고 시도합니다. 이러한 알림은 필드가 허용 목록에 포함된 경우에만 사용자에게 전송됩니다. DO_NOT_NOTIFY 또는 NOTIFICATION_SETTINGS_UNSPECIFIED로 설정하면 알림이 트리거되지 않습니다. 이 설정은 일시적이며 각 PATCH 또는 UPDATE 요청과 함께 설정해야 합니다. 그러지 않으면 알림이 트리거되지 않습니다.
valueAddedModuleData[]

object (ValueAddedModuleData)

부가가치 모듈 데이터(선택사항) 객체에 최대 10개까지 포함할 수 있습니다.

LoyaltyPoints

JSON 표현 
{
  "label": string,
  "balance": {
    object (LoyaltyPointsBalance)
  },
  "localizedLabel": {
    object (LocalizedString)
  }
}
필드
label

string

적립 포인트 라벨입니다(예: '포인트'). 권장되는 최대 길이는 9자(영문 기준)입니다.
balance

object (LoyaltyPointsBalance)

계정 소유자의 적립 포인트 잔액입니다(예: '500' 또는 '$10.00'). 권장되는 최대 길이는 7자(영문 기준)입니다. loyaltyPoints 및 secondaryLoyaltyPoints의 필수 필드입니다.
localizedLabel

object (LocalizedString)

라벨의 번역된 문자열입니다. 권장되는 최대 길이는 9자(영문 기준)입니다.

LoyaltyPointsBalance

JSON 표현 
{
  "string": string,
  "int": integer,
  "double": number,
  "money": {
    object (Money)
  }
}
필드
string

string

string 형식으로 표시한 잔액입니다. 이 하위유형 (string, int, double, money) 중 하나만 채워야 합니다.
int

integer

integer 형식으로 표시한 잔액입니다. 이 하위유형 (string, int, double, money) 중 하나만 채워야 합니다.
double

number

double 형식으로 표시한 잔액입니다. 이 하위유형 (string, int, double, money) 중 하나만 채워야 합니다.
money

object (Money)

money 형식으로 표시한 잔액입니다. 이 하위유형 (string, int, double, money) 중 하나만 채워야 합니다.

메서드

addmessage

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

get

 지정된 객체 ID가 있는 포인트 객체를 반환합니다.

insert

 지정된 ID와 속성이 있는 포인트 객체를 삽입합니다.

list

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

modifylinkedofferobjects

 지정된 ID가 있는 포인트 객체의 연결된 쿠폰 객체를 수정합니다.

patch

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

update

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