패키지 google.walletobjects.v1.offer

색인

OfferClassService

AddMessage

rpc AddMessage(OfferClassAddMessageRequest) returns (OfferClassAddMessageResponse)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(OfferClassGetRequest) returns (OfferClass)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(OfferClassInsertRequest) returns (OfferClass)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(OfferClassListRequest) returns (OfferClassListResponse)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(OfferClassPatchRequest) returns (OfferClass)

지정된 클래스 ID로 참조되는 쿠폰 클래스를 업데이트합니다. 이 메서드는 패치 시맨틱스를 지원합니다.

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(OfferClassUpdateRequest) returns (OfferClass)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer

OfferObjectService

AddMessage

rpc AddMessage(OfferObjectAddMessageRequest) returns (OfferObjectAddMessageResponse)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(OfferObjectGetRequest) returns (OfferObject)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(OfferObjectInsertRequest) returns (OfferObject)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(OfferObjectListRequest) returns (OfferObjectListResponse)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(OfferObjectPatchRequest) returns (OfferObject)

지정된 객체 ID로 참조되는 쿠폰 객체를 업데이트합니다. 이 메서드는 패치 시맨틱스를 지원합니다.

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(OfferObjectUpdateRequest) returns (OfferObject)

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

승인 범위

다음과 같은 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/wallet_object.issuer

OfferClass

필드
kind
(deprecated)

string

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

title

string

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

redemption_channel

RedemptionChannel

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

provider

string

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

title_image

Image

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

details

string

쿠폰의 세부정보입니다.

fine_print

string

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

help_uri

Uri

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

localized_title

LocalizedString

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

localized_provider

LocalizedString

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

localized_details

LocalizedString

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

localized_fine_print

LocalizedString

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

short_title

string

사용자가 쿠폰 내용을 빠르게 알아볼 수 있도록 짧게 줄여 표시하는 쿠폰 제목입니다(예: '20% 할인'). 권장되는 최대 길이는 20자(바이트)입니다.

localized_short_title

LocalizedString

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

class_template_info

ClassTemplateInfo

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

id

string

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

version
(deprecated)

int64

지원 중단됨

issuer_name

string

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

messages[]

Message

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

allow_multiple_users_per_object
(deprecated)

bool

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

homepage_uri

Uri

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

locations[]

LatLongPoint

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

review_status

ReviewStatus

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

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

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

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

review

Review

클래스가 approved 또는 rejected로 표시되는 경우 플랫폼에서 설정한 검토 주석입니다.

info_module_data
(deprecated)

InfoModuleData

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

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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

redemption_issuers[]

int64

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

country_code

string

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

hero_image

Image

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

word_mark
(deprecated)

Image

지원 중단되었습니다.

enable_smart_tap

bool

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

hex_background_color

string

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

localized_issuer_name

LocalizedString

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

multiple_devices_and_holders_allowed_status

MultipleDevicesAndHoldersAllowedStatus

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

callback_options

CallbackOptions

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

RedemptionChannel

열거형
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

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

ONLINE
online

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

BOTH
both

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

TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

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

OfferClassAddMessageRequest

필드
resource_id

string

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

add_message_request

AddMessageRequest

요청 본문입니다.

OfferClassAddMessageResponse

필드
resource

OfferClass

업데이트된 OfferClass 리소스입니다.

OfferClassGetRequest

필드
resource_id

string

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

OfferClassInsertRequest

필드
resource

OfferClass

요청 본문입니다.

OfferClassListRequest

필드
issuer_id

int64

클래스를 나열하도록 승인된 발급기관의 ID입니다.

token

string

maxResults를 지정했지만 목록에 maxResults보다 더 많은 클래스가 있을 경우 다음 결과 집합을 가져오는 데 사용됩니다. 예를 들어 클래스가 200개인 목록이 있는데 maxResults를 20으로 설정하고 목록을 호출하면 목록은 처음 20개의 클래스와 토큰 하나를 반환합니다. 다음 20개 클래스를 가져오려면 maxResults를 20으로 설정하고 반환된 토큰을 사용하여 목록을 다시 호출합니다.

max_results

int32

목록에서 반환하는 결과의 최대 개수를 식별합니다. maxResults를 정의하지 않으면 모든 결과가 반환됩니다.

OfferClassListResponse

필드
resources[]

OfferClass

목록 요청에 해당하는 리소스입니다.

pagination

Pagination

응답의 페이지 나누기입니다.

OfferClassPatchRequest

필드
resource_id

string

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

resource

OfferClass

요청 본문입니다.

OfferClassUpdateRequest

필드
resource_id

string

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

resource

OfferClass

요청 본문입니다.

OfferObject

필드
kind
(deprecated)

string

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

class_reference

OfferClass

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

id

string

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

class_id

string

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

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

version
(deprecated)

int64

지원 중단됨

state

State

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

barcode

Barcode

바코드 유형 및 값입니다.

messages[]

Message

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

valid_time_interval

TimeInterval

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

locations[]

LatLongPoint

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

has_users

bool

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

smart_tap_redemption_value

string

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

has_linked_device

bool

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

disable_expiration_notification

bool

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

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

info_module_data

InfoModuleData

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

image_modules_data[]

ImageModuleData

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

text_modules_data[]

TextModuleData

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

OfferObjectAddMessageRequest

필드
resource_id

string

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

add_message_request

AddMessageRequest

요청 본문입니다.

OfferObjectAddMessageResponse

필드
resource

OfferObject

업데이트된 OfferObject 리소스입니다.

OfferObjectGetRequest

필드
resource_id

string

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

OfferObjectInsertRequest

필드
resource

OfferObject

요청 본문입니다.

OfferObjectListRequest

필드
class_id

string

객체 목록을 확인할 클래스의 ID입니다.

token

string

maxResults를 지정했지만 목록에 maxResults보다 더 많은 객체가 있을 경우 다음 결과 집합을 가져오는 데 사용됩니다. 예를 들어 목록에 200개의 객체가 있는데 maxResults를 20으로 설정하여 list를 호출하면 처음 20개의 객체와 토큰 하나가 반환됩니다. 다음 20개 객체를 가져오려면 maxResults를 20으로 설정하고 반환된 토큰을 사용하여 목록을 다시 호출합니다.

max_results

int32

목록에서 반환하는 결과의 최대 개수를 식별합니다. maxResults를 정의하지 않으면 모든 결과가 반환됩니다.

OfferObjectListResponse

필드
resources[]

OfferObject

목록 요청에 해당하는 리소스입니다.

pagination

Pagination

응답의 페이지 나누기입니다.

OfferObjectPatchRequest

필드
resource_id

string

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

resource

OfferObject

요청 본문입니다.

OfferObjectUpdateRequest

필드
resource_id

string

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

resource

OfferObject

요청 본문입니다.