REST Resource: offerclass

리소스: OfferClass

JSON 표현
{
  "kind": string,
  "title": string,
  "redemptionChannel": enum (RedemptionChannel),
  "provider": string,
  "titleImage": {
    object (Image)
  },
  "details": string,
  "finePrint": string,
  "helpUri": {
    object (Uri)
  },
  "localizedTitle": {
    object (LocalizedString)
  },
  "localizedProvider": {
    object (LocalizedString)
  },
  "localizedDetails": {
    object (LocalizedString)
  },
  "localizedFinePrint": {
    object (LocalizedString)
  },
  "shortTitle": string,
  "localizedShortTitle": {
    object (LocalizedString)
  },
  "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),
  "wideTitleImage": {
    object (Image)
  }
}
필드
kind
(deprecated)

string

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

title

string

필수 항목입니다. 혜택 제목입니다(예: '모든 티셔츠 20% 할인'). 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 60자(영문 기준)입니다.

redemptionChannel

enum (RedemptionChannel)

필수 항목입니다. 이 쿠폰에 해당하는 쿠폰 사용 채널입니다.

provider

string

필수 항목입니다. 쿠폰 제공업체 (애그리게이터 이름 또는 판매자 이름)입니다. 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 12자(영문 기준)입니다.

titleImage

object (Image)

혜택의 제목 이미지입니다. 이 이미지는 앱의 세부정보 및 목록 보기에 모두 표시됩니다.

details

string

혜택의 세부정보입니다.

finePrint

string

혜택의 세부 문구 또는 조건입니다(예: 'Adam's Apparel의 모든 티셔츠 20% 할인').

helpUri

object (Uri)

혜택에 대한 도움말 링크입니다(예: http://myownpersonaldomain.com/help).

localizedTitle

object (LocalizedString)

제목의 번역된 문자열입니다. 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 60자(영문 기준)입니다.

localizedProvider

object (LocalizedString)

제공업체의 번역된 문자열입니다. 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 12자(영문 기준)입니다.

localizedDetails

object (LocalizedString)

세부정보의 번역된 문자열입니다.

localizedFinePrint

object (LocalizedString)

deepPrint의 번역된 문자열입니다.

shortTitle

string

사용자에게 혜택 콘텐츠를 빠르게 참조할 수 있도록 '20% 할인'과 같이 혜택 제목을 축약한 버전입니다. 권장되는 최대 길이는 20자(영문 기준)입니다.

localizedShortTitle

object (LocalizedString)

짧은 제목의 번역된 문자열입니다. 권장되는 최대 길이는 20자(영문 기준)입니다.

classTemplateInfo

object (ClassTemplateInfo)

클래스가 표시되는 방식에 대한 템플릿 정보입니다. 설정하지 않으면 기본 필드 집합으로 대체됩니다.

id

string

필수 항목입니다. 클래스의 고유 식별자입니다. 이 ID는 한 발급기관의 모든 클래스에서 고유해야 합니다. 이 값은 issuer ID 형식을 따라야 합니다.identifier의 경우 전자는 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[]

object (LatLongPoint)

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

reviewStatus

enum (ReviewStatus)

필수 항목입니다. 클래스의 상태입니다. 이 필드는 draft 또는 클래스 상태로 설정할 수 있습니다. 이 필드는 삽입, 패치 또는 업데이트 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 및 객체 수준 smartTapRedemptionLevel 필드도 올바르게 설정해야 합니다.

countryCode

string

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

heroImage

object (Image)

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

wordMark
(deprecated)

object (Image)

지원이 중단되었습니다.

enableSmartTap

boolean

이 클래스가 스마트 탭을 지원하는지 여부를 식별합니다. 패스가 스마트 탭을 지원하려면 redemptionIssuers 및 객체 수준 smartTapRedemptionLevel 필드도 올바르게 설정해야 합니다.

hexBackgroundColor

string

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

localizedIssuerName

object (LocalizedString)

발급기관Name의 번역된 문자열입니다. 전체 문자열이 작은 화면에 표시될 수 있도록 권장되는 최대 길이는 20자(영문 기준)입니다.

multipleDevicesAndHoldersAllowedStatus

enum (MultipleDevicesAndHoldersAllowedStatus)

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

callbackOptions

object (CallbackOptions)

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

securityAnimation

object (SecurityAnimation)

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

viewUnlockRequirement

enum (ViewUnlockRequirement)

혜택의 잠금 해제 요구사항 옵션을 확인합니다.

wideTitleImage

object (Image)

혜택의 넓은 제목 이미지입니다. 제공되는 경우 카드 보기의 왼쪽 상단에 있는 제목 이미지 대신 사용됩니다.

RedemptionChannel

열거형
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

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

ONLINE
online

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

BOTH
both

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

TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

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

방법

addmessage

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

get

지정된 클래스 ID가 있는 쿠폰 클래스를 반환합니다.

insert

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

list

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

patch

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

update

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