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

free
optional

初回無料アイテムなら真

boolean

itemId
optional

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

integer (int64)

thumbnailUrl
optional

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

string

currencyId
optional

通貨ID

integer (int64)

gachaId
optional

ガチャID

integer (int64)

items
optional

< GachaItem > array

price
optional

number (float)

have
optional

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

boolean

itemId
optional

アイテムID
Example : 1234567890

integer (int64)

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)

price
optional

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

number (float)

shopId
optional

ショップID

integer (int64)

thumbnailUrl
optional

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

string

currencyId
optional

通貨ID

integer (int64)

items
optional

< ShopItem > array