API Reference
Start typing to search…

Get by IDs

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

Returns offers data based on specified offer ids

Log in to see full request history
Body Params
ids
array of strings
required
ids*
Responses

Response body
object
offers
array of objects
offers
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)

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.

400

Invalid argument, the ids field is required and should be an array of strings

Updated about 2 months ago

Did this page help you?
Language
URL

Updated about 2 months ago

Did this page help you?