Belohnungskette erstellen

Xsolla Developers

oder

Zum Kundenportal

Belohnungskette erstellenServer-sideAdmin

post/v2/project/{project_id}/admin/reward_chain

Erstellt eine Belohnungskette.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Example: 44056

Request Body schema: application/json

One of:

Eine Belohnungskette.

required

(two-letter (object or null)) or (five-letter (object or null))

Objekt mit Lokalisierungen für Artikelnamen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

required

object

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$

Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

date_start

required

string <date-time>

Datum, an dem Ihre Belohnungskette beginnt.

required

Array of objects

Array

required

(two-letter (object or null)) or (five-letter (object or null))

One of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

required

object

amount

required

integer

Stufenpreis in Wertpunkten.

required

Array of objects

Array

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\-–.]*$

Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

quantity

required

integer

Artikelmenge.

Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)

One of:

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

Benutzerattributcode.

operator

required

string

Art der durchgeführten Operation nach Bedingung. Für den Attributtyp string.

Enum:	Description
eq	Gleich
ne	Ungleich

value

required

string <= 255 characters

Bedingungswert, mit dem der Benutzerattributwert verglichen wird. Der Typ hängt vom Attributtyp ab.

type

required

string

Benutzerattributtyp.

Value: "string"

can_be_missing

boolean

Gibt an, dass die Bedingung erfüllt ist, auch wenn das Attribut in den Benutzerattributen fehlt. Übermitteln Sie true, um den Artikel den Nutzern anzuzeigen, die dieses Attribut nicht haben. Nutzer, die das Attribut haben, dessen Wert jedoch nicht mit dem in der Bedingung angegebenen Wert übereinstimmt, sehen den Artikel nicht. false – Nutzer, die das Attribut haben, dessen Wert jedoch nicht mit dem in der Bedingung angegebenen Wert übereinstimmt oder bei denen das Attribut fehlt, sehen den Artikel nicht.

image_url

string or null

Bild-URL.

is_enabled

required

boolean

Array of type = string (objects) or Array of type = date (objects) or Array of type = number (objects)

One of:

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

Benutzerattributcode.

operator

required

string

Art der durchgeführten Operation nach Bedingung. Für den Attributtyp string.

Enum:	Description
eq	Gleich
ne	Ungleich

value

required

string <= 255 characters

Bedingungswert, mit dem der Benutzerattributwert verglichen wird. Der Typ hängt vom Attributtyp ab.

type

required

string

Benutzerattributtyp.

Value: "string"

can_be_missing

boolean

date_end

string or null <date-time>

Datum, an dem Ihre Belohungsketten-Aktion endet. Darf null sein. Ist für date_end der Wert null festgelegt, ist die Belohnungskette zeitlich unbegrenzt.

(two-letter (object or null)) or (five-letter (object or null))

Objekt mit Lokalisierungen für Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

image_url

string or null

Bild-URL.

is_always_visible

boolean

Default: true

Ob die Belohnungskette für alle Nutzer sichtbar ist:

Wenn true festgelegt ist, wird die Kette immer angezeigt, unabhängig vom Authentifizierungsstatus oder den Attributen des Nutzers.
Wenn false festgelegt ist, wird die Kette nur dann angezeigt, wenn keine passende Belohnungskette gefunden wird. Zum Beispiel, wenn der Nutzer nicht authentifiziert ist oder für seine Attribute keine personalisierte Kette vorliegt.

Gilt nur im Rahmen personalisierter Belohnungsketten und kommt zum Einsatz, wenn das Array attribute_conditions nicht übermittelt wird.

(two-letter (object or null)) or (five-letter (object or null))

Objekt mit Lokalisierungen für lange Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Varianten angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

Any of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

order

integer

Definiert die Anordnungsreihenfolge.

(interval_type = weekly (object or null)) or (interval_type = monthly (object or null))

Wiederkehrender Reset-Zeitraum der Belohnungskette.

One of:

Belohnungskette wird wöchentlich zurückgesetzt.

interval_type required	string Wie oft die Belohnungskette zurückgesetzt wird. Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Zu welcher Uhrzeit die Belohnungskette in der gewünschten Zeitzone zurückgesetzt wird (auf volle Stunden gerundet). Beispiel: Es ist festgelegt, dass in der Zeitzone Kuala Lumpur (GMT+8) die Belohungskette um 01:00 Uhr zurückgesetzt wird. In diesem Fall lautet der Wert des Parameters `time`: "01:00:00+08:00".
day_of_week required	integer [ 1 .. 7 ] Wochentag, an dem die Belohnungskette zurückgesetzt wird, wobei "1" für Montag und "7" für Sonntag steht.

Responses

201

Die Belohnungskette wurde erfolgreich erstellt.

401

Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.

422

Ungültige Anfrage.

Request samples

application/json

{"clan_type": "guild",
"date_end": "2021-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"description": {"en": "Clan reward chain description."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {"en": "Clan reward chain long description."
},
"name": {"en": "Clan reward chain"
},
"order": 1,
"popup_header": {"en": "How to unlock rewards"
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"popup_instruction": {"en": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"recurrent_schedule": {"day_of_week": 1,
"interval_type": "weekly",
"time": "01:00:00+08:00"
},
"steps": [{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "First step of the reward chain"
},
"price": {"amount": 10
},
"reward": [{"quantity": 5,
"sku": "com.xsolla.item_1"
},
{"quantity": 1,
"sku": "com.xsolla.item_2"
}
]
},
{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "Second step of the reward chain"
},
"price": {"amount": 15
},
"reward": [{"quantity": 5,
"sku": "com.xsolla.item_3"
},
{"quantity": 1,
"sku": "com.xsolla.item_4"
}
]
}
],
"value_point": {"sku": "com.xsolla.clan_value_point_1"
}
}

Response samples

application/json

{"reward_chain_id": 10
}