avatarplay Avatar Play API

accessToken
optional

アクセストークン。RESTful APIのみを利用する場合は破棄して問題ありません。
Example : "d030073d5d1…​"

string

avatarId
optional

アバターID。自社アプリ内でアバターを一意に表すIDです。RESTful APIのパラメータとして利用できます。
Example : 1234567890

integer (int64)

avatarImageUrl
optional

アバター全身画像のURL。画像は240x320ピクセルサイズのアニメーションGIFです。テイストに応じたアニメーションが付きます。
Example : "https://example.com/avatar.gif"

string

faceImageUrl
optional

アバターバストアップ画像のURL。画像は120x120ピクセルサイズのGIFファイルです。アバターが正面を向いたアニメーションなしの画像です。サムネイルとしての利用などに適しています。
Example : "https://example.com/face.gif"

string

scope
optional

スコープ
Example : "AvatarLoad,ItemGrant"

string

tokenType
optional

トークンの種類。「Bearer」で固定です。
Example : "Bearer"

string

avatarId
optional

アバターID
Example : 1234567890

integer (int64)

avatarImageUrl
optional

アバター全身画像のURL。画像は240x320ピクセルサイズのアニメーションGIFです。テイストに応じたアニメーションが付きます。
Example : "https://example.com/avatar.gif"

string

faceImageUrl
optional

アバターバストアップ画像のURL。画像は120x120ピクセルサイズのGIFファイルです。アバターが正面を向いたアニメーションなしの画像です。サムネイルとしての利用などに適しています。
Example : "https://example.com/face.gif"

string

guest
optional

ゲストユーザなら真
Example : true

boolean

status
optional

アバターのステータスを返します。200: 正常に画像取得。401: 画像取得のパーミッションが取れませんでした。ユーザがパーミッションを削除したなどの可能性があります。パーミッションを再取得することで改善する可能性があります。404: 存在しないアバターです。アバターIDが誤っているか、ユーザが削除された可能性があります。
Example : 200

integer (int32)

avatars
optional

< Avatar > array

message
optional

出力するメッセージ
Example : "hello"

string

code
optional

Example : 400

integer (int32)

errors
optional

< ErrorDetail > array

message
optional

Example : "Invalid string value"

string

domain
optional

Example : "global"

string

message
optional

Example : "String 'abc' not a valid integer"

string

reason
optional

Example : "badRequest"

string

error
optional

Error

alertMessage
optional

アラート文。購入の際の注意事項として利用します。

string

alertMessage2
optional

アラート文2。購入の際の2つ目の注意事項として利用します。

string

backgroundImageUrl
optional

背景画像のURL

string

bannerImageUrl
optional

バナー画像のURL

string

closedAt
optional

販売終了日時。RFC3339形式。
Example : "2022-07-07T11:00:00Z"

string

currencyId
optional

通貨ID

integer (int64)

description
optional

説明文

string

firstTime
optional

ユーザがガチャを回したことがない場合は真。アバターIDを指定している場合にのみ有効。

boolean

firstTimeDiscountPrice
optional

初回限定価格。「0」が指定されている場合、初回限定価格は未設定。

number (double)

hasFree
optional

初回無料アイテムがある場合は真

boolean

iconImageUrl
optional

アイコン画像のURL

string

id
optional

ガチャID

integer (int64)

items
optional

ガチャに設定されているアイテムリスト。デベロッパーコンソールで設定した順番で返されます。

< GachaItem > array

name
optional

ガチャ名

string

openedAt
optional

販売開始日時。RFC3339形式。
Example : "2021-07-07T11:00:00Z"

string

price
optional

販売価格

number (double)

sampleCoordImageUrls
optional

サンプルコーデ画像のURLリスト

< string > array

tags
optional

ガチャに設定したタグリスト

< string > array

avatarImageUrl
optional

試着したアバター画像のURL

string

free
optional

初回無料アイテムなら真

boolean

have
optional

所持アイテムなら真。アバターIDを指定している場合にのみ有効。

boolean

itemId
optional

引き当てられたアイテムのID

integer (int64)

name
optional

デベロッパーコンソールで設定したアイテム名

string

rate
optional

出現確率(%)。小数第何位まで表示するかは、デベロッパーコンソールから指定できます。
Example : "12.34%"

string

tags
optional

デベロッパーコンソールで設定したアイテムのタグリスト

< string > array

thumbnailUrl
optional

引き当てられたアイテムのサムネイル画像URL

string

currencyId
optional

通貨ID

integer (int64)

gachaId
optional

ガチャID

integer (int64)

gachaName
optional

ガチャ名

string

gachaTags
optional

ガチャに設定したタグリスト

< string > array

items
optional

引き当てたガチャアイテムリスト

< GachaItem > array

price
optional

販売価格。初回無料が適用される場合は0、初回限定価格が適用される場合は初回限定価格が設定されます。

number (double)

sessionId
optional

セッションID
Example : "1234567890…​"

string

gachas
optional

< Gacha > array

have
optional

指定したアバターIDのユーザが所持しているアイテムなら真。アバターIDを指定していない場合は偽が設定されます。
Example : false

boolean

itemId
optional

アイテムID
Example : 1234567890

integer (int64)

name
optional

デベロッパーコンソールで設定したアイテム名

string

tags
optional

デベロッパーコンソールで設定したタグリスト

< string > array

thumbnailUrl
optional

アイテムのサムネイル画像のURL。画像は60x60ピクセルのPNGファイルです。
Example : "https://example.com/thumbnail.png"

string

itemId
optional

アイテムID
Example : 1234567890

integer (int64)

status
optional

結果コード。200:正常に付与完了/409:所持済みのアイテム
Example : 200

integer (int32)

results
optional

< ItemResult > array

items
optional

< Item > array

itemId
optional

アイテムID

integer (int64)

name
optional

デベロッパーコンソールで設定したアイテム名

string

price
optional

価格。コンソールで設定されている値が返されます。

number (double)

shopId
optional

ショップID

integer (int64)

tags
optional

デベロッパーコンソールで設定したタグリスト

< string > array

thumbnailUrl
optional

アイテムのサムネイル画像のURL

string

currencyId
optional

通貨ID

integer (int64)

items
optional

< ShopItem > array