GS2-Gacha

Create Client

gacha_client = client('gacha')

Method

get_current_gacha_master

response = gacha_client:get_current_gacha_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

公開されているガチャマスタを取得します

Request

{
  gachaPoolName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。

Response

  • item
  • [string] 現在適用されているガチャマスターデータ

update_current_gacha_master

response = gacha_client:update_current_gacha_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

公開するガチャマスタを更新します

Request

{
  gachaPoolName=string,
  settings=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • settings
  • [string] ガチャマスターデータ

Response

  • item
  • [string] 現在適用されているガチャマスターデータ

create_gacha_master

response = gacha_client:create_gacha_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャを新規作成します

Request

{
  gachaPoolName=string,
  name=string,
  meta=string,
  prizeTableNames=table<string>,
  prizeJobQueueName=string,
  prizeJobQueueScriptName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • name
  • [string] ガチャ名
  • meta
  • [string] メタデータ
  • prizeTableNames
  • [table<string>] 排出確率名リスト
  • prizeJobQueueName
  • [string] 景品の排出処理に使用する GS2-JobQueue
  • prizeJobQueueScriptName
  • [string] 景品の排出処理に使用する GS2-JobQueue に指定する GS2-Script

Response

  • item
  • [GachaMaster] ガチャ

delete_gacha_master

response = gacha_client:delete_gacha_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャを削除します

Request

{
  gachaPoolName=string,
  gachaName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • gachaName
  • [string] ガチャの名前を指定します。

Response

None

describe_gacha_master

response = gacha_client:describe_gacha_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャの一覧を取得します

Request

{
  gachaPoolName=string,
  pageToken=string,
  limit=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • items
  • [table<GachaMaster>] ガチャ
  • nextPageToken
  • [string] 次のページを読み込むためのトークン

get_gacha_master

response = gacha_client:get_gacha_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャを取得します

Request

{
  gachaPoolName=string,
  gachaName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • gachaName
  • [string] ガチャの名前を指定します。

Response

  • item
  • [GachaMaster] ガチャ

update_gacha_master

response = gacha_client:update_gacha_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャを更新します

Request

{
  gachaPoolName=string,
  gachaName=string,
  meta=string,
  prizeTableNames=table<string>,
  prizeJobQueueName=string,
  prizeJobQueueScriptName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • gachaName
  • [string] ガチャの名前を指定します。
  • meta
  • [string] メタデータ
  • prizeTableNames
  • [table<string>] 排出確率名リスト
  • prizeJobQueueName
  • [string] 景品の排出処理に使用する GS2-JobQueue
  • prizeJobQueueScriptName
  • [string] 景品の排出処理に使用する GS2-JobQueue に指定する GS2-Script

Response

  • item
  • [GachaMaster] ガチャ

create_gacha_pool

response = gacha_client:create_gacha_pool(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャプールを新規作成します

Request

{
  name=string,
  description=string,
  publicDrawRate=string,
  restrict=string,
  drawPrizeTriggerScript=string,
  drawPrizeDoneTriggerScript=string,
}
  • name
  • [string] ガチャプール名
  • description
  • [string] 説明文
  • publicDrawRate
  • [string] 排出確率を公開するか
  • restrict
  • [string] 抽選実行を制限するか
  • drawPrizeTriggerScript
  • [string] 排出判定時 に実行されるGS2-Script
  • drawPrizeDoneTriggerScript
  • [string] 排出判定完了時 に実行されるGS2-Script

Response

  • item
  • [GachaPool] ガチャプール

delete_gacha_pool

response = gacha_client:delete_gacha_pool(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャプールを削除します

Request

{
  gachaPoolName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。

Response

None

describe_gacha_pool

response = gacha_client:describe_gacha_pool(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャプールの一覧を取得します

Request

{
  pageToken=string,
  limit=number,
}
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • items
  • [table<GachaPool>] ガチャプール
  • nextPageToken
  • [string] 次のページを読み込むためのトークン

get_gacha_pool

response = gacha_client:get_gacha_pool(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャプールを取得します

Request

{
  gachaPoolName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。

Response

  • item
  • [GachaPool] ガチャプール

get_gacha_pool_status

response = gacha_client:get_gacha_pool_status(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャプールの状態を取得します

Request

{
  gachaPoolName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。

Response

  • status
  • [string] ステータス

update_gacha_pool

response = gacha_client:update_gacha_pool(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャプールを更新します

Request

{
  gachaPoolName=string,
  description=string,
  publicDrawRate=string,
  restrict=string,
  drawPrizeTriggerScript=string,
  drawPrizeDoneTriggerScript=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • description
  • [string] 説明文
  • publicDrawRate
  • [string] 排出確率を公開するか
  • restrict
  • [string] 抽選実行を制限するか
  • drawPrizeTriggerScript
  • [string] 排出判定時 に実行されるGS2-Script
  • drawPrizeDoneTriggerScript
  • [string] 排出判定完了時 に実行されるGS2-Script

Response

  • item
  • [GachaPool] ガチャプール

describe_gacha

response = gacha_client:describe_gacha(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

公開されているガチャ一覧を取得します

Request

{
  gachaPoolName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。

Response

  • items
  • [table<Gacha>] ガチャ

detail_probability

response = gacha_client:detail_probability(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

リソース毎のガチャの排出確率を取得します

Request

{
  gachaPoolName=string,
  gachaName=string,
  drawTime=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前
  • gachaName
  • [string] ガチャの名前
  • drawTime
  • [number] 何回目の抽選時の抽選確率を取得するか

Response

  • items
  • [table<ProbabilityDetail>] リソース毎の排出率

do_gacha

response = gacha_client:do_gacha(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャを実行します。

Request

{
  gachaPoolName=string,
  gachaName=string,
  context=string,
  accessToken=string
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • gachaName
  • [string] ガチャの名前を指定します。
  • context
  • [string] コンテキストデータ
  • accessToken
  • [string] GS2-Auth で発行を受けたアクセストークン

Response

  • item
  • [Prize] 景品

do_gacha_by_stamp_sheet

response = gacha_client:do_gacha_by_stamp_sheet(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

スタンプシートを使用してガチャを実行します。

Request

{
  sheet=string,
  keyName=string,
  accessToken=string
}
  • sheet
  • [string] スタンプシート
  • keyName
  • [string] スタンプの暗号鍵
  • accessToken
  • [string] GS2-Auth で発行を受けたアクセストークン

Response

  • item
  • [Prize] 景品

get_gacha

response = gacha_client:get_gacha(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

公開されているガチャを取得します

Request

{
  gachaPoolName=string,
  gachaName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • gachaName
  • [string] ガチャの名前を指定します。

Response

  • item
  • [Gacha] ガチャ

get_probability

response = gacha_client:get_probability(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

レアリティ毎のガチャの排出確率を取得します

Request

{
  gachaPoolName=string,
  gachaName=string,
  drawTime=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前
  • gachaName
  • [string] ガチャの名前
  • drawTime
  • [number] 何回目の抽選時の抽選確率を取得するか

Response

  • items
  • [table<Probability>] レアリティ毎の排出率

export_master

response = gacha_client:export_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

ガチャマスターデータをエクスポートする

Request

{
  gachaPoolName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。

Response

  • item
  • [string] エクスポートされたガチャマスターデータ

create_prize_master

response = gacha_client:create_prize_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品を新規作成します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  rarityName=string,
  resourceId=string,
  weight=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • rarityName
  • [string] 景品レアリティの名前を指定します。
  • resourceId
  • [string] リソースID
  • weight
  • [number] 排出重み

Response

  • item
  • [PrizeMaster] 景品

delete_prize_master

response = gacha_client:delete_prize_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品を削除します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  rarityName=string,
  resourceId=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • rarityName
  • [string] 景品レアリティの名前を指定します。
  • resourceId
  • [string] リソースIDを指定します。

Response

None

describe_prize_master

response = gacha_client:describe_prize_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品の一覧を取得します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  rarityName=string,
  pageToken=string,
  limit=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • rarityName
  • [string] 景品レアリティの名前を指定します。
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • items
  • [table<PrizeMaster>] 景品
  • nextPageToken
  • [string] 次のページを読み込むためのトークン

get_prize_master

response = gacha_client:get_prize_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品を取得します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  rarityName=string,
  resourceId=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • rarityName
  • [string] 景品レアリティの名前を指定します。
  • resourceId
  • [string] リソースIDを指定します。

Response

  • item
  • [PrizeMaster] 景品

update_prize_master

response = gacha_client:update_prize_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品を更新します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  rarityName=string,
  resourceId=string,
  weight=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • rarityName
  • [string] 景品レアリティの名前を指定します。
  • resourceId
  • [string] リソースIDを指定します。
  • weight
  • [number] 排出重み

Response

  • item
  • [PrizeMaster] 景品

create_prize_table_master

response = gacha_client:create_prize_table_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

排出確率テーブルを新規作成します

Request

{
  gachaPoolName=string,
  name=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • name
  • [string] 排出確率テーブル名

Response

  • item
  • [PrizeTableMaster] 排出確率テーブル

delete_prize_table_master

response = gacha_client:delete_prize_table_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

排出確率テーブルを削除します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。

Response

None

describe_prize_table_master

response = gacha_client:describe_prize_table_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

排出確率テーブルの一覧を取得します

Request

{
  gachaPoolName=string,
  pageToken=string,
  limit=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • items
  • [table<PrizeTableMaster>] 排出確率テーブル
  • nextPageToken
  • [string] 次のページを読み込むためのトークン

get_prize_table_master

response = gacha_client:get_prize_table_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

排出確率テーブルを取得します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。

Response

  • item
  • [PrizeTableMaster] 排出確率テーブル

create_rarity_master

response = gacha_client:create_rarity_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品レアリティを新規作成します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  name=string,
  weight=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • name
  • [string] 景品レアリティ名
  • weight
  • [number] 排出重み

Response

  • item
  • [RarityMaster] 景品レアリティ

delete_rarity_master

response = gacha_client:delete_rarity_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品レアリティを削除します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  rarityName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • rarityName
  • [string] 景品レアリティの名前を指定します。

Response

None

describe_rarity_master

response = gacha_client:describe_rarity_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品レアリティの一覧を取得します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  pageToken=string,
  limit=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • pageToken
  • [string] データの取得を開始する位置を指定するトークン
  • limit
  • [number] データの取得件数

Response

  • items
  • [table<RarityMaster>] 景品レアリティ
  • nextPageToken
  • [string] 次のページを読み込むためのトークン

get_rarity_master

response = gacha_client:get_rarity_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品レアリティを取得します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  rarityName=string,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • rarityName
  • [string] 景品レアリティの名前を指定します。

Response

  • item
  • [RarityMaster] 景品レアリティ

update_rarity_master

response = gacha_client:update_rarity_master(request)
if response.isError then
  -- エラー処理 --
  print(response.statusCode)
  print(response.errorMessage)
else
  -- 正常処理 --
  print(response.result)
end

景品レアリティを更新します

Request

{
  gachaPoolName=string,
  prizeTableName=string,
  rarityName=string,
  weight=number,
}
  • gachaPoolName
  • [string] ガチャプールの名前を指定します。
  • prizeTableName
  • [string] 排出確率テーブルの名前を指定します。
  • rarityName
  • [string] 景品レアリティの名前を指定します。
  • weight
  • [number] 排出重み

Response

  • item
  • [RarityMaster] 景品レアリティ

Model

GachaPool

  • gachaPoolId
  • [string] ガチャプールGRN
  • ownerId
  • [string] オーナーID
  • name
  • [string] ガチャプール名
  • description
  • [string] 説明文
  • publicDrawRate
  • [string] 排出確率を公開するか
  • restrict
  • [string] 抽選実行を制限するか
  • drawPrizeTriggerScript
  • [string] 排出判定時 に実行されるGS2-Script
  • drawPrizeDoneTriggerScript
  • [string] 排出判定完了時 に実行されるGS2-Script
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

GachaMaster

  • gachaId
  • [string] ガチャGRN
  • name
  • [string] ガチャ名
  • meta
  • [string] メタデータ
  • prizeTableNames
  • [table<string>] 排出確率名リスト
  • prizeJobQueueName
  • [string] 景品の排出処理に使用する GS2-JobQueue
  • prizeJobQueueScriptName
  • [string] 景品の排出処理に使用する GS2-JobQueue に指定する GS2-Script
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

PrizeTableMaster

  • prizeTableId
  • [string] 排出確率テーブルGRN
  • name
  • [string] 排出確率テーブル名
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

RarityMaster

  • rarityId
  • [string] 景品レアリティGRN
  • name
  • [string] 景品レアリティ名
  • weight
  • [number] 排出重み
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

PrizeMaster

  • prizeId
  • [string] 景品GRN
  • resourceId
  • [string] リソースID
  • weight
  • [number] 排出重み
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

Gacha

  • name
  • [string] ガチャ名
  • meta
  • [string] メタデータ
  • drawCount
  • [number] 抽選回数

Prize

  • gachaPoolName
  • [string] ガチャプール名
  • gachaName
  • [string] ガチャ名
  • resourceIds
  • [table<string>] 景品リスト

Probability

  • name
  • [string] レアリティ名
  • rate
  • [number] 排出率

ProbabilityDetail

  • rarityName
  • [string] レアリティ名
  • resourceId
  • [string] リソースID
  • rate
  • [number] 排出率