プレイヤーの更新

Prev Next

Classic/VPC環境で利用できます。

プレイヤードメイン情報を更新します。更新したプレイヤーは Production環境にデプロイされます。

参考

更新したプレイヤーは、デプロイの目的に応じて Develop(開発)または Production(本番)環境にデプロイすることができます。

  • APIで更新した場合: Production環境にデプロイ可能
  • コンソールで更新した場合: Develop、Production環境にデプロイ可能

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PUT /api/v1/players/{player_no}

リクエストヘッダ

Video Player Enhancement APIで共通して使用されるヘッダの詳細は、Video Player Enhancementのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
player_no String Required プレイヤー番号

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
domains Array Required サイトドメインリスト: domains

domains

domainsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
type String Required サイトドメインタイプ
  • web | ios | aos
    • web: ウェブサイト URL
    • ios: iOSアプリパッケージ ID
    • aos: Androidアプリパッケージ ID
domain String Required ドメインまたはモバイルアプリパッケージ ID

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request PUT 'https://vpe.apigw.ntruss.com/api/v1/players/6284' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR' \
--data '{
    "domains": [
        {
            "type": "aos",
            "domain": "{App Package ID}"
        }
    ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ

レスポンスステータスコード

Video Player Enhancement APIで共通して使用されるレスポンスステータスコードの詳細は、Video Player Enhancementのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "200",
    "message": "ok"
}