API Reference
Start typing to search…

Add

post https://us-central1-readysandbox.cloudfunctions.net/storeV2-add

Add new store offer containing virtual items

Log in to see full request history
Body Params
string | null

Unique id of the store offer

string | null

StoreV2 offer name
Is used also to store localization key for the name

string | null

StoreV2 offer description
Is used also to store localization key for the name

string | null

StoreV2 offer request name
Is used to identify the offer in human readable format

array of strings | null

List of application ids where this item is used

appIds
array of strings | null

List of tags to filter the offers
You can place multiple store offers into one category tag
For example in a shooter game: "guns", "rifles"
Or you can also have one store offer for every category
with multiple virtual items

tags
string | null

StoreV2 offer image url

object | null

The time when the store offer is available
This is used for limited time offers (LTO)

array of objects | null

List of store offer custom json. It is used to store
game specific json in json format.
For example: you can attach some json like
"additiona_description", "in_app_products" to this offer

properties
array of strings | null

Virtual items ids list
It contains the virtual items available to sell

itemIds
array of objects | null

Price information for the store offer virtual items
It is very powerful: you can sell the same virtual item for different
currencies and prices in the same store offer.
You can also combine two and more {currency, price} to sell one item
by using the group field. To "group" currencies and prices together.

prices
requiredToPurchase
object

Object with the requirements to purchase the store offer
The object contains the list of requirements to purchase the store offer and the
operation to perform with the requirements.

Responses

Response body
object
string | null

Unique id of the store offer

string | null

StoreV2 offer name
Is used also to store localization key for the name

string | null

StoreV2 offer description
Is used also to store localization key for the name

string | null

StoreV2 offer request name
Is used to identify the offer in human readable format

array of strings | null

List of application ids where this item is used

appIds
array of strings | null

List of tags to filter the offers
You can place multiple store offers into one category tag
For example in a shooter game: "guns", "rifles"
Or you can also have one store offer for every category
with multiple virtual items

tags
string | null

StoreV2 offer image url

int64

Date and time when the store offer was created
In milliseconds since midnight, January 1, 1970 UTC.
This field is automatically populated by the backend

int64

Date and time when the store offer data was last time updated
In milliseconds since midnight, January 1, 1970 UTC.
This field is automatically populated by the backend

string | null

User Id who created the store offer
This field is automatically populated by the backend

string | null

User Id who last time updated the store offer
This field is automatically populated by the backend

object | null

The time when the store offer is available
This is used for limited time offers (LTO)

boolean

Indicates whether a start time is specified. Is populated by the type-safe clients if there is no way to leave a property undefined.

int64

The start time in milliseconds since midnight, January 1, 1970 UTC. This field is relevant only if hasStart is not false.

boolean

Indicates whether an end time is specified. Is populated by the type-safe clients if there is no way to leave a property undefined.

int64

The end time in milliseconds since midnight, January 1, 1970 UTC. This field is relevant only if hasEnd is not false.

boolean

Indicates whether an interval is specified. Is populated by the type-safe clients if there is no way to leave a property undefined.

int64

The interval duration in milliseconds. This field is relevant only if hasInterval is not false.

int64

The interval delay in milliseconds. This field is relevant only if hasInterval is not false.

boolean

Indicates whether a promo is specified. Is populated by the type-safe clients if there is no way to leave a property undefined.

int64

The promo time in milliseconds before the start time. This field is relevant only if hasPromo and hasStart are not false.

boolean

Indicates whether a grace period is specified. Is populated by the type-safe clients if there is no way to leave a property undefined.

int64

The grace period in milliseconds after the end time. This field is relevant only if hasGrace and hasEnd are not false.

array of objects | null

List of store offer custom json. It is used to store
game specific json in json format.
For example: you can attach some json like
"additiona_description", "in_app_products" to this offer

properties
object
array of strings | null
appIds
string | null
array of strings | null

Virtual items ids list
It contains the virtual items available to sell

itemIds
array of objects | null

Price information for the store offer virtual items
It is very powerful: you can sell the same virtual item for different
currencies and prices in the same store offer.
You can also combine two and more {currency, price} to sell one item
by using the group field. To "group" currencies and prices together.

prices
object
array of strings | null

List of application ids where this price information is used

appIds
string | null

Virtual item id related to this price information This field is optional. If it is not set, then the price is for the whole store offer

string | null

Name of the coin. Reserved name is "rgn-coin" This field is used to calculate the price of the virtual item For example: if you sell a virtual item for 100 coins, then the name is "coin_name" This field is optional. If it is not set, then the name is "rgn-coin"

int32

Quantity of the coins the virtual item is sold for This field is used to calculate the price of the virtual item For example: if you sell a virtual item for 100 coins, then the quantity is 100

int32

Quantity of the coins the virtual item is sold for without discount This field serves UI purposes to indicate "for sale" items

string | null

Group information of the price. It is possible to group multiple prices together. For example, you can sell a virtual item for "coin_name_1" and "coin_name_2" coins. This field works like a tag. Two prices with the same group name are combined together.

int64

Date and time when the price will be updated in milliseconds since midnight, January 1, 1970 UTC.

requiredToPurchase
object

Object with the requirements to purchase the store offer
The object contains the list of requirements to purchase the store offer and the
operation to perform with the requirements.

string

The operation to be performed on the requirement.
Available operations are:

  • and - the user must meet all of the requirements.
  • or - the user must meet at least one of the requirements.
  • not - the user must not meet the requirement.

and or not

requirements
array of objects

The list of requirements.

requirements
object
string
required
  • gamepass_by_id
  • gamepass_by_request_name
  • item_by_id
  • item_by_tag
  • achievement_by_id
  • achievement_by_request_name
  • social_connected
  • discord_joined_server
  • discord_has_role
  • twitter_retweeted
  • twitter_liked
  • twitter_replied

Specifies the type of the requirement.
Available types are:

  • gamepass_by_id - the user needs to have a gamepass with a specific id to join a leaderboard, purchase a
    store offer or complete an achievement.
  • gamepass_by_request_name - the user needs to have a gamepass with a specific request name to join a
    leaderboard, purchase a store offer or complete an achievement.
  • item_by_id - the user needs to have a virtual item with a specific id to join a leaderboard, purchase a
    store offer or complete an achievement.
  • item_by_tag - the user needs to have a virtual item with a specific tag to join a leaderboard, purchase a
    store offer or complete an achievement.
  • achievement_by_id - the user needs to complete an achievement to join a leaderboard, purchase a store
    offer or complete an achievement.
  • achievement_by_request_name - the user needs to complete an achievement with a specific request name to
    join a leaderboard, purchase a store offer or complete an achievement.
  • social_connected - the user needs to connect their social account to join a leaderboard, purchase a store
    offer or complete an achievement. The 'id' field is the social network id: 'discord' or 'twitter'.
  • discord_joined_server - the user needs to join a specific Discord server to join a leaderboard, purchase a
    store offer or complete an achievement.
  • discord_has_role - the user needs to have a specific role in a Discord server to join a leaderboard,
    purchase a store offer or complete an achievement.
  • twitter_retweeted - the user needs to retweet a specific tweet to join a leaderboard, purchase a store
    offer or complete an achievement.
  • twitter_liked - the user needs to like a specific tweet to join a leaderboard, purchase a store offer or
    complete an achievement.
  • twitter_replied - the user needs to reply to a specific tweet to join a leaderboard, purchase a store offer
    or complete an achievement.

gamepass_by_id gamepass_by_request_name item_by_id item_by_tag achievement_by_id achievement_by_request_name social_connected discord_joined_server discord_has_role twitter_retweeted twitter_liked twitter_replied

string
required

The id field is used to provide the data: - gamepass_by_id - the 'id' is the gamepass id. - gamepass_by_request_name - the 'id' is the gamepass request name. - item_by_id - the 'id' is the virtual item id. - item_by_tag - the 'id' is the virtual item tag. - achievement_by_id - the 'id' is the achievement id. - achievement_by_request_name - the 'id' is the achievement request name. - discord_joined_server - the 'id' is the Discord server/guild id. - discord_has_role - the 'id' is the Discord server/guild id. Additionaly 'payload' parameter is excpected for

the Discord role id.

  • twitter_retweeted - the 'id' is the tweet id. - twitter_liked - the 'id' is the tweet id. - twitter_replied - the 'id' is the tweet id.
400

Bad request, invalid argument.

403

Permission denied, item should belong to the caller application.

Updated about 2 months ago

Did this page help you?
Language
Credentials
URL

Updated about 2 months ago

Did this page help you?