GS2-Showcase

Create Client

showcase_client = client('showcase')

Method

get_current_showcase_master

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

公開されているショーケースマスタを取得します

Request

{
  showcaseName=string,
}
  • showcaseName
  • [string] ショーケースの名前

Response

  • item
  • [string] 現在適用されているショーケースマスターデータ

update_current_showcase_master

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

公開するショーケースマスタを更新します

Request

{
  showcaseName=string,
  settings=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • settings
  • [string] ショーケースマスターデータ

Response

  • item
  • [string] 更新したショーケースマスターデータ

create_item_group_master

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

商品グループを新規作成します

Request

{
  showcaseName=string,
  name=string,
  itemNames=table<string>,
}
  • showcaseName
  • [string] ショーケースの名前
  • name
  • [string] 商品グループ名
  • itemNames
  • [table<string>] 販売している商品名のリスト

Response

  • item
  • [ItemGroupMaster] 商品グループ

delete_item_group_master

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

商品グループを削除します

Request

{
  showcaseName=string,
  itemGroupName=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • itemGroupName
  • [string] 商品グループの名前

Response

None

describe_item_group_master

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

商品グループの一覧を取得します

Request

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

Response

  • items
  • [table<ItemGroupMaster>] 商品グループ
  • nextPageToken
  • [string] 次のページを読み込むためのトークン

get_item_group_master

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

商品グループを取得します

Request

{
  showcaseName=string,
  itemGroupName=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • itemGroupName
  • [string] 商品グループの名前

Response

  • item
  • [ItemGroupMaster] 商品グループ

update_item_group_master

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

商品グループを更新します

Request

{
  showcaseName=string,
  itemGroupName=string,
  itemNames=table<string>,
}
  • showcaseName
  • [string] ショーケースの名前
  • itemGroupName
  • [string] 商品グループの名前
  • itemNames
  • [table<string>] 販売している商品名のリスト

Response

  • item
  • [ItemGroupMaster] 商品グループ

create_item_master

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

商品を新規作成します

Request

{
  showcaseName=string,
  name=string,
  meta=string,
  currencyType=string,
  currencyMoneyName=string,
  currencyGoldName=string,
  currencyOption=string,
  price=number,
  itemType=string,
  itemMoneyName=string,
  itemGoldName=string,
  itemStaminaStaminaPoolName=string,
  itemConsumableItemItemPoolName=string,
  itemConsumableItemItemName=string,
  itemAmount=number,
  itemOption=string,
  openConditionType=string,
  openConditionLimitName=string,
  openConditionLimitCounterName=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • name
  • [string] 商品名
  • meta
  • [string] メタデータ
  • currencyType
  • [string] 販売通貨
  • currencyMoneyName
  • [string] GS2-Money 課金通貨名
  • currencyGoldName
  • [string] GS2-Gold 通貨名
  • currencyOption
  • [string] 対価消費処理にまつわるオプション値
  • price
  • [number] 販売価格
  • itemType
  • [string] 入手アイテムの種類
  • itemMoneyName
  • [string] GS2-Money 課金通貨名
  • itemGoldName
  • [string] GS2-Gold 通貨名
  • itemStaminaStaminaPoolName
  • [string] GS2-Stamina スタミナプール名
  • itemConsumableItemItemPoolName
  • [string] GS2-ConsumableItem アイテムプール名
  • itemConsumableItemItemName
  • [string] GS2-ConsumableItem アイテム名
  • itemAmount
  • [number] 入手数量
  • itemOption
  • [string] アイテムの入手処理にまつわるオプション値
  • openConditionType
  • [string] 購入許可判定の種類
  • openConditionLimitName
  • [string] 購入許可判定 に実行されるGS2-Limit
  • openConditionLimitCounterName
  • [string] 購入許可判定 に実行されるGS2-Limit のカウンター

Response

  • item
  • [ItemMaster] 商品

delete_item_master

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

商品を削除します

Request

{
  showcaseName=string,
  itemName=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • itemName
  • [string] 商品の名前

Response

None

describe_item_master

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

商品の一覧を取得します

Request

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

Response

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

get_item_master

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

商品を取得します

Request

{
  showcaseName=string,
  itemName=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • itemName
  • [string] 商品の名前

Response

  • item
  • [ItemMaster] 商品

update_item_master

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

商品を更新します

Request

{
  showcaseName=string,
  itemName=string,
  meta=string,
  currencyType=string,
  currencyMoneyName=string,
  currencyGoldName=string,
  currencyOption=string,
  price=number,
  itemType=string,
  itemMoneyName=string,
  itemGoldName=string,
  itemStaminaStaminaPoolName=string,
  itemConsumableItemItemPoolName=string,
  itemConsumableItemItemName=string,
  itemAmount=number,
  itemOption=string,
  openConditionType=string,
  openConditionLimitName=string,
  openConditionLimitCounterName=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • itemName
  • [string] 商品の名前
  • meta
  • [string] メタデータ
  • currencyType
  • [string] 販売通貨
  • currencyMoneyName
  • [string] GS2-Money 課金通貨名
  • currencyGoldName
  • [string] GS2-Gold 通貨名
  • currencyOption
  • [string] 対価消費処理にまつわるオプション値
  • price
  • [number] 販売価格
  • itemType
  • [string] 入手アイテムの種類
  • itemMoneyName
  • [string] GS2-Money 課金通貨名
  • itemGoldName
  • [string] GS2-Gold 通貨名
  • itemStaminaStaminaPoolName
  • [string] GS2-Stamina スタミナプール名
  • itemConsumableItemItemPoolName
  • [string] GS2-ConsumableItem アイテムプール名
  • itemConsumableItemItemName
  • [string] GS2-ConsumableItem アイテム名
  • itemAmount
  • [number] 入手数量
  • itemOption
  • [string] アイテムの入手処理にまつわるオプション値
  • openConditionType
  • [string] 購入許可判定の種類
  • openConditionLimitName
  • [string] 購入許可判定 に実行されるGS2-Limit
  • openConditionLimitCounterName
  • [string] 購入許可判定 に実行されるGS2-Limit のカウンター

Response

  • item
  • [ItemMaster] 商品

buy_item

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

購入処理を実行完了する為に必要となるスタンプシートを取得します。 スタンプシートの詳細は GS2 ドキュメントを参照してください。

このAPIによって払い出されるスタンプシートが要求するタスクは以下のアクションの可能性があります。

Gs2Money:VerifyByStampTask Gs2Money:ConsumeWalletByStampTask Gs2Gold:WithdrawFromWalletByStampTask Gs2Stamina:ConsumeStaminaByStampTask Gs2ConsumableItem:ConsumeInventoryByStampTask Gs2Limit:UpCounterByStampTask

このAPIによって払い出されるスタンプシートの完了は以下のアクションの可能性があります。

Gs2Money:ChargeWalletByStampSheet Gs2Gold:DepositIntoWalletByStampSheet Gs2Stamina:ChangeStaminaByStampSheet Gs2ConsumableItem:AcquisitionInventoryByStampSheet

Request

{
  showcaseName=string,
  showcaseItemId=string,
  keyName=string,
  accessToken=string
}
  • showcaseName
  • [string] ショーケースの名前
  • showcaseItemId
  • [string] 陳列商品のID
  • keyName
  • [string] スタンプシートの暗号化に使う GS2-Key 暗号鍵名
  • accessToken
  • [string] GS2-Auth で発行を受けたアクセストークン

Response

  • item
  • [Item] 商品
  • stampSheet
  • [StampSheet]

describe_item

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

陳列されている商品一覧を取得します

Request

{
  showcaseName=string,
  accessToken=string
}
  • showcaseName
  • [string] ショーケースの名前
  • accessToken
  • [string] GS2-Auth で発行を受けたアクセストークン

Response

  • items
  • [table<Item>] 商品

get_item

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

陳列されている商品を取得します

Request

{
  showcaseName=string,
  showcaseItemId=string,
  accessToken=string
}
  • showcaseName
  • [string] ショーケースの名前
  • showcaseItemId
  • [string] 陳列商品のID
  • accessToken
  • [string] GS2-Auth で発行を受けたアクセストークン

Response

  • item
  • [Item] 商品

export_master

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

ショーケースマスターデータをエクスポートする

Request

{
  showcaseName=string,
}
  • showcaseName
  • [string] ショーケースの名前

Response

  • item
  • [string] エクスポートされたショーケースマスターデータ

create_showcase_item_master

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

陳列商品を新規作成します

Request

{
  showcaseName=string,
  category=string,
  itemName=string,
  itemGroupName=string,
  releaseConditionType=string,
  releaseConditionScheduleName=string,
  releaseConditionScheduleEventName=string,
  priority=number,
}
  • showcaseName
  • [string] ショーケースの名前
  • category
  • [string] 商品の種類
  • itemName
  • [string] 商品名
  • itemGroupName
  • [string] グループ名
  • releaseConditionType
  • [string] 公開判定の種類
  • releaseConditionScheduleName
  • [string] 公開許可判定 に実行されるGS2-Schedule
  • releaseConditionScheduleEventName
  • [string] 公開許可判定 に実行されるGS2-Schedule のイベント名
  • priority
  • [number] 応答順序優先度

Response

  • item
  • [ShowcaseItemMaster] 陳列商品

delete_showcase_item_master

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

陳列商品を削除します

Request

{
  showcaseName=string,
  category=string,
  resourceId=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • category
  • [string] 商品の種類
  • resourceId
  • [string] 商品/商品グループ名

Response

None

describe_showcase_item_master

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

陳列商品の一覧を取得します

Request

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

Response

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

get_showcase_item_master

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

陳列商品を取得します

Request

{
  showcaseName=string,
  category=string,
  resourceId=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • category
  • [string] 商品の種類
  • resourceId
  • [string] 商品/商品グループ名

Response

  • item
  • [ShowcaseItemMaster] 陳列商品

update_showcase_item_master

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

陳列商品を更新します

Request

{
  showcaseName=string,
  category=string,
  resourceId=string,
  releaseConditionType=string,
  releaseConditionScheduleName=string,
  releaseConditionScheduleEventName=string,
  priority=number,
}
  • showcaseName
  • [string] ショーケースの名前
  • category
  • [string] 商品の種類
  • resourceId
  • [string] 商品/商品グループ名
  • releaseConditionType
  • [string] 公開判定の種類
  • releaseConditionScheduleName
  • [string] 公開許可判定 に実行されるGS2-Schedule
  • releaseConditionScheduleEventName
  • [string] 公開許可判定 に実行されるGS2-Schedule のイベント名
  • priority
  • [number] 応答順序優先度

Response

  • item
  • [ShowcaseItemMaster] 陳列商品

create_showcase

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

ショーケースを新規作成します

Request

{
  name=string,
  description=string,
  releaseConditionTriggerScript=string,
  buyTriggerScript=string,
}
  • name
  • [string] ショーケース名
  • description
  • [string] 説明文
  • releaseConditionTriggerScript
  • [string] 公開許可判定 に実行されるGS2-Script
  • buyTriggerScript
  • [string] 購入直前 に実行されるGS2-Script

Response

  • item
  • [Showcase] ショーケース

delete_showcase

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

ショーケースを削除します

Request

{
  showcaseName=string,
}
  • showcaseName
  • [string] ショーケースの名前

Response

None

describe_showcase

response = showcase_client:describe_showcase(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<Showcase>] ショーケース
  • nextPageToken
  • [string] 次のページを読み込むためのトークン

get_showcase

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

ショーケースを取得します

Request

{
  showcaseName=string,
}
  • showcaseName
  • [string] ショーケースの名前

Response

  • item
  • [Showcase] ショーケース

get_showcase_status

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

ショーケースの状態を取得します

Request

{
  showcaseName=string,
}
  • showcaseName
  • [string] ショーケースの名前

Response

  • status
  • [string] ステータス

update_showcase

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

ショーケースを更新します

Request

{
  showcaseName=string,
  description=string,
  releaseConditionTriggerScript=string,
  buyTriggerScript=string,
}
  • showcaseName
  • [string] ショーケースの名前
  • description
  • [string] 説明文
  • releaseConditionTriggerScript
  • [string] 公開許可判定 に実行されるGS2-Script
  • buyTriggerScript
  • [string] 購入直前 に実行されるGS2-Script

Response

  • item
  • [Showcase] ショーケース

Model

Showcase

  • showcaseId
  • [string] ショーケースGRN
  • ownerId
  • [string] オーナーID
  • name
  • [string] ショーケース名
  • description
  • [string] 説明文
  • releaseConditionTriggerScript
  • [string] 公開許可判定 に実行されるGS2-Script
  • buyTriggerScript
  • [string] 購入直前 に実行されるGS2-Script
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

ShowcaseItemMaster

  • showcaseItemId
  • [string] 陳列商品GRN
  • category
  • [string] 商品の種類
  • itemName
  • [string] 商品名
  • itemGroupName
  • [string] グループ名
  • releaseConditionType
  • [string] 公開判定の種類
  • releaseConditionScheduleName
  • [string] 公開許可判定 に実行されるGS2-Schedule
  • releaseConditionScheduleEventName
  • [string] 公開許可判定 に実行されるGS2-Schedule のイベント名
  • priority
  • [number] 応答順序優先度
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

ItemGroupMaster

  • itemGroupId
  • [string] 商品グループGRN
  • name
  • [string] 商品グループ名
  • itemNames
  • [table<string>] 販売している商品名のリスト
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

ItemMaster

  • itemId
  • [string] 商品GRN
  • name
  • [string] 商品名
  • meta
  • [string] メタデータ
  • currencyType
  • [string] 販売通貨
  • currencyMoneyName
  • [string] GS2-Money 課金通貨名
  • currencyGoldName
  • [string] GS2-Gold 通貨名
  • currencyOption
  • [string] 対価消費処理にまつわるオプション値
  • price
  • [number] 販売価格
  • itemType
  • [string] 入手アイテムの種類
  • itemMoneyName
  • [string] GS2-Money 課金通貨名
  • itemGoldName
  • [string] GS2-Gold 通貨名
  • itemStaminaStaminaPoolName
  • [string] GS2-Stamina スタミナプール名
  • itemConsumableItemItemPoolName
  • [string] GS2-ConsumableItem アイテムプール名
  • itemConsumableItemItemName
  • [string] GS2-ConsumableItem アイテム名
  • itemAmount
  • [number] 入手数量
  • itemOption
  • [string] アイテムの入手処理にまつわるオプション値
  • openConditionType
  • [string] 購入許可判定の種類
  • openConditionLimitName
  • [string] 購入許可判定 に実行されるGS2-Limit
  • openConditionLimitCounterName
  • [string] 購入許可判定 に実行されるGS2-Limit のカウンター
  • createAt
  • [number] 作成日時(エポック秒)
  • updateAt
  • [number] 最終更新日時(エポック秒)

Item

  • showcaseItemId
  • [string] 陳列商品ID
  • name
  • [string] 商品名
  • meta
  • [string] メタデータ
  • currencyType
  • [string] 販売通貨
  • currencyMoneyName
  • [string] GS2-Money 課金通貨名
  • currencyGoldName
  • [string] GS2-Gold 通貨名
  • currencyOption
  • [string] 対価消費処理にまつわるオプション値
  • price
  • [number] 販売価格
  • itemType
  • [string] 入手アイテムの種類
  • itemMoneyName
  • [string] GS2-Money 課金通貨名
  • itemGoldName
  • [string] GS2-Gold 通貨名
  • itemStaminaStaminaPoolName
  • [string] GS2-Stamina スタミナプール名
  • itemConsumableItemItemPoolName
  • [string] GS2-ConsumableItem アイテムプール名
  • itemConsumableItemItemName
  • [string] GS2-ConsumableItem アイテム名
  • itemAmount
  • [number] 入手数量
  • itemOption
  • [string] アイテムの入手処理にまつわるオプション値
  • canBuy
  • [boolean] 購入可能か