GS2-AdReward SDK API リファレンス

モデル

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

有効化条件必須デフォルト値の制限説明
namespaceIdstring~ 1024文字ネームスペースGRN
namestring~ 32文字ネームスペース名
descriptionstring~ 1024文字説明文
admobAdMobAdMobの設定
unityAdUnityAdUnity Ads の設定
changePointNotificationNotificationSetting広告視聴によりポイントが変動した時のプッシュ通知
logSettingLogSettingログの出力設定
createdAtlong作成日時
updatedAtlong最終更新日時
revisionlong0~ 9223372036854775805リビジョン

Point

ポイント

広告リワードのポイントを保持するモデルです。 広告視聴をするごとに1ポイント入手することが可能です。

有効化条件必須デフォルト値の制限説明
pointIdstring~ 1024文字広告リワードポイントGRN
userIdstring~ 128文字ユーザーID
pointlong0~ 9223372036854775805ポイントの所持数
createdAtlong作成日時
updatedAtlong最終更新日時
revisionlong0~ 9223372036854775805リビジョン

History

広告の視聴履歴

有効化条件必須デフォルト値の制限説明
providerenum [‘admob’, ‘unityAds’]~ 128文字プロバイダ
transactionIdstring~ 128文字トランザクションID
createdAtlong作成日時
revisionlong0~ 9223372036854775805リビジョン

AdMob

有効化条件必須デフォルト値の制限説明
allowAdUnitIdsList<string>許可する広告ユニットIDリスト

UnityAd

有効化条件必須デフォルト値の制限説明
keysList<string>暗号鍵のリスト

NotificationSetting

有効化条件必須デフォルト値の制限説明
gatewayNamespaceIdstring~ 1024文字ネームスペースGRN
enableTransferMobileNotificationbool?モバイルプッシュ通知へ転送するか
soundstring~ 1024文字モバイルプッシュ通知で使用するサウンドファイル名

LogSetting

有効化条件必須デフォルト値の制限説明
loggingNamespaceIdstring~ 1024文字ネームスペースGRN

メソッド

describeNamespaces

ネームスペースの一覧を取得

Request

有効化条件必須デフォルト値の制限説明
pageTokenstring~ 1024文字データの取得を開始する位置を指定するトークン
limitint301 ~ 1000データの取得件数

Result

説明
itemsList<Namespace>ネームスペースのリスト
nextPageTokenstringリストの続きを取得するためのページトークン

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.DescribeNamespaces(
    &ad_reward.DescribeNamespacesRequest {
        PageToken: nil,
        Limit: nil,
    }
)
if err != nil {
    panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\DescribeNamespacesRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->describeNamespaces(
        (new DescribeNamespacesRequest())
            ->withPageToken(null)
            ->withLimit(null)
    );
    $items = $result->getItems();
    $nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.DescribeNamespacesRequest;
import io.gs2.adReward.result.DescribeNamespacesResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    DescribeNamespacesResult result = client.describeNamespaces(
        new DescribeNamespacesRequest()
            .withPageToken(null)
            .withLimit(null)
    );
    List<Namespace> items = result.getItems();
    String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.DescribeNamespacesRequest;
using Gs2.Gs2AdReward.Result.DescribeNamespacesResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.DescribeNamespacesResult> asyncResult = null;
yield return client.DescribeNamespaces(
    new Gs2.Gs2AdReward.Request.DescribeNamespacesRequest()
        .WithPageToken(null)
        .WithLimit(null),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.describeNamespaces(
        new Gs2AdReward.DescribeNamespacesRequest()
            .withPageToken(null)
            .withLimit(null)
    );
    const items = result.getItems();
    const nextPageToken = result.getNextPageToken();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.describe_namespaces(
        ad_reward.DescribeNamespacesRequest()
            .with_page_token(None)
            .with_limit(None)
    )
    items = result.items
    next_page_token = result.next_page_token
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.describe_namespaces({
    pageToken=nil,
    limit=nil,
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;

createNamespace

ネームスペースを新規作成

Request

有効化条件必須デフォルト値の制限説明
namestring~ 32文字ネームスペース名
admobAdMobAdMobの設定
unityAdUnityAdUnity Ads の設定
descriptionstring~ 1024文字説明文
changePointNotificationNotificationSetting広告視聴によりポイントが変動した時のプッシュ通知
logSettingLogSettingログの出力設定

Result

説明
itemNamespace作成したネームスペース

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.CreateNamespace(
    &ad_reward.CreateNamespaceRequest {
        Name: pointy.String("namespace1"),
        Admob: &adReward.AdMob{
            AllowAdUnitIds: []*string{
                pointy.String("1"),
            pointy.String("2"),
            pointy.String("3"),
            },
        },
        UnityAd: &adReward.UnityAd{
            Keys: []*string{
                pointy.String("key-0001"),
            pointy.String("key-0002"),
            },
        },
        Description: nil,
        ChangePointNotification: &adReward.NotificationSetting{
            GatewayNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1"),
        },
        LogSetting: &adReward.LogSetting{
            LoggingNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1"),
        },
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\CreateNamespaceRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->createNamespace(
        (new CreateNamespaceRequest())
            ->withName(self::namespace1)
            ->withAdmob((new \Gs2\AdReward\Model\AdMob())
                ->withAllowAdUnitIds([    "1",
            "2",
            "3",
            ]))
            ->withUnityAd((new \Gs2\AdReward\Model\UnityAd())
                ->withKeys([    "key-0001",
            "key-0002",
            ]))
            ->withDescription(null)
            ->withChangePointNotification((new \Gs2\AdReward\Model\NotificationSetting())
                ->withGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:\namespace1"))
            ->withLogSetting((new \Gs2\AdReward\Model\LogSetting())
                ->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:\namespace1"))
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.CreateNamespaceRequest;
import io.gs2.adReward.result.CreateNamespaceResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    CreateNamespaceResult result = client.createNamespace(
        new CreateNamespaceRequest()
            .withName("namespace1")
            .withAdmob(new io.gs2.adReward.model.AdMob()
                .withAllowAdUnitIds(Arrays.asList(
                "1",
            "2",
            "3"
            )))
            .withUnityAd(new io.gs2.adReward.model.UnityAd()
                .withKeys(Arrays.asList(
                "key-0001",
            "key-0002"
            )))
            .withDescription(null)
            .withChangePointNotification(new io.gs2.adReward.model.NotificationSetting()
                .withGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1"))
            .withLogSetting(new io.gs2.adReward.model.LogSetting()
                .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1"))
    );
    Namespace item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.CreateNamespaceRequest;
using Gs2.Gs2AdReward.Result.CreateNamespaceResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.CreateNamespaceResult> asyncResult = null;
yield return client.CreateNamespace(
    new Gs2.Gs2AdReward.Request.CreateNamespaceRequest()
        .WithName("namespace1")
        .WithAdmob(new Gs2.Gs2AdReward.Model.AdMob()
            .WithAllowAdUnitIds(new string[] {
            "1",
        "2",
        "3"
        }))
        .WithUnityAd(new Gs2.Gs2AdReward.Model.UnityAd()
            .WithKeys(new string[] {
            "key-0001",
        "key-0002"
        }))
        .WithDescription(null)
        .WithChangePointNotification(new Gs2.Gs2AdReward.Model.NotificationSetting()
            .WithGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1"))
        .WithLogSetting(new Gs2.Gs2AdReward.Model.LogSetting()
            .WithLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1")),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.createNamespace(
        new Gs2AdReward.CreateNamespaceRequest()
            .withName("namespace1")
            .withAdmob(new Gs2AdReward.model.AdMob()
                .withAllowAdUnitIds([
                "1",
            "2",
            "3"
            ]))
            .withUnityAd(new Gs2AdReward.model.UnityAd()
                .withKeys([
                "key-0001",
            "key-0002"
            ]))
            .withDescription(null)
            .withChangePointNotification(new Gs2AdReward.model.NotificationSetting()
                .withGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1"))
            .withLogSetting(new Gs2AdReward.model.LogSetting()
                .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1"))
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.create_namespace(
        ad_reward.CreateNamespaceRequest()
            .with_name(self.hash1)
            .with_admob(
                ad_reward.AdMob()
                    .with_allow_ad_unit_ids([    '1',
                '2',
                '3',
                ]))
            .with_unity_ad(
                ad_reward.UnityAd()
                    .with_keys([    'key-0001',
                'key-0002',
                ]))
            .with_description(None)
            .with_change_point_notification(
                ad_reward.NotificationSetting()
                    .with_gateway_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1'))
            .with_log_setting(
                ad_reward.LogSetting()
                    .with_logging_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1'))
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.create_namespace({
    name='namespace1',
    admob={
        allowAdUnitIds={
        '1',
    '2',
    '3'
    },
    },
    unityAd={
        keys={
        'key-0001',
    'key-0002'
    },
    },
    description=nil,
    changePointNotification={
        gatewayNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1',
    },
    logSetting={
        loggingNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1',
    },
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

getNamespaceStatus

ネームスペースの状態を取得

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名

Result

説明
statusstring

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.GetNamespaceStatus(
    &ad_reward.GetNamespaceStatusRequest {
        NamespaceName: pointy.String("namespace1"),
    }
)
if err != nil {
    panic("error occurred")
}
status := result.Status
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\GetNamespaceStatusRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->getNamespaceStatus(
        (new GetNamespaceStatusRequest())
            ->withNamespaceName(self::namespace1)
    );
    $status = $result->getStatus();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.GetNamespaceStatusRequest;
import io.gs2.adReward.result.GetNamespaceStatusResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    GetNamespaceStatusResult result = client.getNamespaceStatus(
        new GetNamespaceStatusRequest()
            .withNamespaceName("namespace1")
    );
    String status = result.getStatus();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.GetNamespaceStatusRequest;
using Gs2.Gs2AdReward.Result.GetNamespaceStatusResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.GetNamespaceStatusResult> asyncResult = null;
yield return client.GetNamespaceStatus(
    new Gs2.Gs2AdReward.Request.GetNamespaceStatusRequest()
        .WithNamespaceName("namespace1"),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var status = result.Status;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.getNamespaceStatus(
        new Gs2AdReward.GetNamespaceStatusRequest()
            .withNamespaceName("namespace1")
    );
    const status = result.getStatus();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.get_namespace_status(
        ad_reward.GetNamespaceStatusRequest()
            .with_namespace_name(self.hash1)
    )
    status = result.status
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.get_namespace_status({
    namespaceName='namespace1',
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
status = result.status;

getNamespace

ネームスペースを取得

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名

Result

説明
itemNamespaceネームスペース

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.GetNamespace(
    &ad_reward.GetNamespaceRequest {
        NamespaceName: pointy.String("namespace1"),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\GetNamespaceRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->getNamespace(
        (new GetNamespaceRequest())
            ->withNamespaceName(self::namespace1)
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.GetNamespaceRequest;
import io.gs2.adReward.result.GetNamespaceResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    GetNamespaceResult result = client.getNamespace(
        new GetNamespaceRequest()
            .withNamespaceName("namespace1")
    );
    Namespace item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.GetNamespaceRequest;
using Gs2.Gs2AdReward.Result.GetNamespaceResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.GetNamespaceResult> asyncResult = null;
yield return client.GetNamespace(
    new Gs2.Gs2AdReward.Request.GetNamespaceRequest()
        .WithNamespaceName("namespace1"),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.getNamespace(
        new Gs2AdReward.GetNamespaceRequest()
            .withNamespaceName("namespace1")
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.get_namespace(
        ad_reward.GetNamespaceRequest()
            .with_namespace_name(self.hash1)
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.get_namespace({
    namespaceName='namespace1',
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

updateNamespace

ネームスペースを更新

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
descriptionstring~ 1024文字説明文
admobAdMobAdMobの設定
unityAdUnityAdUnity Ads の設定
changePointNotificationNotificationSetting広告視聴によりポイントが変動した時のプッシュ通知
logSettingLogSettingログの出力設定

Result

説明
itemNamespace更新したネームスペース

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.UpdateNamespace(
    &ad_reward.UpdateNamespaceRequest {
        NamespaceName: pointy.String("namespace1"),
        Description: pointy.String("description1"),
        Admob: &adReward.AdMob{
            AllowAdUnitIds: []*string{
                pointy.String("2"),
            pointy.String("3"),
            pointy.String("4"),
            },
        },
        UnityAd: &adReward.UnityAd{
            Keys: []*string{
                pointy.String("key-1001"),
            pointy.String("key-1002"),
            },
        },
        ChangePointNotification: &adReward.NotificationSetting{
            GatewayNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1"),
        },
        LogSetting: &adReward.LogSetting{
            LoggingNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1"),
        },
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\UpdateNamespaceRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->updateNamespace(
        (new UpdateNamespaceRequest())
            ->withNamespaceName(self::namespace1)
            ->withDescription("description1")
            ->withAdmob((new \Gs2\AdReward\Model\AdMob())
                ->withAllowAdUnitIds([    "2",
            "3",
            "4",
            ]))
            ->withUnityAd((new \Gs2\AdReward\Model\UnityAd())
                ->withKeys([    "key-1001",
            "key-1002",
            ]))
            ->withChangePointNotification((new \Gs2\AdReward\Model\NotificationSetting())
                ->withGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:\namespace1"))
            ->withLogSetting((new \Gs2\AdReward\Model\LogSetting())
                ->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:\namespace1"))
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.UpdateNamespaceRequest;
import io.gs2.adReward.result.UpdateNamespaceResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    UpdateNamespaceResult result = client.updateNamespace(
        new UpdateNamespaceRequest()
            .withNamespaceName("namespace1")
            .withDescription("description1")
            .withAdmob(new io.gs2.adReward.model.AdMob()
                .withAllowAdUnitIds(Arrays.asList(
                "2",
            "3",
            "4"
            )))
            .withUnityAd(new io.gs2.adReward.model.UnityAd()
                .withKeys(Arrays.asList(
                "key-1001",
            "key-1002"
            )))
            .withChangePointNotification(new io.gs2.adReward.model.NotificationSetting()
                .withGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1"))
            .withLogSetting(new io.gs2.adReward.model.LogSetting()
                .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1"))
    );
    Namespace item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.UpdateNamespaceRequest;
using Gs2.Gs2AdReward.Result.UpdateNamespaceResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.UpdateNamespaceResult> asyncResult = null;
yield return client.UpdateNamespace(
    new Gs2.Gs2AdReward.Request.UpdateNamespaceRequest()
        .WithNamespaceName("namespace1")
        .WithDescription("description1")
        .WithAdmob(new Gs2.Gs2AdReward.Model.AdMob()
            .WithAllowAdUnitIds(new string[] {
            "2",
        "3",
        "4"
        }))
        .WithUnityAd(new Gs2.Gs2AdReward.Model.UnityAd()
            .WithKeys(new string[] {
            "key-1001",
        "key-1002"
        }))
        .WithChangePointNotification(new Gs2.Gs2AdReward.Model.NotificationSetting()
            .WithGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1"))
        .WithLogSetting(new Gs2.Gs2AdReward.Model.LogSetting()
            .WithLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1")),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.updateNamespace(
        new Gs2AdReward.UpdateNamespaceRequest()
            .withNamespaceName("namespace1")
            .withDescription("description1")
            .withAdmob(new Gs2AdReward.model.AdMob()
                .withAllowAdUnitIds([
                "2",
            "3",
            "4"
            ]))
            .withUnityAd(new Gs2AdReward.model.UnityAd()
                .withKeys([
                "key-1001",
            "key-1002"
            ]))
            .withChangePointNotification(new Gs2AdReward.model.NotificationSetting()
                .withGatewayNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1"))
            .withLogSetting(new Gs2AdReward.model.LogSetting()
                .withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1"))
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.update_namespace(
        ad_reward.UpdateNamespaceRequest()
            .with_namespace_name(self.hash1)
            .with_description('description1')
            .with_admob(
                ad_reward.AdMob()
                    .with_allow_ad_unit_ids([    '2',
                '3',
                '4',
                ]))
            .with_unity_ad(
                ad_reward.UnityAd()
                    .with_keys([    'key-1001',
                'key-1002',
                ]))
            .with_change_point_notification(
                ad_reward.NotificationSetting()
                    .with_gateway_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1'))
            .with_log_setting(
                ad_reward.LogSetting()
                    .with_logging_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1'))
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.update_namespace({
    namespaceName='namespace1',
    description='description1',
    admob={
        allowAdUnitIds={
        '2',
    '3',
    '4'
    },
    },
    unityAd={
        keys={
        'key-1001',
    'key-1002'
    },
    },
    changePointNotification={
        gatewayNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:gateway:namespace1',
    },
    logSetting={
        loggingNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1',
    },
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

deleteNamespace

ネームスペースを削除

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名

Result

説明
itemNamespace削除したネームスペース

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.DeleteNamespace(
    &ad_reward.DeleteNamespaceRequest {
        NamespaceName: pointy.String("namespace1"),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\DeleteNamespaceRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->deleteNamespace(
        (new DeleteNamespaceRequest())
            ->withNamespaceName(self::namespace1)
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.DeleteNamespaceRequest;
import io.gs2.adReward.result.DeleteNamespaceResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    DeleteNamespaceResult result = client.deleteNamespace(
        new DeleteNamespaceRequest()
            .withNamespaceName("namespace1")
    );
    Namespace item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.DeleteNamespaceRequest;
using Gs2.Gs2AdReward.Result.DeleteNamespaceResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.DeleteNamespaceResult> asyncResult = null;
yield return client.DeleteNamespace(
    new Gs2.Gs2AdReward.Request.DeleteNamespaceRequest()
        .WithNamespaceName("namespace1"),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.deleteNamespace(
        new Gs2AdReward.DeleteNamespaceRequest()
            .withNamespaceName("namespace1")
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.delete_namespace(
        ad_reward.DeleteNamespaceRequest()
            .with_namespace_name(self.hash1)
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.delete_namespace({
    namespaceName='namespace1',
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

getPoint

ポイントを取得

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
accessTokenstring~ 128文字ユーザーID

Result

説明
itemPointポイント

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.GetPoint(
    &ad_reward.GetPointRequest {
        NamespaceName: pointy.String("namespace1"),
        AccessToken: pointy.String("$access_token_0001"),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\GetPointRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->getPoint(
        (new GetPointRequest())
            ->withNamespaceName(self::namespace1)
            ->withAccessToken(self::$accessToken0001)
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.GetPointRequest;
import io.gs2.adReward.result.GetPointResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    GetPointResult result = client.getPoint(
        new GetPointRequest()
            .withNamespaceName("namespace1")
            .withAccessToken("$access_token_0001")
    );
    Point item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.GetPointRequest;
using Gs2.Gs2AdReward.Result.GetPointResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.GetPointResult> asyncResult = null;
yield return client.GetPoint(
    new Gs2.Gs2AdReward.Request.GetPointRequest()
        .WithNamespaceName("namespace1")
        .WithAccessToken("$access_token_0001"),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.getPoint(
        new Gs2AdReward.GetPointRequest()
            .withNamespaceName("namespace1")
            .withAccessToken("$access_token_0001")
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.get_point(
        ad_reward.GetPointRequest()
            .with_namespace_name(self.hash1)
            .with_access_token(self.access_token_0001)
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.get_point({
    namespaceName='namespace1',
    accessToken='$access_token_0001',
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

getPointByUserId

ユーザIDを指定してポイントを取得

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
userIdstring~ 128文字ユーザーID

Result

説明
itemPointポイント

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.GetPointByUserId(
    &ad_reward.GetPointByUserIdRequest {
        NamespaceName: pointy.String("namespace1"),
        UserId: pointy.String("user-0001"),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\GetPointByUserIdRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->getPointByUserId(
        (new GetPointByUserIdRequest())
            ->withNamespaceName(self::namespace1)
            ->withUserId("user-0001")
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.GetPointByUserIdRequest;
import io.gs2.adReward.result.GetPointByUserIdResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    GetPointByUserIdResult result = client.getPointByUserId(
        new GetPointByUserIdRequest()
            .withNamespaceName("namespace1")
            .withUserId("user-0001")
    );
    Point item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.GetPointByUserIdRequest;
using Gs2.Gs2AdReward.Result.GetPointByUserIdResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.GetPointByUserIdResult> asyncResult = null;
yield return client.GetPointByUserId(
    new Gs2.Gs2AdReward.Request.GetPointByUserIdRequest()
        .WithNamespaceName("namespace1")
        .WithUserId("user-0001"),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.getPointByUserId(
        new Gs2AdReward.GetPointByUserIdRequest()
            .withNamespaceName("namespace1")
            .withUserId("user-0001")
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.get_point_by_user_id(
        ad_reward.GetPointByUserIdRequest()
            .with_namespace_name(self.hash1)
            .with_user_id('user-0001')
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.get_point_by_user_id({
    namespaceName='namespace1',
    userId='user-0001',
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

acquirePointByUserId

ユーザIDを指定してポイントを取得

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
userIdstring~ 128文字ユーザーID
pointlong1 ~ 9223372036854775805獲得するポイント

Result

説明
itemPointポイント

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.AcquirePointByUserId(
    &ad_reward.AcquirePointByUserIdRequest {
        NamespaceName: pointy.String("namespace1"),
        UserId: pointy.String("user-0001"),
        Point: pointy.Int64(1),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\AcquirePointByUserIdRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->acquirePointByUserId(
        (new AcquirePointByUserIdRequest())
            ->withNamespaceName(self::namespace1)
            ->withUserId("user-0001")
            ->withPoint(1)
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.AcquirePointByUserIdRequest;
import io.gs2.adReward.result.AcquirePointByUserIdResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    AcquirePointByUserIdResult result = client.acquirePointByUserId(
        new AcquirePointByUserIdRequest()
            .withNamespaceName("namespace1")
            .withUserId("user-0001")
            .withPoint(1L)
    );
    Point item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.AcquirePointByUserIdRequest;
using Gs2.Gs2AdReward.Result.AcquirePointByUserIdResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.AcquirePointByUserIdResult> asyncResult = null;
yield return client.AcquirePointByUserId(
    new Gs2.Gs2AdReward.Request.AcquirePointByUserIdRequest()
        .WithNamespaceName("namespace1")
        .WithUserId("user-0001")
        .WithPoint(1L),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.acquirePointByUserId(
        new Gs2AdReward.AcquirePointByUserIdRequest()
            .withNamespaceName("namespace1")
            .withUserId("user-0001")
            .withPoint(1)
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.acquire_point_by_user_id(
        ad_reward.AcquirePointByUserIdRequest()
            .with_namespace_name(self.hash1)
            .with_user_id('user-0001')
            .with_point(1)
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.acquire_point_by_user_id({
    namespaceName='namespace1',
    userId='user-0001',
    point=1,
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

consumePoint

ユーザIDを指定してポイントを消費

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
accessTokenstring~ 128文字ユーザーID
pointlong1 ~ 9223372036854775805消費するポイント

Result

説明
itemPointポイント

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.ConsumePoint(
    &ad_reward.ConsumePointRequest {
        NamespaceName: pointy.String("namespace1"),
        AccessToken: pointy.String("$access_token_0001"),
        Point: pointy.Int64(1),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\ConsumePointRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->consumePoint(
        (new ConsumePointRequest())
            ->withNamespaceName(self::namespace1)
            ->withAccessToken(self::$accessToken0001)
            ->withPoint(1)
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.ConsumePointRequest;
import io.gs2.adReward.result.ConsumePointResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    ConsumePointResult result = client.consumePoint(
        new ConsumePointRequest()
            .withNamespaceName("namespace1")
            .withAccessToken("$access_token_0001")
            .withPoint(1L)
    );
    Point item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.ConsumePointRequest;
using Gs2.Gs2AdReward.Result.ConsumePointResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.ConsumePointResult> asyncResult = null;
yield return client.ConsumePoint(
    new Gs2.Gs2AdReward.Request.ConsumePointRequest()
        .WithNamespaceName("namespace1")
        .WithAccessToken("$access_token_0001")
        .WithPoint(1L),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.consumePoint(
        new Gs2AdReward.ConsumePointRequest()
            .withNamespaceName("namespace1")
            .withAccessToken("$access_token_0001")
            .withPoint(1)
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.consume_point(
        ad_reward.ConsumePointRequest()
            .with_namespace_name(self.hash1)
            .with_access_token(self.access_token_0001)
            .with_point(1)
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.consume_point({
    namespaceName='namespace1',
    accessToken='$access_token_0001',
    point=1,
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

consumePointByUserId

ユーザIDを指定してポイントを消費

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
userIdstring~ 128文字ユーザーID
pointlong1 ~ 9223372036854775805消費するポイント

Result

説明
itemPointポイント

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.ConsumePointByUserId(
    &ad_reward.ConsumePointByUserIdRequest {
        NamespaceName: pointy.String("namespace1"),
        UserId: pointy.String("user-0001"),
        Point: pointy.Int64(1),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\ConsumePointByUserIdRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->consumePointByUserId(
        (new ConsumePointByUserIdRequest())
            ->withNamespaceName(self::namespace1)
            ->withUserId("user-0001")
            ->withPoint(1)
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.ConsumePointByUserIdRequest;
import io.gs2.adReward.result.ConsumePointByUserIdResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    ConsumePointByUserIdResult result = client.consumePointByUserId(
        new ConsumePointByUserIdRequest()
            .withNamespaceName("namespace1")
            .withUserId("user-0001")
            .withPoint(1L)
    );
    Point item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.ConsumePointByUserIdRequest;
using Gs2.Gs2AdReward.Result.ConsumePointByUserIdResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.ConsumePointByUserIdResult> asyncResult = null;
yield return client.ConsumePointByUserId(
    new Gs2.Gs2AdReward.Request.ConsumePointByUserIdRequest()
        .WithNamespaceName("namespace1")
        .WithUserId("user-0001")
        .WithPoint(1L),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.consumePointByUserId(
        new Gs2AdReward.ConsumePointByUserIdRequest()
            .withNamespaceName("namespace1")
            .withUserId("user-0001")
            .withPoint(1)
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.consume_point_by_user_id(
        ad_reward.ConsumePointByUserIdRequest()
            .with_namespace_name(self.hash1)
            .with_user_id('user-0001')
            .with_point(1)
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.consume_point_by_user_id({
    namespaceName='namespace1',
    userId='user-0001',
    point=1,
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

deletePointByUserId

ユーザIDを指定してポイントをリセット

Request

有効化条件必須デフォルト値の制限説明
namespaceNamestring~ 32文字ネームスペース名
userIdstring~ 128文字ユーザーID

Result

説明
itemPointポイント

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.DeletePointByUserId(
    &ad_reward.DeletePointByUserIdRequest {
        NamespaceName: pointy.String("namespace1"),
        UserId: pointy.String("user-0001"),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\DeletePointByUserIdRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->deletePointByUserId(
        (new DeletePointByUserIdRequest())
            ->withNamespaceName(self::namespace1)
            ->withUserId("user-0001")
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.DeletePointByUserIdRequest;
import io.gs2.adReward.result.DeletePointByUserIdResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    DeletePointByUserIdResult result = client.deletePointByUserId(
        new DeletePointByUserIdRequest()
            .withNamespaceName("namespace1")
            .withUserId("user-0001")
    );
    Point item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.DeletePointByUserIdRequest;
using Gs2.Gs2AdReward.Result.DeletePointByUserIdResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.DeletePointByUserIdResult> asyncResult = null;
yield return client.DeletePointByUserId(
    new Gs2.Gs2AdReward.Request.DeletePointByUserIdRequest()
        .WithNamespaceName("namespace1")
        .WithUserId("user-0001"),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.deletePointByUserId(
        new Gs2AdReward.DeletePointByUserIdRequest()
            .withNamespaceName("namespace1")
            .withUserId("user-0001")
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.delete_point_by_user_id(
        ad_reward.DeletePointByUserIdRequest()
            .with_namespace_name(self.hash1)
            .with_user_id('user-0001')
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.delete_point_by_user_id({
    namespaceName='namespace1',
    userId='user-0001',
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;

consumePointByStampTask

スタンプタスクを使用してポイントを消費

Request

有効化条件必須デフォルト値の制限説明
stampTaskstring~ 5242880文字スタンプタスク
keyIdstring~ 1024文字暗号鍵GRN

Result

説明
itemPointポイント
newContextStackstringスタンプタスクの実行結果を記録したコンテキスト

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.ConsumePointByStampTask(
    &ad_reward.ConsumePointByStampTaskRequest {
        StampTask: pointy.String("$stampTask"),
        KeyId: pointy.String("$key1.keyId"),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
newContextStack := result.NewContextStack
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\ConsumePointByStampTaskRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->consumePointByStampTask(
        (new ConsumePointByStampTaskRequest())
            ->withStampTask(self::$stampTask)
            ->withKeyId(self::$key1.keyId)
    );
    $item = $result->getItem();
    $newContextStack = $result->getNewContextStack();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.ConsumePointByStampTaskRequest;
import io.gs2.adReward.result.ConsumePointByStampTaskResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    ConsumePointByStampTaskResult result = client.consumePointByStampTask(
        new ConsumePointByStampTaskRequest()
            .withStampTask("$stampTask")
            .withKeyId("$key1.keyId")
    );
    Point item = result.getItem();
    String newContextStack = result.getNewContextStack();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.ConsumePointByStampTaskRequest;
using Gs2.Gs2AdReward.Result.ConsumePointByStampTaskResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.ConsumePointByStampTaskResult> asyncResult = null;
yield return client.ConsumePointByStampTask(
    new Gs2.Gs2AdReward.Request.ConsumePointByStampTaskRequest()
        .WithStampTask("$stampTask")
        .WithKeyId("$key1.keyId"),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
var newContextStack = result.NewContextStack;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.consumePointByStampTask(
        new Gs2AdReward.ConsumePointByStampTaskRequest()
            .withStampTask("$stampTask")
            .withKeyId("$key1.keyId")
    );
    const item = result.getItem();
    const newContextStack = result.getNewContextStack();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.consume_point_by_stamp_task(
        ad_reward.ConsumePointByStampTaskRequest()
            .with_stamp_task(self.stamp_task)
            .with_key_id(self.key1.key_id)
    )
    item = result.item
    new_context_stack = result.new_context_stack
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.consume_point_by_stamp_task({
    stampTask='$stampTask',
    keyId='$key1.keyId',
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;
newContextStack = result.newContextStack;

acquirePointByStampSheet

スタンプタスクを使用してポイントを獲得

Request

有効化条件必須デフォルト値の制限説明
stampSheetstring~ 5242880文字スタンプシート
keyIdstring~ 1024文字暗号鍵GRN

Result

説明
itemPointポイント

実装例

import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/ad_reward"
import "github.com/openlyinc/pointy"

session := core.Gs2RestSession{
    Credential: &core.BasicGs2Credential{
        ClientId: "your client id",
        ClientSecret: "your client secret",
    },
    Region: core.ApNortheast1,
}

if err := session.Connect(); err != nil {
    panic("error occurred")
}

client := ad_reward.Gs2AdRewardRestClient{
    Session: &session,
}
result, err := client.AcquirePointByStampSheet(
    &ad_reward.AcquirePointByStampSheetRequest {
        StampSheet: pointy.String("$stampSheet"),
        KeyId: pointy.String("$key1.keyId"),
    }
)
if err != nil {
    panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\AdReward\Gs2AdRewardRestClient;
use Gs2\AdReward\Request\AcquirePointByStampSheetRequest;

$session = new Gs2RestSession(
    new BasicGs2Credential(
        "your client id",
        "your client secret"
    ),
    Region::AP_NORTHEAST_1
);

$session->open();

$client = new Gs2AccountRestClient(
    $session
);

try {
    $result = $client->acquirePointByStampSheet(
        (new AcquirePointByStampSheetRequest())
            ->withStampSheet(self::$stampSheet)
            ->withKeyId(self::$key1.keyId)
    );
    $item = $result->getItem();
} catch (Gs2Exception $e) {
    exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.adReward.rest.Gs2AdRewardRestClient;
import io.gs2.adReward.request.AcquirePointByStampSheetRequest;
import io.gs2.adReward.result.AcquirePointByStampSheetResult;

Gs2RestSession session = new Gs2RestSession(
    Region.AP_NORTHEAST_1,
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
session.connect();
Gs2AdRewardRestClient client = new Gs2AdRewardRestClient(session);

try {
    AcquirePointByStampSheetResult result = client.acquirePointByStampSheet(
        new AcquirePointByStampSheetRequest()
            .withStampSheet("$stampSheet")
            .withKeyId("$key1.keyId")
    );
    Point item = result.getItem();
} catch (Gs2Exception e) {
    System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2AdReward.Gs2AdRewardRestClient;
using Gs2.Gs2AdReward.Request.AcquirePointByStampSheetRequest;
using Gs2.Gs2AdReward.Result.AcquirePointByStampSheetResult;

var session = new Gs2RestSession(
    new BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2AdRewardRestClient(session);

AsyncResult<Gs2.Gs2AdReward.Result.AcquirePointByStampSheetResult> asyncResult = null;
yield return client.AcquirePointByStampSheet(
    new Gs2.Gs2AdReward.Request.AcquirePointByStampSheetRequest()
        .WithStampSheet("$stampSheet")
        .WithKeyId("$key1.keyId"),
    r => asyncResult = r
);
if (asyncResult.Error != null) {
    throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2AdReward from '@/gs2/adReward';

const session = new Gs2Core.Gs2RestSession(
    "ap-northeast-1",
    new Gs2Core.BasicGs2Credential(
        'your client id',
        'your client secret'
    )
);
await session.connect();
const client = new Gs2AdReward.Gs2AdRewardRestClient(session);

try {
    const result = await client.acquirePointByStampSheet(
        new Gs2AdReward.AcquirePointByStampSheetRequest()
            .withStampSheet("$stampSheet")
            .withKeyId("$key1.keyId")
    );
    const item = result.getItem();
} catch (e) {
    process.exit(1);
}
from gs2 import core
from gs2 import ad_reward

session = core.Gs2RestSession(
    core.BasicGs2Credential(
        'your client id',
        'your client secret'
    ),
    "ap-northeast-1",
)
session.connect()
client = ad_reward.Gs2AdRewardRestClient(session)

try:
    result = client.acquire_point_by_stamp_sheet(
        ad_reward.AcquirePointByStampSheetRequest()
            .with_stamp_sheet(self.stamp_sheet)
            .with_key_id(self.key1.key_id)
    )
    item = result.item
except core.Gs2Exception as e:
    exit(1)
client = gs2('adReward')

api_result = client.acquire_point_by_stamp_sheet({
    stampSheet='$stampSheet',
    keyId='$key1.keyId',
})

if(api_result.isError) then
    -- When error occurs
    fail(api_result['statusCode'], api_result['message'])
end

result = api_result.result
item = result.item;