API Reference of GS2-SerialKey SDK for Game Engine

Model

EzCampaignModel

Campaign Model

TypeRequireDefaultLimitationDescription
namestring~ 128 charsCampaign name
metadatastring~ 2048 charsmetadata
enableCampaignCodeboolfalseAllow redemption with campaign code

EzSerialKey

Serial Code

The serial code issued can be used only once. Serial codes are issued in the format “RPCLP-FP7N-NCDMJ-FLVA-IRI4” and the data length cannot be changed. Information on the type of campaign is also included within the serial code. When using the serial code, simply specify the namespace in which the serial code is to be used.

TypeRequireDefaultLimitationDescription
campaignModelNamestring~ 128 charsCampaign name
metadatastring~ 2048 charsmetadata
codestring~ 48 charsSerial Code
statusenum [‘ACTIVE’, ‘USED’, ‘INACTIVE’]“ACTIVE”~ 128 charsStatus

Methods

getCampaignModel

Get campaign model

Request

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 32 charsNamespace name
campaignModelNamestring~ 128 charsCampaign name

Result

TypeDescription
itemEzCampaignModelCampaign Model

Implementation Example

    var domain = gs2.SerialKey.Namespace(
        namespaceName: "namespace-0001"
    ).CampaignModel(
        campaignModelName: "campaign-0001"
    );
    var item = await domain.ModelAsync();
    var domain = gs2.SerialKey.Namespace(
        namespaceName: "namespace-0001"
    ).CampaignModel(
        campaignModelName: "campaign-0001"
    );
    var future = domain.Model();
    yield return future;
    var item = future.Result;
    const auto Domain = Gs2->SerialKey->Namespace(
        "namespace-0001" // namespaceName
    )->CampaignModel(
        "campaign-0001" // campaignModelName
    );
    const auto item = Domain.Model();

get

Get Serial Code

Request

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 32 charsNamespace name
codestring~ 48 charsSerial Code

Result

TypeDescription
itemEzSerialKeySerial Key
campaignModelEzCampaignModelCampaign Model

Implementation Example

    var domain = gs2.SerialKey.Namespace(
        namespaceName: "namespace-0001"
    ).User(
        userId: null
    );
    var result = await domain.GetAsync(
        code: "code-0001"
    );
    var item = await result.ModelAsync();
    var domain = gs2.SerialKey.Namespace(
        namespaceName: "namespace-0001"
    ).User(
        userId: null
    );
    var future = domain.Get(
        code: "code-0001"
    );
    yield return future;
    if (future.Error != null)
    {
        onError.Invoke(future.Error, null);
        yield break;
    }
    var future2 = future.Result.Model();
    yield return future2;
    if (future2.Error != null)
    {
        onError.Invoke(future2.Error, null);
        yield break;
    }
    var result = future2.Result;
    const auto Domain = Gs2->SerialKey->Namespace(
        "namespace-0001" // namespaceName
    )->User(
        nullptr // userId
    );
    const auto Future = Domain->Get(
        "code-0001"
    );
    Future->StartSynchronousTask();
    if (Future->GetTask().IsError())
    {
        return false;
    }

    // obtain changed values / result values
    const auto Future2 = Future->GetTask().Result()->Model();
    Future2->StartSynchronousTask();
    if (!TestFalse(WHAT, Future2->GetTask().IsError())) return false;
    const auto Result = Future2->GetTask().Result();

useSerialCode

Consume Serial Code

Request

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 32 charsNamespace name
accessTokenstring~ 128 charsUser Id
codestring~ 48 charsSerial Code

Result

TypeDescription
itemEzSerialKeySerial Key
campaignModelEzCampaignModelCampaign Model

Error

Special exceptions are defined in this API. GS2-SDK for GameEngine provides specialized exceptions derived from general exceptions to facilitate handling of errors that may need to be handled in games. Please refer to the documentation here for more information on common error types and handling methods.

TypeBase TypeDescription
AlreadyUsedExceptionBadRequestExceptionThe specified serial code has already been used.
CodeNotFoundExceptionNotFoundExceptionThe specified serial code does not exist.

Implementation Example

try {
    var domain = gs2.SerialKey.Namespace(
        namespaceName: "namespace-0001"
    ).Me(
        gameSession: GameSession
    ).SerialKey(
        serialKeyCode: null
    );
    var result = await domain.UseSerialCodeAsync(
        code: "code-0001"
    );
    var item = await result.ModelAsync();
} catch(Gs2.Gs2SerialKey.Exception.AlreadyUsed e) {
    // The specified serial code has already been used.
} catch(Gs2.Gs2SerialKey.Exception.CodeNotFound e) {
    // The specified serial code does not exist.
}
    var domain = gs2.SerialKey.Namespace(
        namespaceName: "namespace-0001"
    ).Me(
        gameSession: GameSession
    ).SerialKey(
        serialKeyCode: null
    );
    var future = domain.UseSerialCode(
        code: "code-0001"
    );
    yield return future;
    if (future.Error != null)
    {
        if (future.Error is Gs2.Gs2SerialKey.Exception.AlreadyUsedException)
        {
            // The specified serial code has already been used.
        }
        if (future.Error is Gs2.Gs2SerialKey.Exception.CodeNotFoundException)
        {
            // The specified serial code does not exist.
        }
        onError.Invoke(future.Error, null);
        yield break;
    }
    var future2 = future.Result.Model();
    yield return future2;
    if (future2.Error != null)
    {
        onError.Invoke(future2.Error, null);
        yield break;
    }
    var result = future2.Result;
    const auto Domain = Gs2->SerialKey->Namespace(
        "namespace-0001" // namespaceName
    )->Me(
        AccessToken
    )->SerialKey(
        nullptr // serialKeyCode
    );
    const auto Future = Domain->UseSerialCode(
        "code-0001"
    );
    Future->StartSynchronousTask();
    if (Future->GetTask().IsError())
    {
        if (Gs2::SerialKey::Error::FAlreadyUsedError::TypeString == Task->GetTask().Error()->Type())
        {
            // The specified serial code has already been used.
        }
        if (Gs2::SerialKey::Error::FCodeNotFoundError::TypeString == Task->GetTask().Error()->Type())
        {
            // The specified serial code does not exist.
        }
        return false;
    }

    // obtain changed values / result values
    const auto Future2 = Future->GetTask().Result()->Model();
    Future2->StartSynchronousTask();
    if (!TestFalse(WHAT, Future2->GetTask().IsError())) return false;
    const auto Result = Future2->GetTask().Result();