REST Resource: loyaltyclass

리소스: LoyaltyClass

JSON 표현 
{
  "kind": string,
  "programName": string,
  "programLogo": {
    object (Image)
  },
  "accountNameLabel": string,
  "accountIdLabel": string,
  "rewardsTierLabel": string,
  "rewardsTier": string,
  "localizedProgramName": {
    object (LocalizedString)
  },
  "localizedAccountNameLabel": {
    object (LocalizedString)
  },
  "localizedAccountIdLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTierLabel": {
    object (LocalizedString)
  },
  "localizedRewardsTier": {
    object (LocalizedString)
  },
  "secondaryRewardsTierLabel": string,
  "localizedSecondaryRewardsTierLabel": {
    object (LocalizedString)
  },
  "secondaryRewardsTier": string,
  "localizedSecondaryRewardsTier": {
    object (LocalizedString)
  },
  "discoverableProgram": {
    object (DiscoverableProgram)
  },
  "classTemplateInfo": {
    object (ClassTemplateInfo)
  },
  "id": string,
  "version": string,
  "issuerName": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "allowMultipleUsersPerObject": boolean,
  "homepageUri": {
    object (Uri)
  },
  "locations": [
    {
      object (LatLongPoint)
    }
  ],
  "reviewStatus": enum (ReviewStatus),
  "review": {
    object (Review)
  },
  "infoModuleData": {
    object (InfoModuleData)
  },
  "imageModulesData": [
    {
      object (ImageModuleData)
    }
  ],
  "textModulesData": [
    {
      object (TextModuleData)
    }
  ],
  "linksModuleData": {
    object (LinksModuleData)
  },
  "redemptionIssuers": [
    string
  ],
  "countryCode": string,
  "heroImage": {
    object (Image)
  },
  "wordMark": {
    object (Image)
  },
  "enableSmartTap": boolean,
  "hexBackgroundColor": string,
  "localizedIssuerName": {
    object (LocalizedString)
  },
  "multipleDevicesAndHoldersAllowedStatus": enum (MultipleDevicesAndHoldersAllowedStatus),
  "callbackOptions": {
    object (CallbackOptions)
  },
  "securityAnimation": {
    object (SecurityAnimation)
  },
  "viewUnlockRequirement": enum (ViewUnlockRequirement),
  "wideProgramLogo": {
    object (Image)
  },
  "notifyPreference": enum (NotificationSettingsForUpdates),
  "appLinkData": {
    object (AppLinkData)
  },
  "valueAddedModuleData": [
    {
      object (ValueAddedModuleData)
    }
  ]
}
필드
kind
(deprecated)

string

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

string

필수 항목입니다. 프로그램 이름(예: 'Adam's Apparel')입니다. 전체 문자열이 작은 화면에도 표시될 수 있도록 앱에서 처음 20자(영문 기준) 뒤에 생략 부호가 표시될 수 있습니다.
accountNameLabel

string

계정 이름 라벨입니다(예: '회원 이름'). 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 15자(바이트)입니다.
accountIdLabel

string

계정 ID 라벨입니다(예: '회원 ID'). 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 15자(바이트)입니다.
rewardsTierLabel

string

리워드 등급 라벨입니다(예: '리워드 등급'). 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 9자(바이트)입니다.
rewardsTier

string

리워드 등급입니다(예: '골드' 또는 '플래티넘'). 전체 문자열이 작은 화면에도 표시될 수 있도록 권장되는 최대 길이는 7자(바이트)입니다.
localizedProgramName

object (LocalizedString)

programName의 번역된 문자열입니다. 전체 문자열이 작은 화면에 표시될 수 있도록 앱에서 처음 20자(바이트) 뒤에 줄임표가 표시될 수 있습니다.
localizedAccountNameLabel

object (LocalizedString)

accountNameLabel의 번역된 문자열입니다. 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 15자(바이트)입니다.
localizedAccountIdLabel

object (LocalizedString)

accountIdLabel의 번역된 문자열입니다. 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 15자(바이트)입니다.
localizedRewardsTierLabel

object (LocalizedString)

리워드TierLabel의 번역된 문자열입니다. 전체 문자열이 작은 화면에도 표시될 수 있도록 권장되는 최대 길이는 9자(바이트)입니다.
localizedRewardsTier

object (LocalizedString)

보상형 티어의 번역된 문자열입니다. 전체 문자열이 작은 화면에도 표시될 수 있도록 권장되는 최대 길이는 7자(바이트)입니다.
secondaryRewardsTierLabel

string

2차 리워드 등급 라벨입니다(예: '리워드 등급').
localizedSecondaryRewardsTierLabel

object (LocalizedString)

보조 리워드 TierLabel의 번역된 문자열입니다.
secondaryRewardsTier

string

'골드' 또는 '플래티넘'과 같은 2차 리워드 등급입니다.
localizedSecondaryRewardsTier

object (LocalizedString)

secondaryRewardsTier의 번역된 문자열입니다.
discoverableProgram

object (DiscoverableProgram)

Google Pay 앱에서 클래스를 검색하고 인스턴스화하는 방법에 대한 정보입니다.
classTemplateInfo

object (ClassTemplateInfo)

클래스를 표시하는 방법에 대한 템플릿 정보입니다. 설정하지 않으면 Google은 기본 필드 모음을 대신 표시합니다.
id

string

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

string (int64 format)

지원 중단됨
issuerName

string

필수 항목입니다. 발급기관 이름입니다. 전체 문자열이 작은 화면에도 표시될 수 있도록 권장되는 최대 길이는 20자(바이트)입니다.
messages[]

object (Message)

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

boolean

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

object (Uri)

애플리케이션 홈페이지의 URI입니다. 이 필드에 URI를 채우면 linksModuleData에 URI를 채우는 것과 동일한 동작이 실행됩니다(객체를 렌더링할 때 홈페이지 링크는 일반적으로 객체의 linksModuleData 섹션으로 간주되는 항목에 표시됩니다).
locations[]
(deprecated)

object (LatLongPoint)

참고: 현재 이 입력란은 지역 알림을 트리거하는 데 지원되지 않습니다.
reviewStatus

enum (ReviewStatus)

필수 항목입니다. 클래스 상태입니다. insert, patch 또는 update API 호출을 사용하여 이 필드를 draft 또는 underReview로 설정할 수 있습니다. 검토 상태가 draft에서 변경되고 나면 다시 draft로 변경할 수 없습니다.

클래스를 개발 중일 때는 이 필드를 draft로 유지해야 합니다. draft 클래스는 객체를 만드는 데 사용할 수 없습니다.

클래스를 사용할 준비가 되면 이 필드를 underReview로 설정해야 합니다. 플랫폼은 이 필드를 자동으로 approved로 설정하며 이는 객체를 생성하거나 마이그레이션하는 데 즉시 사용 가능합니다.

이미 approved된 클래스를 업데이트하는 경우 필드의 설정을 underReview로 유지해야 합니다.
review

object (Review)

클래스가 approved 또는 rejected로 표시될 때 플랫폼에서 설정한 검토 주석입니다.
infoModuleData
(deprecated)

object (InfoModuleData)

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

object (ImageModuleData)

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

object (TextModuleData)

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

string (int64 format)

스마트 탭을 통해 패스를 사용할 수 있는 패스 사용 발급기관을 식별합니다. 패스 사용 발급기관은 발급기관 ID로 식별됩니다. 사용 발급 기관에는 스마트 탭 키가 하나 이상 구성되어 있어야 합니다.

패스가 스마트 탭을 지원하려면 enableSmartTap 및 객체 수준 smartTapRedemptionValue, barcode.value, oraccountId` 필드 중 하나도 올바르게 설정되어야 합니다.
countryCode

string

카드의 국가를 표시하고(사용자가 해당 국가에 있지 않을 때) 사용자의 언어로 된 콘텐츠를 사용할 수 없을 때 현지화된 콘텐츠를 표시하는 데 사용되는 국가 코드입니다.
heroImage

object (Image)

카드 앞면에 표시되는 배너 이미지(선택사항)입니다. 아무것도 없으면 아무것도 표시되지 않습니다. 이미지는 100% 너비로 표시됩니다.
wordMark
(deprecated)

object (Image)

지원 중단되었습니다.
enableSmartTap

boolean

이 클래스가 스마트 탭을 지원하는지 식별합니다. 패스가 스마트 탭을 지원하려면 redemptionIssuers 및 객체 수준 smartTapRedemptionLevel, barcode.value, or accountId` 필드 중 하나도 올바르게 설정되어야 합니다.
hexBackgroundColor

string

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

object (LocalizedString)

issuerName의 번역된 문자열입니다. 전체 문자열이 작은 화면에도 표시될 수 있도록 권장되는 최대 길이는 20자(바이트)입니다.
multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

여러 사용자 및 기기가 이 클래스를 참조하는 동일한 객체를 저장할 것인지 여부를 식별합니다.
callbackOptions

object (CallbackOptions)

최종 사용자가 이 클래스의 객체를 저장/삭제할 때마다 발급기관을 다시 호출하는 데 사용할 콜백 옵션입니다. 이 클래스의 모든 객체에는 콜백이 적용됩니다.
securityAnimation

object (SecurityAnimation)

보안 애니메이션에 대한 선택적 정보입니다. 이 옵션을 설정하면 패스 세부정보에 보안 애니메이션이 렌더링됩니다.
viewUnlockRequirement

enum (ViewUnlockRequirement)

포인트 카드의 잠금 해제 요건 옵션을 확인합니다.
notifyPreference

enum (NotificationSettingsForUpdates)

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

object (ValueAddedModuleData)

부가가치 모듈 데이터(선택사항) 수업당 최대 10명 패스의 경우 10개만 표시되며 객체의 패스가 우선적으로 표시됩니다.

DiscoverableProgram

Android Pay 앱에서 클래스를 검색하고 인스턴스화하는 방법에 관한 정보입니다. 이 작업은 포인트 카드 또는 기프트 카드 프로그램을 검색하고 스캔하거나 수동으로 입력하여 수행됩니다.

JSON 표현 
{
  "merchantSignupInfo": {
    object (DiscoverableProgramMerchantSignupInfo)
  },
  "merchantSigninInfo": {
    object (DiscoverableProgramMerchantSigninInfo)
  },
  "state": enum (State)
}
필드
merchantSignupInfo

object (DiscoverableProgramMerchantSignupInfo)

판매자 사이트를 통해 이 프로그램에 가입하고 프로그램의 패스를 추가하는 기능에 대한 정보입니다. MERCHANT_HOSTED_SIGNUP이 사용 설정되어 있을 때 사용됩니다.
merchantSigninInfo

object (DiscoverableProgramMerchantSigninInfo)

판매자 사이트를 통해 이 프로그램에 로그인하고 프로그램의 패스를 추가하는 기능에 대한 정보입니다. MERCHANT_HOSTED_SIGNIN이 사용 설정되어 있을 때 사용됩니다.
state

enum (State)

검색 가능한 프로그램의 공개 상태입니다.

DiscoverableProgramMerchantSignupInfo

프로그램의 판매자 호스팅 가입 절차에 대한 정보입니다.

JSON 표현 
{
  "signupWebsite": {
    object (Uri)
  },
  "signupSharedDatas": [
    enum (SharedDataType)
  ]
}
필드
signupWebsite

object (Uri)

사용자를 판매자의 가입 사이트로 안내하는 URL입니다.
signupSharedDatas[]

enum (SharedDataType)

가입 웹사이트 URL에 대한 POST 요청으로 전송되는 사용자 데이터입니다. 이 정보는 암호화 후 공유되므로 판매자 웹사이트에서 검색 가능한 프로그램에 사용자를 등록하는 데 사용되는 필드를 미리 채울 수 있습니다.

SharedDataType

열거형
SHARED_DATA_TYPE_UNSPECIFIED
FIRST_NAME
LAST_NAME
STREET_ADDRESS 한 줄 주소 필드
ADDRESS_LINE_1 여러 줄 주소 필드
ADDRESS_LINE_2
ADDRESS_LINE_3
CITY
STATE
ZIPCODE
COUNTRY
EMAIL
PHONE

DiscoverableProgramMerchantSigninInfo

프로그램의 판매자 호스팅 로그인 절차에 대한 정보입니다.

JSON 표현 
{
  "signinWebsite": {
    object (Uri)
  }
}
필드
signinWebsite

object (Uri)

사용자를 판매자의 로그인 사이트로 안내하는 URL입니다.

주

열거형
STATE_UNSPECIFIED
TRUSTED_TESTERS 발급기관 계정에 액세스할 수 있는 테스터에게만 표시됩니다.
trustedTesters

TRUSTED_TESTERS의 기존 별칭입니다. 지원 중단되었습니다.
LIVE 모두에게 표시됩니다.
live

LIVE의 기존 별칭입니다. 지원 중단되었습니다.
DISABLED 표시되지 않습니다.
disabled

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

메서드

addmessage

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

get

 지정된 클래스 ID가 있는 포인트 클래스를 반환합니다.

insert

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

list

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

patch

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

update

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