REST 리소스: 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)
  }
}
필드
kind
(deprecated)

string

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

classReference

object (LoyaltyClass)

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

accountName

string

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

accountId

string

포인트 계정 식별자입니다. 권장되는 최대 길이는 20자(바이트)입니다.

loyaltyPoints

object (LoyaltyPoints)

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

linkedOfferIds[]

string

이 포인트 카드에 연결된 쿠폰 객체의 목록입니다. 쿠폰 객체가 이미 있는 상태여야 합니다.

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

secondaryLoyaltyPoints

object (LoyaltyPoints)

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

id

string

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

classId

string

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

클래스 ID는 issuer IDidentifier 형식을 따라야 합니다. 발급기관 ID는 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)

객체를 사용할 수 있는 위치의 목록입니다. 플랫폼은 이 정보를 사용하여 사용자에게 위치정보 알림을 트리거합니다. 위치 우선순위는 객체의 위치, 클래스의 위치, Google 지역 정보 ID의 위치 순입니다.

hasUsers

boolean

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

smartTapRedemptionValue

string

스마트 탭 사용 파트너에게만 제공됩니다. 자세한 안내는 지원팀에 문의하세요.

hasLinkedDevice

boolean

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

disableExpirationNotification

boolean

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

현재 이 속성은 쿠폰에만 설정할 수 있습니다.

infoModuleData

object (InfoModuleData)

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

imageModulesData[]

object (ImageModuleData)

이미지 모듈 데이터입니다. 이러한 표시된 필드의 최대 개수는 객체 수준에서 1개이고 클래스 객체 수준에서 1개입니다.

textModulesData[]

object (TextModuleData)

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

LoyaltyPoints

JSON 표현

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

string

포인트 라벨입니다(예: '포인트'). 권장되는 최대 길이는 9자(바이트)입니다.

balance

object (LoyaltyPointsBalance)

계정 소유자의 포인트 잔액입니다(예: '500', '$10.00'). 권장되는 최대 길이는 7자(바이트)입니다. loyaltyPointssecondaryLoyaltyPoints의 필수 필드입니다.

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로 참조되는 포인트 객체를 업데이트합니다.