LiveOps API (2.0.0)
- 버전: 2.0.0
- 서버:
https://store.xsolla.com/api - 이메일을 통해 당사에 문의
- 연락처 URL: https://xsolla.com/
- 필수 TLS 버전: 1.2
LiveOps는 프로모션 및 맞춤형 혜택을 통해 진행 중인 플레이어 참여를 독려하는 툴킷입니다.
API를 사용하여 다음 기능을 관리할 수 있습니다:
- 프로모션 - 쿠폰, 프로모션 코드, 할인 및 보너스 캠페인을 생성하고 관리합니다.
- 개인화 - 특정 승인된 사용자에 한해 아이템 카탈로그를 표시하고 프로모션을 적용할 수 있는 조건을 지정합니다.
- 프로모션 한도 - 사용자당 프로모션 사용 횟수에 대한 한도를 설정하고, 해당 한도에 대한 정기적인 초기화 일정을 구성합니다.
- 리워드 체인 및 가치 포인트 - 가치 포인트 적립과 연계된 보상 진행 단계 설정.
- 일일 체인 - 매일 반복되는 보상을 설정하여 정기적인 로그인을 유도합니다.
- 혜택 체인 - 단계별 가격 책정 및 무료 보상 옵션을 통해 순차적 구매 혜택을 구축합니다.
- 업셀링 - 추가적인 가치가 있는 아이템을 구매할 수 있도록 사용자에게 제공되는 판매 방법.
API는 다음 그룹으로 구분됩니다:
Admin - 캠페인 및 체인 구성의 생성, 업데이트, 활성화 및 삭제를 수행합니다. 상품 또는 프로젝트 자격 증명으로 기본 액세스 인증을 통해 인증됩니다.Client - 인증된 최종 사용자를 대신하여 이용 가능한 프로모션을 검색하고, 활성 체인을 확인하며, 코드를 사용하고, 보상을 요청하는 기능을 제공합니다. 사용자 JWT를 통해 인증됩니다.
개인 맞춤형 카탈로그
이 API를 사용하여 사용자 특성에 대한 규칙을 지정할 수 있습니다. 사용자가 구체적인 규칙에 대한 모든 조건을 충족하면 개인 맞춤형 아이템이 표시됩니다.
개인 맞춤형 프로모션에 대한 내용은 프로모션 섹션을 참조하십시오.
구매 전에 특성을 전달하려면 엑솔라 로그인 API를 사용하거나 페이 스테이션 API를 사용하여 토큰을 생성하는 동안 user.attributes 특성으로 특성을 전달할 수 있습니다.
사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 체인 가용성을 결정합니다.
혜택 체인이 종료되는 날짜입니다. null일 수 있습니다. date_end이(가) null인 경우 혜택 체인에는 기간 제한이 없습니다.
혜택 체인이 시작되는 날짜입니다.
아이템 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: en) 또는 다섯 글자 로케일 코드(예: en-US) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: en 및 en-US)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 문서에서 확인할 수 있습니다.
아이템 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: en) 또는 다섯 글자 로케일 코드(예: en-US) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: en 및 en-US)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 문서에서 확인할 수 있습니다.
체인을 모든 사용자에게 표시할지 여부:
true인 경우, 사용자의 인증 상태나 특성에 관계없이 체인이 항상 표시됩니다.false인 경우, 개인화된 체인을 찾을 수 없는 경우에만 체인이 표시됩니다. 예를 들어, 사용자가 인증되지 않았거나 특성이 개인화된 체인과 일치하지 않는 경우에 그러합니다.
개인화된 체인의 컨텍스트에서만 적용되며 attribute_conditions 배열이 전달되지 않은 경우에 사용됩니다.
아이템 이름에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: en) 또는 다섯 글자 언어 코드(예: en-US) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: en 및 en-US)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 문서에서 확인할 수 있습니다.
아이템 이름에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: en) 또는 다섯 글자 언어 코드(예: en-US) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: en 및 en-US)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 문서에서 확인할 수 있습니다.
혜택 체인의 재설정 기간입니다.
혜택 체인의 재설정 기간입니다.
혜택 체인 단계가 무료인지 여부를 나타냅니다.
true인 경우 무료 혜택 체인 단계 신청 호출을 사용하여 해당 단계를 신청해야 합니다.false인 경우 유료 혜택 체인 단계 주문 생성 호출을 사용하여 구매해야 합니다.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/offer_chain
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/liveops/v2/project/{project_id}/admin/offer_chain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/offer_chain \
-H 'Content-Type: application/json' \
-d '{
"date_end": null,
"date_start": "2023-04-15T18:16:00+05:00",
"description": {
"de": "Eine kurze Beschreibung einer regulären Angebotskette",
"en": "A short description of a regular offer chain",
"fr": "Une brève description d'\''une chaîne d'\''offres régulière",
"it": "Una breve descrizione di una catena di offerte regolare",
"ru": "Краткое описание обычной цепочки предложений"
},
"is_always_visible": true,
"is_enabled": true,
"name": {
"de": "Neue Angebotskette",
"en": "New offer chain",
"fr": "Nouvelle chaîne d'\''offres",
"it": "Nuova catena di offerte",
"ru": "Новая цепочка предложений"
},
"order": 4,
"recurrent_schedule": null,
"steps": [
{
"is_free": false,
"items": [
{
"quantity": 2,
"sku": "chain_step_1_paid_bundle_sku"
}
],
"step_number": 1
},
{
"is_free": true,
"items": [
{
"quantity": 1,
"sku": "chain_step_2_free_virtual_good_sku"
}
],
"step_number": 2
},
{
"is_free": false,
"items": [
{
"quantity": 5,
"sku": "chain_step_3_paid_virtual_currency_package_sku"
}
],
"step_number": 3
},
{
"is_free": true,
"items": [
{
"quantity": 1,
"sku": "chain_step_4_free_bundle_sku"
}
],
"step_number": 4
}
]
}'{ "offer_chain_id": 10 }
요청
특정 혜택 체인을 삭제합니다.
삭제 후:
- 사용자가 이미 받은 모든 리워드는 유지됩니다.
- 완료되지 않은 단계는 사용할 수 없게 되며 해당 리워드는 더 이상 받을 수 없습니다.
혜택 체인 토글 전환 호출을 통해 혜택 체인을 비활성화하는 것과 달리, 삭제는 취소할 수 없으며 사용자 진행 상황은 보존되지 않습니다.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/liveops/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/offer_chain/id/101- https://store.xsolla.com/api/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/liveops/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/offer_chain/id/101혜택 체인 데이터를 성공적으로 조회했습니다.
사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 체인 가용성을 결정합니다.
혜택 체인이 종료되는 날짜입니다. null일 수 있습니다. date_end이(가) null인 경우 혜택 체인에는 기간 제한이 없습니다.
혜택 체인이 시작되는 날짜입니다.
아이템 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: en) 또는 다섯 글자 로케일 코드(예: en-US) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: en 및 en-US)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 문서에서 확인할 수 있습니다.
아이템 설명에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: en) 또는 다섯 글자 로케일 코드(예: en-US) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: en 및 en-US)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 문서에서 확인할 수 있습니다.
체인을 모든 사용자에게 표시할지 여부:
true인 경우, 사용자의 인증 상태나 특성에 관계없이 체인이 항상 표시됩니다.false인 경우, 개인화된 체인을 찾을 수 없는 경우에만 체인이 표시됩니다. 예를 들어, 사용자가 인증되지 않았거나 특성이 개인화된 체인과 일치하지 않는 경우에 그러합니다.
개인화된 체인의 컨텍스트에서만 적용되며 attribute_conditions 배열이 전달되지 않은 경우에 사용됩니다.
아이템 이름에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: en) 또는 다섯 글자 언어 코드(예: en-US) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: en 및 en-US)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 문서에서 확인할 수 있습니다.
아이템 이름에 대한 현지화가 있는 개체입니다. 두 글자 소문자 언어 코드(예: en) 또는 다섯 글자 언어 코드(예: en-US) 두 가지 형식 중 하나로 되어 있는 값을 허용합니다. 두 형식 모두 입력으로 허용되지만 응답은 두 글자 소문자 언어 코드를 반환합니다. 동일한 언어에 대한 두 옵션(예: en 및 en-US)이 모두 제공되면 마지막으로 제공된 값이 저장됩니다. 지원되는 언어의 전체 목록은 문서에서 확인할 수 있습니다.
{ "attribute_conditions": [ { … }, { … }, { … } ], "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2023-04-15T18:16:00+05:00", "description": { "de": "Personalisierte Angebotskette mit Benutzerattributbedingungen - für Elfen der Stufe 10 und höher, die Stufe 10 spätestens am 2026-01-01 00:00:00 erreicht haben, einschließlich", "en": "Personalized offer chain with user attribute conditions - for level 10 and above elves who reached level 10 no later than 2026-01-01 00:00:00, inclusive", "fr": "Chaîne d'offres personnalisée avec des conditions d'attribut utilisateur - pour les elfes de niveau 10 et plus qui ont atteint le niveau 10 au plus tard le 2026-01-01 00:00:00, inclus", "it": "Catena di offerte personalizzata con condizioni di attributo utente - per elfi di livello 10 e superiore che hanno raggiunto il livello 10 non più tardi del 2026-01-01 00:00:00, inclusi", "ru": "Персонализированная цепочка предложений - для эльфов 10 уровня и выше, достигших 10 уровня не позднее 2026-01-01 00:00:00 включительно" }, "id": 3, "is_always_visible": false, "is_enabled": true, "name": { "de": "Angebotskette", "en": "Offer chain", "fr": "Chaîne d'offres", "it": "Catena di offerte", "ru": "Цепочка" }, "order": 1, "recurrent_schedule": null, "steps": [ { … }, { … }, { … } ] }