콘텐츠로 건너뛰기
/
보너스 프로모션 생성하기

LiveOps API (2.0.0)

개요

LiveOps는 프로모션 및 맞춤형 혜택을 통해 진행 중인 플레이어 참여를 독려하는 툴킷입니다.

API를 사용하여 다음 기능을 관리할 수 있습니다:

  • 프로모션 - 쿠폰, 프로모션 코드, 할인 및 보너스 캠페인을 생성하고 관리합니다.
  • 개인화 - 특정 승인된 사용자에 한해 아이템 카탈로그를 표시하고 프로모션을 적용할 수 있는 조건을 지정합니다.
  • 프로모션 한도 - 사용자당 프로모션 사용 횟수에 대한 한도를 설정하고, 해당 한도에 대한 정기적인 초기화 일정을 구성합니다.
  • 리워드 체인 및 가치 포인트 - 가치 포인트 적립과 연계된 보상 진행 단계 설정.
  • 일일 체인 - 매일 반복되는 보상을 설정하여 정기적인 로그인을 유도합니다.
  • 혜택 체인 - 단계별 가격 책정 및 무료 보상 옵션을 통해 순차적 구매 혜택을 구축합니다.
  • 업셀링 - 추가적인 가치가 있는 아이템을 구매할 수 있도록 사용자에게 제공되는 판매 방법.

API 호출

API는 다음 그룹으로 구분됩니다:

  • Admin - 캠페인 및 체인 구성의 생성, 업데이트, 활성화 및 삭제를 수행합니다. 상품 또는 프로젝트 자격 증명으로 기본 액세스 인증을 통해 인증됩니다.
  • Client - 인증된 최종 사용자를 대신하여 이용 가능한 프로모션을 검색하고, 활성 체인을 확인하며, 코드를 사용하고, 보상을 요청하는 기능을 제공합니다. 사용자 JWT를 통해 인증됩니다.
OpenAPI 설명 다운로드
index.json
index.yaml
언어
서버
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ko/api/liveops/

일반

작업

쿠폰

이 API를 사용하여 쿠폰을 관리할 수 있습니다.

작업

프로모션 코드

이 API를 사용하여 프로모션 코드를 관리할 수 있습니다.

작업

고유 카탈로그 혜택

이 API를 사용하여 고유 카탈로그 혜택을 관리할 수 있습니다.

작업

할인

이 API를 사용하여 할인 프로모션을 관리할 수 있습니다.

작업

보너스

이 API를 사용하여 보너스 프로모션을 관리할 수 있습니다.

작업

보너스 프로모션 목록 가져오기Server-sideAdmin

요청

프로젝트에 속한 보너스 프로모션 목록을 가져옵니다.

프로모션은 사용자가 구매한 구매 항목에 무료 보너스 아이템을 추가합니다. 프로모션은 프로젝트 내의 모든 구매 또는 특정 아이템을 포함하는 구매에 적용할 수 있습니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
쿼리
limitinteger>= 1

페이지 요소 개수 제한입니다.

예제: limit=50
offsetinteger>= 0

목록이 생성된 요소의 개수입니다(개수는 0부터 시작함).

예제: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v3/project/44056/admin/promotion/bonus?limit=50&offset=0'

응답

보너스 프로모션 목록을 성공적으로 수신했습니다.

본문application/json
active_promotions_countinteger(active_promotions_count)

활성 프로모션의 수입니다.

inactive_promotions_countinteger(inactive_promotions_count)

비활성 프로모션의 수입니다.

promotionsArray of objects(Promotions_200-get-bonus-promotion-model)
total_promotions_countinteger(total_promotions_count)

총 프로모션 개수입니다.

응답
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "promotions": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

보너스 프로모션 생성하기Server-sideAdmin

요청

보너스 프로모션을 생성합니다.

프로모션은 사용자가 구매한 구매 항목에 무료 보너스 아이템을 추가합니다. 프로모션은 프로젝트 내의 모든 구매 또는 특정 아이템을 포함하는 구매에 적용할 수 있습니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
본문application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 프로모션의 가용성을 결정합니다.

bonusArray of objects or null필수
bonus[].​quantitynumber

아이템 수량입니다.

기본값 1
bonus[].​skustring

아이템 SKU입니다.

기본값 "elven_shield"
conditionArray of objects or null필수

프로모션을 적용하기 위해 구매 항목에 포함되어야 하는 아이템 세트입니다. 이 매개 변수가 null이면 프로젝트 내의 모든 구매 항목에 프로모션이 적용됩니다.

condition[].​skustring

아이템 SKU입니다.

기본값 "elven_sword"
excluded_promotionsArray of integers(excluded_promotions)

이 프로모션을 적용할 때 제외할 프로모션 ID 목록입니다.
Example: [12, 789]

예제: [12,789]
idinteger

프로모션 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

is_enabledboolean(Promotions_is_enabled)

프로모션 활성화 여부.

예제: true
limitsobject(Promotions_promotion_limits)

프로모션 제한입니다.

nameobject필수

프로모션의 이름입니다. 키가 "^[a-z]{2}-[A-Z]{2}$" 형식의 로케일인 키/값 쌍을 포함해야 하며 값은 문자열입니다.

예제: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
name.​property name*string추가 속성
price_conditionsArray of objects or null(price_conditions_bonus)

프로모션을 적용하기 위한 가격 범위를 설정하는 조건을 가진 개체 배열입니다.
프로모션은 가격이 배열의 모든 조건을 충족하는 아이템에만 적용됩니다. 이 배열을 전달하는 경우 조건 개체의 값이 null로 설정됩니다.

promotion_periodsArray of objects(promotion_periods)

프로모션의 유효 기간. 기간이 여러 개 지정된 경우 date_from와 date_until가 모두 필요합니다.

curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/bonus \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 50000,
        "sku": "com.xsolla.mp_credits"
      }
    ],
    "condition": [
      {
        "sku": "com.xsolla.year_1_season_pass"
      }
    ],
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

응답

프로모션을 성공적으로 생성했습니다.

본문application/json
promotion_idinteger

프로모션 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

응답
application/json
{
  "promotion_id": 2384756
}

보너스 프로모션 삭제Server-sideAdmin

요청

보너스 프로모션을 삭제합니다. 삭제된 프로모션:

  • 프로젝트에 설정된 프로모션 목록에서 사라집니다.
  • 아이템 카탈로그 및 장바구니에는 더 이상 적용되지 않습니다. 사용자는 이 프로모션으로 보너스 아이템을 얻을 수 없습니다.

삭제한 후에는 프로모션을 복원할 수 없습니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
promotion_idinteger필수

프로모션 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

예제: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/bonus

응답

프로모션이 성공적으로 삭제되었습니다.

응답
콘텐츠 없음

개인 맞춤형 카탈로그

이 API를 사용하여 사용자 특성에 대한 규칙을 지정할 수 있습니다. 사용자가 구체적인 규칙에 대한 모든 조건을 충족하면 개인 맞춤형 아이템이 표시됩니다.

개인 맞춤형 프로모션에 대한 내용은 프로모션 섹션을 참조하십시오.

구매 전에 특성을 전달하려면 엑솔라 로그인 API를 사용하거나 페이 스테이션 API를 사용하여 토큰을 생성하는 동안 user.attributes 특성으로 특성을 전달할 수 있습니다.

작업

관리

작업

관리자

작업

클라이언트

작업

클랜 클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업