Get the property set for the given short Code.

View interactive version here

Request Parameters

Parameter Required Type Description
propertySetShortCode Yes string The shortCode of the property set to return.

Response Parameters

A response containing the requested property set

Parameter Type Description
propertySet JSON The property set
scriptData ScriptData A JSON Map of any data added either to the Request or the Response by your Cloud Code

Nested types


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.

Error Codes

Key Value Description
propertySet NOT_FOUND No propertySet with given shortCode could be found.

Code Samples


    using GameSparks.Api;
    using GameSparks.Api.Requests;
    using GameSparks.Api.Responses;
    new GetPropertySetRequest()
        .Send((response) => {
        GSData propertySet = response.PropertySet;
        GSData scriptData = response.ScriptData;

ActionScript 3

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

        .send(function(response:com.gamesparks.api.responses.GetPropertySetResponse):void {
        var propertySet:Object = response.getPropertySet(); 
        var scriptData:ScriptData = response.getScriptData(); 


    #import "GS.h"
    #import "GSAPI.h"
    GSGetPropertySetRequest* request = [[GSGetPropertySetRequest alloc] init];
    [request setPropertySetShortCode:propertySetShortCode;
    [request setCallback:^ (GSGetPropertySetResponse* response) {
    NSDictionary* propertySet = [response getPropertySet]; 
    NSDictionary* scriptData = [response getScriptData]; 
    [gs send:request];


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

    void GetPropertySetRequest_Response(GS& gsInstance, const GetPropertySetResponse& response) {
    GSData propertySet = response.getPropertySet(); 
    GSData scriptData = response.getScriptData(); 

    GetPropertySetRequest request(gsInstance);


import com.gamesparks.sdk.api.autogen.GSRequestBuilder.GetPropertySetRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.GetPropertySetResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

    .send(new GSEventListener<GetPropertySetResponse>() {
        public void onEvent(GetPropertySetResponse response) {
            GSData propertySet = response.getPropertySet(); 

Cloud Code

    var request = new SparkRequests.GetPropertySetRequest();
    request.propertySetShortCode = ...;
    var response = request.Send();

var propertySet = response.propertySet; 
var scriptData = response.scriptData; 
Did this page help you? Please enter your feedback below.