ListVirtualGoodsRequest

Returns the list of configured virtual goods.

View interactive version here

Request Parameters

Parameter	Required	Type	Description
includeDisabled	No	boolean	If true, the returned list will include disabled VirtualGoods
tags	No	string[]	A filter to only include goods with the given tags. Each good must have all the provided tags.

Response Parameters

A response containing the list of configured virtual goods.

Parameter	Type	Description
scriptData	ScriptData	A JSON Map of any data added either to the Request or the Response by your Cloud Code
virtualGoods	VirtualGood[]	A list of JSON objects containing virtual goods data

Nested types

BundledGood

A collection of arbitrary data that can be added to a message via a Cloud Code script.

Parameter	Type	Description
qty	number	The number of items bundled
shortCode	string	The shortCode of the bundled good

ScriptData

A collection of arbitrary data that can be added to a message via a Cloud Code script.

Parameter	Type	Description
myKey	string	An arbitrary data key
myValue	JSON	An arbitrary data value.

VirtualGood

A nested object that represents the virtual good.

Parameter	Type	Description
WP8StoreProductId	string	The Windows Phone 8 productId of the item.
amazonStoreProductId	string	The Amazon Store productId of the item.
baseCurrency1Cost	number	The Base Currency1 cost of the Virtual Good, before segmentation
baseCurrency2Cost	number	The Base Currency2 cost of the Virtual Good, before segmentation
baseCurrency3Cost	number	The Base Currency3 cost of the Virtual Good, before segmentation
baseCurrency4Cost	number	The Base Currency4 cost of the Virtual Good, before segmentation
baseCurrency5Cost	number	The Base Currency5 cost of the Virtual Good, before segmentation
baseCurrency6Cost	number	The Base Currency6 cost of the Virtual Good, before segmentation
baseCurrencyCosts	JSON	The Base currency costs of the Virtual Good, before experiments
bundledGoods	BundledGood[]	Returns the bundle goods of the virtual good
currency1Cost	number	The Currency1 cost of the Virtual Good
currency2Cost	number	The Currency2 cost of the Virtual Good
currency3Cost	number	The Currency3 cost of the Virtual Good
currency4Cost	number	The Currency4 cost of the Virtual Good
currency5Cost	number	The Currency5 cost of the Virtual Good
currency6Cost	number	The Currency6 cost of the Virtual Good
currencyCosts	JSON	The currency costs of the Virtual Good
description	string	The description of the Virtual Good
disabled	boolean	Whether the item is disabled.
googlePlayProductId	string	The google play productId of the item.
iosAppStoreProductId	string	The iOS AppStore productId of the item.
maxQuantity	number	The maximum number of the Virtual Good that can be owned at one time
name	string	The name of the Virtual Good
propertySet	JSON	The custom property set configured on the item.
psnStoreProductId	string	The PSN Store productId of the item.
segmentedCurrency1Cost	number	The Segmented Currency1 cost of the Virtual Good, before experiments
segmentedCurrency2Cost	number	The Segmented Currency2 cost of the Virtual Good, before experiments
segmentedCurrency3Cost	number	The Segmented Currency3 cost of the Virtual Good, before experiments
segmentedCurrency4Cost	number	The Segmented Currency4 cost of the Virtual Good, before experiments
segmentedCurrency5Cost	number	The Segmented Currency5 cost of the Virtual Good, before experiments
segmentedCurrency6Cost	number	The Segmented Currency6 cost of the Virtual Good, before experiments
segmentedCurrencyCosts	JSON	The segmented currency costs of the Virtual Good, before experiments
shortCode	string	The short code of the Virtual Good
steamStoreProductId	string	The Steam Store productId of the item.
tags	string	The tags of the Virtual Good
type	string	The type of the virtual good, "VGOOD" or "CURRENCY"
w8StoreProductId	string	The Windows 8 productId of the item.

Error Codes

Key	Value	Description
authentication	NOTAUTHORIZED	The player is not authorized to perform the request

Code Samples

C#

    using GameSparks.Api;
    using GameSparks.Api.Requests;
    using GameSparks.Api.Responses;
    ...
    new ListVirtualGoodsRequest()
        .SetIncludeDisabled(includeDisabled)
        .SetTags(tags)
        .Send((response) => {
        GSData scriptData = response.ScriptData;
        GSEnumerable<ListVirtualGoodsResponse._VirtualGood> virtualGoods = response.VirtualGoods;
        });

ActionScript 3

    import com.gamesparks.*;
    import com.gamesparks.api.requests.*;
    import com.gamesparks.api.responses.*;
    import com.gamesparks.api.types.*;
    ...

    gs.getRequestBuilder()
        .createListVirtualGoodsRequest()
        .setIncludeDisabled(includeDisabled)
        .setTags(tags)
        .send(function(response:com.gamesparks.api.responses.ListVirtualGoodsResponse):void {
        var scriptData:ScriptData = response.getScriptData(); 
        var virtualGoods:Vector.<VirtualGood> = response.getVirtualGoods(); 
        });

Objective-C

    #import "GS.h"
    #import "GSAPI.h"
    ...
    GSListVirtualGoodsRequest* request = [[GSListVirtualGoodsRequest alloc] init];
    [request setIncludeDisabled:includeDisabled;
    [request setTags:tags;
    [request setCallback:^ (GSListVirtualGoodsResponse* response) {
    NSDictionary* scriptData = [response getScriptData]; 
    NSArray* virtualGoods = [response getVirtualGoods]; 
    }];
    [gs send:request];

C++

    #include <GameSparks/generated/GSRequests.h>
    using namespace GameSparks::Core;
    using namespace GameSparks::Api::Responses;
    using namespace GameSparks::Api::Requests;
    ...

    void ListVirtualGoodsRequest_Response(GS& gsInstance, const ListVirtualGoodsResponse& response) {
    GSData scriptData = response.getScriptData(); 
    gsstl:vector<Types::VirtualGood*> virtualGoods = response.getVirtualGoods(); 
    }
    ......

    ListVirtualGoodsRequest request(gsInstance);
    request.SetIncludeDisabled(includeDisabled)
    request.SetTags(tags)
    request.Send(ListVirtualGoodsRequest_Response);

Java

import com.gamesparks.sdk.api.autogen.GSRequestBuilder.ListVirtualGoodsRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.ListVirtualGoodsResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

...
gs.getRequestBuilder().createListVirtualGoodsRequest()
    .setIncludeDisabled(includeDisabled)
    .setTags(tags)
    .send(new GSEventListener<ListVirtualGoodsResponse>() {
        @Override
        public void onEvent(ListVirtualGoodsResponse response) {
            List<VirtualGood> virtualGoods = response.getVirtualGoods(); 
        }
    });

Cloud Code

    var request = new SparkRequests.ListVirtualGoodsRequest();
    request.includeDisabled = ...;
    request.tags = ...;
    var response = request.Send();

var scriptData = response.scriptData; 
var virtualGoods = response.virtualGoods;