Millvi logo
API docs by Redocly

millvi CRM API

Download OpenAPI specification:

カスタマーサクセス部: support@millvi.jp URL: https://millvi-cs.com/support/

millvi CRM API は millvi CRM プラットフォームを外部アプリケーションから利用できるプログラミングインターフェースです。VODを使用するためのユーザーの管理や、転送量、ストレージ利用量などを確認することができます。

ご利用方法について

millvi API は、CRM API と VOD API に分かれており、それぞれ担う機能が異なります。CRM API では、契約情報や利用量に関わる部分を提供しております。

API利用における注意事項

  • 短時間でのループ処理で負荷をかけるようなタスクはご遠慮ください。弊社側で高負荷の検知があった場合、利用方法についてご相談させていただく場合があります。
  • 本APIドキュメントに記載されている仕様以外の設定では正しく動作しないことがあります。

共通仕様

異常系

API がエラーになった場合、以下のようにエラーコードとエラーメッセージが返ってきます。

{
  "errorCode": "MVOD_CMN_0005",
  "reason": "必須パラメーターが存在しません。[param_name]"
}

認証情報について

リクエストヘッダー情報に、トークンをご利用ください。 当APIでは、Bearer Token (OAuth2.0) を採用しています。

リクエストヘッダー情報に、トークンをご利用ください。

curl -H GET "https://${end_point}/crm/end_point" \
-H "Authorization: Bearer {access_token}"

contractor_token

契約者用Token取得

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer

distributor_token

配信者用Token取得

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer

機能マスター

機能マスターを取得するAPIについて記述します。
2023年9月時点において、機能マスターには以下が準備されています。契約プラン毎にご利用いただける機能が異なります。

function_id function_name
onetime ワンタイム
custom_recipe カスタムレシピ
subtitle_transcription 自動字幕生成
live ライブ
dvr DVR
playback_rate 倍速

機能設定マスター取得

クエリパラメーターについて

  1. 未指定

    • 全てのコンテンツ情報を取得します。

  2. レスポンスの項目を指定(funcion_id, function_name)

    • 指定した項目の全ての機能マスター情報を取得します。

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

データの合計数

required
Array of objects

機能マスター情報の一覧

Request samples 

curl -v -X GET 'https://${end_point}/masters/functions'

Response samples

Content type
application/json
{
  • "total_count": 1,
  • "items": [
    ]
}

契約者用トークン取得

契約者用トークンを取得するAPIについて記述します。

契約者トークン取得

アクセストークン、リフレッシュトークンを取得します。

grant_typeに応じて、リクエストするパラメーターが違います。（後述） ただし、どちらの場合もレスポンスは同じです。

各APIへのリクエスト時には、当該APIで取得したトークンをヘッダーに設定してください。

Authorization: Bearer access_token

アクセストークンの場合

  • grant_type: "password" 固定

  • contractor_id/password:必須

リフレッシュトークンの場合

  • grant_type: "refresh_token" 固定

  • refresh_token:必須

Request Body schema: application/json
grant_type
required
string
Enum: "password" "refresh_token"

権限付与タイプ

refresh_token
string or null

リフレッシュトークン

password
string or null

契約者用パスワード

contractor_id
string or null <= 100 characters

契約者ID

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

access_token
required
string

アクセストークン

access_token_expires_at
required
string

アクセストークンの有効期限。

refresh_token
required
string

リフレッシュトークン

refresh_token_expires_at
string or null

リフレッシュトークンの有効期限。

contractor_id_alias
string or null

契約者IDエイリアス

Request samples

Content type
application/json
{
  • "grant_type": "password",
  • "refresh_token": "exampleToken",
  • "password": "password",
  • "contractor_id": "contractorid"
}

Response samples

Content type
application/json
{
  • "contractor_id": "contractorid",
  • "access_token": "exampleAccessToken",
  • "access_token_expires_at": "2020-01-01T00:00:00.000000+0900",
  • "refresh_token": "exampleRefreshToken",
  • "refresh_token_expires_at": "2020-01-01T00:00:00.000000+0900",
  • "contractor_id_alias": "contractorAliasId"
}

自身の契約者情報管理

契約者自身の情報を管理するAPIについて記述します。

契約者自身取得

契約者自身の情報を取得します。

Authorizations:
contractor_token

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

disabled
required
boolean

無効フラグ
trueでアカウントが無効、falseでアカウントが有効になる

created_at
required
string

契約者作成日付

updated_at
required
string

契約者更新日付

pause_start_date
string or null

休止開始日

use_resume_date
string or null

利用再開日

Array of objects or null

pause_start_dateとuse_resume_dateの履歴が格納される。

cancel_date
string or null

解約日

contractor_id_alias
string or null

契約者IDエイリアス

expires_at
string or null

失効日

Request samples 

curl -v -X GET 'https://${end_point}/contractors/me'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "contractor_id": "exampleContractorId",
  • "disabled": false,
  • "created_at": "2022-03-01T00:00:00.000000+0900",
  • "updated_at": "2022-04-01T00:00:00.000000+0900",
  • "pause_start_date": "2022-03-01",
  • "use_resume_date": "2022-04-01",
  • "pause_history": [
    ],
  • "cancel_date": "2022-05-01",
  • "contractor_id_alias": "exampleContractorIdAlias",
  • "expires_at": null
}

契約者自身更新

契約者自身の情報を更新します。

Authorizations:
contractor_token
Request Body schema: application/json
password
string or null [ 8 .. 100 ] characters

契約者用パスワード。半角英数字と以下の記号のみ登録できます。

."#?!$%&()]@[,=~|`{}+*<>_/\;:^'-

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

disabled
required
boolean

無効フラグ
trueでアカウントが無効、falseでアカウントが有効になる

created_at
required
string

契約者作成日付

updated_at
required
string

契約者更新日付

pause_start_date
string or null

休止開始日

use_resume_date
string or null

利用再開日

Array of objects or null

pause_start_dateとuse_resume_dateの履歴が格納される。

cancel_date
string or null

解約日

Request samples

Content type
application/json
{
  • "password": "contractor123"
}

Response samples

Content type
application/json
{
  • "contractor_id": "exampleContractorId",
  • "disabled": false,
  • "created_at": "2022-03-01T00:00:00.000000+0900",
  • "updated_at": "2022-04-01T00:00:00.000000+0900",
  • "pause_start_date": "2022-03-01",
  • "use_resume_date": "2022-04-01",
  • "pause_history": [
    ],
  • "cancel_date": "2022-05-01"
}

契約取得

契約情報を取得するAPIについて記述します。

契約情報取得

契約情報を取得します。 最新の契約情報と契約の履歴が参照できます。

Authorizations:
contractor_token

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

対象の契約者ID

object or null

最新の契約情報

Array of objects or null

契約情報履歴

Request samples 

curl -v -X GET 'https://${end_point}/contractors/me/contracts'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "contractor_id": "exampleContractorId",
  • "latest_contract": {
    },
  • "contract_history": {
    }
}

利用量取得

ストレージ利用量と転送量を取得するAPIについて記述します。

ストレージ利用量取得

配信者のVODでのストレージ利用量を取得します。

ユーザーの指定

  • 配信者IDを指定しない場合、全ての配信者の利用量を取得することができます。 この場合、distributor_idはnullを取り、結果は全配信者の利用量の合計となります。

  • 配信者IDを指定すると、対象の配信者のみの利用量を取得することができます。

Authorizations:
contractor_token
query Parameters
from
required
string >= 2022-01-01
Example: from=2022-01-01

検索開始日

to
string
Example: to=2022-01-02

検索終了日
無指定のとき実行時前日の年月日(日本時間)が設定されます。

distributor_id
string or null
Example: distributor_id=distributor001

配信者ID

includes_deleted_distributors
boolean
Default: false
Example: includes_deleted_distributors=true

削除された配信者を含めるか。trueで含める、false/未指定で含めない

kind
string
Default: "day"
Enum: "day" "month" "year"
Example: kind=day

集計単位

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

itemsの総数

required
Array of objects

ストレージ利用量一覧

Request samples 

curl -v -X GET 'https://${end_point}/contractors/usages/vod/storages?from=2022-01-01&to=2022-01-02&distributor_id=distributor001&includes_deleted_distributors=True&kind=day'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": {
    }
}

転送量取得

配信者のVODでの転送量を取得します。

  • 全ての配信者の転送量を取得することができます。

  • 配信者IDを指定すると、対象の配信者のみの転送量を取得することができます。

Authorizations:
contractor_token
query Parameters
from
required
string >= 2022-01-01
Example: from=2022-01-01

検索開始日

to
string
Example: to=2022-01-02

検索終了日
無指定のとき実行時前日の年月日(日本時間)が設定されます。

distributor_id
string or null
Example: distributor_id=distributor001

配信者ID

includes_deleted_distributors
boolean
Default: false
Example: includes_deleted_distributors=true

削除された配信者を含めるか。trueで含める、false/未指定で含めない

kind
string
Default: "day"
Enum: "day" "month" "year"
Example: kind=day

集計単位

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

itemsの総数

required
Array of objects

転送量一覧

Request samples 

curl -v -X GET 'https://${end_point}/contractors/usages/vod/transfers?from=2022-01-01&to=2022-01-02&distributor_id=distributor001&includes_deleted_distributors=True&kind=day'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": {
    }
}

ストレージ利用量超過量取得

配信者のVODでのストレージ利用量と超過量を取得します。

ユーザーの指定

  • 配信者IDを指定しない場合、全ての配信者の利用量と超過量を取得することができます。 この場合、distributor_idはnullを取り、結果は全配信者の利用量と超過量の合計となります。

  • 配信者IDを指定すると、対象の配信者のみの利用量と超過量を取得することができます。

Authorizations:
contractor_token
query Parameters
from
required
string >= 2022-01-01
Example: from=2022-01-01

検索開始日

kind
string
Default: "day"
Enum: "day" "month"
Example: kind=day

集計単位

to
string
Example: to=2022-01-02

検索終了日
無指定のとき実行時前日の年月日(日本時間)が設定されます。

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

itemsの総数

required
Array of objects

ストレージ利用量一覧

Request samples 

curl -v -X GET 'https://${end_point}/contractors/excesses/vod/storages?from=2022-01-01&kind=day&to=2022-01-02'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": {
    }
}

転送量超過量取得

配信者のVODでの転送量と超過量を取得します。

ユーザーの指定

  • 配信者IDを指定しない場合、全ての配信者の利用量と超過量を取得することができます。 この場合、distributor_idはnullを取り、結果は全配信者の利用量と超過量の合計となります。

  • 配信者IDを指定すると、対象の配信者のみの利用量と超過量を取得することができます。

集計単位の指定

  • 集計単位をdayにすると、転送量は月間の利用量の累計値になります。
Authorizations:
contractor_token
query Parameters
from
required
string >= 2022-01-01
Example: from=2022-01-01

検索開始日

kind
string
Default: "day"
Enum: "day" "month"
Example: kind=day

集計単位

to
string
Example: to=2022-01-02

検索終了日
無指定のとき実行時前日の年月日(日本時間)が設定されます。

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

itemsの総数

required
Array of objects

転送量利用量一覧

Request samples 

curl -v -X GET 'https://${end_point}/contractors/excesses/vod/transfers?from=2022-01-01&kind=day&to=2022-01-02'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": {
    }
}

利用量CSVダウンロード

配信者ごとのVODでの利用量(ストレージ利用量、転送量)のCSVファイルを取得します。

Authorizations:
contractor_token
query Parameters
from
required
string >= 2022-01-01
Example: from=2022-01-01

検索開始日

to
string
Example: to=2022-01-02

検索終了日
無指定のとき実行時前日の年月日(日本時間)が設定されます。

distributor_id
string or null
Example: distributor_id=distributor001

配信者ID
指定しない場合は全配信者の合計値が計算され、返り値のdistributor_idは空になります。

includes_deleted_distributors
boolean
Default: false
Example: includes_deleted_distributors=true

削除された配信者を含めるか。trueで含める、false/未指定で含めない

kind
string
Default: "day"
Enum: "day" "month"
Example: kind=day

集計単位

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/octet-stream
string <binary>

Request samples 

curl -v -X GET 'https://${end_point}/contractors/usages/vod/csv?from=2022-01-01&to=2022-01-02&distributor_id=distributor001&includes_deleted_distributors=True&kind=day'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
Example
{
  • "errorCode": "MCRM_CMN_0004",
  • "reason": "必須パラメーターが存在しません。[param_names]"
}

配信者管理

配信者管理で利用するAPIについて記述します。

注意事項

配信者が有効になるには、利用可能機能設定APIを利用して適用開始日を設定する必要があります。

配信者情報登録

配信者を登録します。

Authorizations:
contractor_token
Request Body schema: application/json
distributor_id
required
string [ 1 .. 100 ] characters

配信者ID
英数字のみ利用可能

password
required
string [ 8 .. 100 ] characters

配信者用パスワード。半角英数字と以下の記号のみ登録できます。

."#?!$%&()]@[,=~|`{}+*<>_/\;:^'-

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

created_at
required
string

配信者作成日時

updated_at
required
string

配信者更新日時

Request samples

Content type
application/json
{
  • "distributor_id": "distributor001",
  • "password": "distributor123"
}

Response samples

Content type
application/json
{
  • "contractor_id": "contractor001",
  • "distributor_id": "distributor001",
  • "created_at": "2022-03-01T00:00:00.000000+0900",
  • "updated_at": "2022-04-01T00:00:00.000000+0900"
}

配信者情報取得(複数)

契約者に紐づいた配信者の情報を取得します

Authorizations:
contractor_token
query Parameters
includes_deleted_distributors
boolean
Default: false
Example: includes_deleted_distributors=true

削除された配信者を含めるか。trueで含める、false/未指定で含めない

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

itemsに含まれる配信者の数

required
Array of objects

配信者情報の一覧

Request samples 

curl -v -X GET 'https://${end_point}/distributors?includes_deleted_distributors=True'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "total_count": 1,
  • "items": {
    }
}

配信者情報削除

配信者を削除します。

Authorizations:
contractor_token
path Parameters
distributor_id
required
string
Example: distributor001

削除対象の配信者ID

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
distributor_id
required
string

配信者ID

Request samples 

curl -v -X DELETE 'https://${end_point}/distributors/{distributor_id}'
-H 'Authorization: Bearer {contractor_token}'
-H 'Content-Type: application/json'

Response samples

Content type
application/json
{
  • "distributor_id": "distributor001"
}

配信者情報取得(単数)

配信者の情報を取得します。

Authorizations:
contractor_token
path Parameters
distributor_id
required
string
Example: distributor001

検索対象の配信者ID

query Parameters
includes_deleted_distributors
boolean
Default: false

削除された配信者を含めるか。trueで含める、false/未指定で含めない

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

created_at
required
string

配信者作成日時

updated_at
required
string

配信者更新日時

alias_count
integer
Default: 0

エイリアスの数。配信者に紐づいた作成済みのエイリアスの数を返す。

deleted
boolean or null

削除ユーザフラグ trueで削除ユーザ、falseでは削除されていないユーザとなる includes_deleted_distributors:trueを指定した場合のみ付加される

Request samples 

curl -v -X GET 'https://${end_point}/distributors/{distributor_id}?includes_deleted_distributors=False'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "contractor_id": "contractor001",
  • "distributor_id": "distributor001",
  • "created_at": "2022-03-01T00:00:00.000000+0900",
  • "updated_at": "2022-04-01T00:00:00.000000+0900",
  • "alias_count": 0,
  • "deleted": true
}

配信者情報更新

配信者を更新します。

Authorizations:
contractor_token
path Parameters
distributor_id
required
string
Example: distributor001

配信者ID

Request Body schema: application/json
password
required
string [ 8 .. 100 ] characters

配信者用パスワード。半角英数字と以下の記号のみ登録できます。

."#?!$%&()]@[,=~|`{}+*<>_/\;:^'-

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

created_at
required
string

配信者作成日時

updated_at
required
string

配信者更新日時

Request samples

Content type
application/json
{
  • "password": "distributor123"
}

Response samples

Content type
application/json
{
  • "contractor_id": "contractor001",
  • "distributor_id": "distributor001",
  • "created_at": "2022-03-01T00:00:00.000000+0900",
  • "updated_at": "2022-04-01T00:00:00.000000+0900"
}

利用可能機能設定

管理している配信者に対して、利用できる機能を設定するAPIについて記述します。

機能設定情報登録

機能設定情報を登録します。

パラメーターが以下の場合、登録できません。

  • 適用開始日に本日よりも前の日付が指定されている

  • 契約者が結んでいる契約で利用できないとされている機能を有効にしようとしている

Authorizations:
contractor_token
path Parameters
distributor_id
required
string
Example: distributorid

配信者ID

Request Body schema: application/json
start_date
required
string

適用開始日 yyyy-mm-dd

object or null

機能設定

object or null

機能設定上限数

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

start_date
required
string

適用開始日 yyyy-mm-dd

created_at
required
string

機能設定作成日時

updated_at
required
string

機能設定更新日時

object or null

機能設定

object or null

機能設定上限数

Request samples

Content type
application/json
{
  • "start_date": "2022-09-01",
  • "function_settings": {
    },
  • "function_settings_quota": {
    }
}

Response samples

Content type
application/json
{
  • "contractor_id": "exampleContractor",
  • "distributor_id": "exampleDistributor",
  • "start_date": "2022-09-01",
  • "created_at": "2022-08-01 12:00:00.000000+0900",
  • "updated_at": "2022-08-01 12:00:00.000000+0900",
  • "function_settings": {
    },
  • "function_settings_quota": {
    }
}

機能設定情報取得

配信者の機能設定情報を取得します。 最新の機能設定情報と機能設定変更の履歴が参照できます。

Authorizations:
contractor_token
path Parameters
distributor_id
required
string
Example: distributorid

配信者ID

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

required
Array of objects

機能設定履歴

object or null

最新の機能設定

Request samples 

curl -v -X GET 'https://${end_point}/distributors/{distributor_id}/function_settings'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "contractor_id": "exampleContractor",
  • "distributor_id": "exampleDistributor",
  • "function_setting_history": [
    ],
  • "latest_function_settings": {
    }
}

機能設定情報削除

機能設定情報を削除します。

パラメーターが以下の場合、削除できません。

  • 指定した適用開始日で登録された機能設定情報が存在しない
  • 指定した適用開始日が本日以前である
Authorizations:
contractor_token
path Parameters
distributor_id
required
string
Example: distributorid

配信者ID

Request Body schema: application/json
start_date
required
string

対象の機能設定の適用開始日 yyyy-mm-dd

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

start_date
required
string

対象の機能設定の適用開始日 yyyy-mm-dd

Request samples

Content type
application/json
{
  • "start_date": "2022-09-01"
}

Response samples

Content type
application/json
{
  • "contractor_id": "exampleContractor",
  • "distributor_id": "exampleDistributor",
  • "start_date": "2022-09-01"
}

機能設定情報更新

機能設定情報を更新します。

パラメーターが以下の場合、登録できません。

  • 適用開始日に本日よりも前の日付が指定されている

  • 契約者が結んでいる契約で利用できないとされている機能を有効にしようとしている

Authorizations:
contractor_token
path Parameters
distributor_id
required
string
Example: distributorid

配信者ID

Request Body schema: application/json
start_date
required
string

適用開始日 yyyy-mm-dd

required
object

機能設定

object or null

機能設定上限数

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

start_date
required
string

適用開始日 yyyy-mm-dd

created_at
required
string

機能設定作成日時

updated_at
required
string

機能設定更新日時

object or null

機能設定

object or null

機能設定上限数

Request samples

Content type
application/json
{
  • "start_date": "2022-09-01",
  • "function_settings": {
    },
  • "function_settings_quota": {
    }
}

Response samples

Content type
application/json
{
  • "contractor_id": "exampleContractor",
  • "distributor_id": "exampleDistributor",
  • "start_date": "2022-09-01",
  • "created_at": "2022-08-01 12:00:00.000000+0900",
  • "updated_at": "2022-08-01 12:00:00.000000+0900",
  • "function_settings": {
    },
  • "function_settings_quota": {
    }
}

分析

コンテンツの視聴分析に利用するAPIについて記述します。

新規/リピート統計取得

Authorizations:
contractor_token
Request Body schema: application/json
from
required
string >= 2023-01-01

対象年月日(開始)

to
string

対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。

timeframe
string
Default: "day"
Enum: "day" "month" "year"

集計期間

distributor_ids
Array of strings or null[ items non-empty ]

配信者IDリスト

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
required
object

期間内全体統計

required
Array of objects

時系列統計

total_count
required
integer

時系列統計データレコード件数

Request samples

Content type
application/json
{
  • "from": "2023-01-01",
  • "to": "2023-01-02",
  • "timeframe": "day",
  • "distributor_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "items": [
    ],
  • "total_count": 1
}

コンテンツ統計情報取得

Authorizations:
contractor_token
Request Body schema: application/json
from
required
string >= 2023-01-01

対象年月日(開始)

to
string

対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。

distributor_ids
Array of strings or null[ items non-empty ]

配信者IDリスト

group_by
string
Default: "content_id"
Enum: "content_id" "country" "region" "referrer" "device" "os" "os_version" "browser" "browser_version"

統計値を集約するディメンションfilter_byにcontent_id以外のディメンションを指定する場合、group_byにはcontent_id以外を指定できません。

group_name
string or null non-empty

ディメンションの集約グループ名
content_idで集約してコンテンツIDをグループ名に指定すると、1つのコンテンツだけで集計されます。
countryで集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
regionで集約して国名をグループ名に指定すると、その国内での地域で集計されます。
referrerで集約して参照元ドメインをグループ名に指定すると、その参照元ドメインのコンテンツだけで集計されます。
deviceで集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
osで集約してOSをグループ名に指定すると、そのOSだけで集計されます。
os_versionで集約してOSをグループ名に指定すると、そのOSのメジャーバージョンで集計されます。
browserで集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。
browser_versionで集約してブラウザ名をグループ名に指定すると、そのブラウザのメジャーバージョンで集計されます。

content_id
string or null non-empty

コンテンツID
集計対象のコンテンツを1つに限定します。
group_nameフィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、空の結果となります。

filter_by
string or null non-empty
Enum: "content_id" "country" "referrer" "device" "os" "browser"

ディメンションを絞るグループ名

filter_value
string or null non-empty

filter_byで指定したディメンションを絞り込む値

sort_by
string
Default: "plays"
Enum: "plays" "impressions" "plays_from_impressions" "average_play_duration_seconds" "transfer"

並び替えに使用するフィールド

order
string
Default: "desc"
Enum: "asc" "desc"

昇順(asc) / 降順(desc)

media_type
string
Default: "video"
Enum: "pdf" "video" "live" "audio"

コンテンツ種別

page_size
integer [ 1 .. 200 ]
Default: 20

1ページあたりのコンテンツ数

page
integer >= 1
Default: 1

ページ番号

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

対象のレコード件数

required
Array of objects

統計

page
integer >= 1
Default: 1

ページ番号

Request samples

Content type
application/json
{
  • "from": "2023-01-01",
  • "to": "2023-01-02",
  • "distributor_ids": [
    ],
  • "group_by": "content_id",
  • "group_name": "グループ名",
  • "content_id": "4ba28124-c54g-83d8-9xxb-5324bddbafc9",
  • "filter_by": "content_id",
  • "filter_value": "content_id",
  • "sort_by": "plays",
  • "order": "desc",
  • "media_type": "video",
  • "page_size": 20,
  • "page": 1
}

Response samples

Content type
application/json
{
  • "total_count": 1,
  • "items": [
    ],
  • "page": 1
}

コンテンツ時系列統計情報取得

Authorizations:
contractor_token
Request Body schema: application/json
from
required
string >= 2023-01-01

対象年月日(開始)

to
string

対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。

timeframe
string
Default: "day"
Enum: "day" "month" "year"

集計期間

distributor_ids
Array of strings or null[ items non-empty ]

配信者IDリスト

group_by
string
Default: "content_id"
Enum: "content_id" "country" "referrer" "device" "os" "browser"

統計値を集約するディメンション

group_name
string or null non-empty

ディメンションの集約グループ名
特定のグループ名で集約するときに指定します。
content_idで集約するときはコンテンツIDが指定できます。
countryで集約して国名をグループ名に指定すると、その国名のコンテンツだけで集計されます。
referrerで集約して参照元をグループ名に指定すると、その参照元のコンテンツだけで集計されます。
deviceで集約してデバイス種別をグループ名に指定すると、そのデバイス種別だけで集計されます。
osで集約してOSをグループ名に指定すると、そのOSだけで集計されます。
browserで集約してブラウザ名をグループ名に指定すると、そのブラウザだけで集計されます。

content_id
string or null non-empty

コンテンツID
集計対象のコンテンツを1つに限定します。
group_nameフィールドにコンテンツIDを指定した場合に、このフィールドで別のコンテンツIDを指定すると異なるコンテンツIDで2回フィルターされることになり、0で埋められた結果が返ります。

media_type
string
Default: "video"
Enum: "pdf" "video" "live" "audio"

コンテンツ種別

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
required
object

期間内全体統計

required
Array of objects

時系列統計

total_count
required
integer

時系列データレコード件数

group_name
string or null

ディメンションの集約グループ名

alternative_group_name
string or null

ディメンションの集約グループ別名
content_idで集約したときコンテンツのタイトルが設定されます。

Request samples

Content type
application/json
{
  • "from": "2023-01-01",
  • "to": "2023-01-02",
  • "timeframe": "day",
  • "distributor_ids": [
    ],
  • "group_by": "content_id",
  • "group_name": "グループ名",
  • "content_id": "4ba28124-c54g-83d8-9xxb-5324bddbafc9",
  • "media_type": "video"
}

Response samples

Content type
application/json
{
  • "total": {
    },
  • "items": [
    ],
  • "total_count": 1,
  • "group_name": "グループ名",
  • "alternative_group_name": "タイトル"
}

コンテンツ視聴維持率取得

Authorizations:
contractor_token
path Parameters
content_id
required
string non-empty
Example: content_id

コンテンツID

query Parameters
distributor_id
required
string non-empty
Example: distributor_id=distributorid

配信者ID

from
required
string >= 2023-01-01
Example: from=2023-01-01

対象年月日(開始)

to
string
Example: to=2023-01-02

対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。

media_type
string
Default: "video"
Enum: "pdf" "video" "live"
Example: media_type=video

コンテンツ種別

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
required
Array of objects

視聴維持率統計

total_count
required
integer

視聴維持率データレコード件数

Request samples 

curl -v -X GET 'https://${end_point}/distributors/analytics/contents/{content_id}/audience_retention?distributor_id=distributorid&from=2023-01-01&to=2023-01-02&media_type=video'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total_count": 1
}

コンテンツ再生達成率取得

Authorizations:
contractor_token
path Parameters
content_id
required
string
Example: 4ba28124-c54g-83d8-9xxb-5324bddbafc9

コンテンツID

query Parameters
distributor_id
required
string non-empty
Example: distributor_id=distributorid

配信者ID

from
required
string >= 2023-01-01
Example: from=2023-01-01

対象年月日(開始)

to
string
Example: to=2023-01-02

対象年月日(終了)
無指定のとき実行時前日の年月日(日本時間)が設定されます。

media_type
string
Default: "video"
Value: "video"
Example: media_type=video

コンテンツ種別

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
required
Array of objects

再生達成率統計

total_count
required
integer

再生達成率データレコード件数

Request samples 

curl -v -X GET 'https://${end_point}/distributors/analytics/contents/{content_id}/completion?distributor_id=distributorid&from=2023-01-01&to=2023-01-02&media_type=video'
-H 'Authorization: Bearer {contractor_token}'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total_count": 1
}

配信者用トークン取得

配信者用トークンを取得するAPIについて記述します。

配信者トークン取得

アクセストークン、リフレッシュトークンを取得します。

grant_typeに応じて、リクエストするパラメーターが違います。（後述） ただし、どちらの場合もレスポンスは同じです。

各APIへのリクエスト時には、当該APIで取得したトークンをヘッダーに設定してください。

Authorization: Bearer access_token

アクセストークンの場合

  • grant_type: "password" 固定

  • contractor_id/distributor_id/password:必須

リフレッシュトークンの場合

  • grant_type: "refresh_token" 固定

  • refresh_token:必須

Request Body schema: application/json
grant_type
required
string
Enum: "password" "refresh_token"

権限付与タイプ

refresh_token
string or null

リフレッシュトークン

password
string or null

配信者用パスワード

contractor_id
string or null <= 100 characters

契約者ID

distributor_id
string or null <= 100 characters

配信者ID

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
distributor_id
required
string

配信者ID

access_token
required
string

アクセストークン

access_token_expires_at
required
string

アクセストークンの有効期限。

refresh_token
required
string

リフレッシュトークン

refresh_token_expires_at
string or null

リフレッシュトークンの有効期限。

distributor_id_alias
string or null

配信者IDエイリアス

Request samples

Content type
application/json
{
  • "grant_type": "password",
  • "refresh_token": "exampleToken",
  • "password": "password",
  • "contractor_id": "contractorid",
  • "distributor_id": "distributorid"
}

Response samples

Content type
application/json
{
  • "distributor_id": "distributorid",
  • "access_token": "exampleAccessToken",
  • "access_token_expires_at": "2020-01-01T00:00:00.000000+0900",
  • "refresh_token": "exampleRefreshToken",
  • "refresh_token_expires_at": "2020-01-01T00:00:00.000000+0900",
  • "distributor_id_alias": "exampleDistributorIdAlias"
}

利用量取得

ストレージ利用量と転送量を取得するAPIについて記述します。

ストレージ利用量取得

配信者のVODでのストレージ利用量を取得します。

  • 配信者の利用量を取得することができます。
Authorizations:
distributor_token
query Parameters
from
required
string >= 2022-01-01
Example: from=2022-01-01

検索開始日

to
string
Example: to=2022-01-02

検索終了日
無指定のとき実行時前日の年月日(日本時間)が設定されます。

kind
string or null
Default: "day"
Enum: "day" "month" "year"
Example: kind=day

集計単位

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

itemsの総数

required
Array of objects

ストレージ利用量一覧

Request samples 

curl -v -X GET 'https://${end_point}/distributors/usages/vod/storages?from=2022-01-01&to=2022-01-02&kind=day'
-H 'Authorization: Bearer {distributor_token}'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": {
    }
}

転送量取得

配信者のVODでの転送量を取得します。

  • 配信者の転送量を取得することができます。
Authorizations:
distributor_token
query Parameters
from
required
string >= 2022-01-01
Example: from=2022-01-01

検索開始日

to
string
Example: to=2022-01-02

検索終了日
無指定のとき実行時前日の年月日(日本時間)が設定されます。

kind
string or null
Default: "day"
Enum: "day" "month" "year"
Example: kind=day

集計単位

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
total_count
required
integer

itemsの総数

required
Array of objects

転送量一覧

Request samples 

curl -v -X GET 'https://${end_point}/distributors/usages/vod/transfers?from=2022-01-01&to=2022-01-02&kind=day'
-H 'Authorization: Bearer {distributor_token}'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": {
    }
}

利用量CSVダウンロード

配信者のVODでの利用量(ストレージ利用量、転送量)のCSVファイルを取得します。

Authorizations:
distributor_token
query Parameters
from
required
string >= 2022-01-01
Example: from=2022-01-01

検索開始日

to
string
Example: to=2022-01-02

検索終了日
無指定のとき実行時前日の年月日(日本時間)が設定されます。

kind
string
Default: "day"
Enum: "day" "month" "year"
Example: kind=day

集計単位

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/octet-stream
string <binary>

Request samples 

curl -v -X GET 'https://${end_point}/distributors/usages/vod/csv?from=2022-01-01&to=2022-01-02&kind=day'
-H 'Authorization: Bearer {distributor_token}'

Response samples

Content type
application/json
Example
{
  • "errorCode": "MCRM_CMN_0004",
  • "reason": "必須パラメーターが存在しません。[param_names]"
}

配信者自身の情報

配信者自身の情報を管理するAPIについて記述します。

配信者自身の情報取得

配信者自身の情報を取得します。

Authorizations:
distributor_token

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

required
object

機能設定

required
object

機能設定利用可能上限

created_at
required
string

作成日時

updated_at
required
string

更新日時

distributor_id_alias
required
string or null

配信者IDエイリアス

expires_at
string or null

失効日

Request samples 

curl -v -X GET 'https://${end_point}/distributors/me'
-H 'Authorization: Bearer {distributor_token}'

Response samples

Content type
application/json
{
  • "contractor_id": "32fc4184-39a2-4162-9997-fdfbbe987d3c",
  • "distributor_id": "distributor001",
  • "function_settings": {
    },
  • "function_settings_quota": {
    },
  • "created_at": "2022-03-01T00:00:00.000000+0900",
  • "updated_at": "2022-04-01T00:00:00.000000+0900",
  • "distributor_id_alias": "distributorAlias001",
  • "expires_at": null
}

配信者自身の情報更新

配信者自身の情報を更新します。

Authorizations:
distributor_token
Request Body schema: application/json
password
string or null [ 8 .. 100 ] characters

配信者用パスワード。半角英数字と以下の記号のみ登録できます。

."#?!$%&()]@[,=~|`{}+*<>_/\;:^'-

Responses

Response Headers
Access-Control-Allow-Origin
*
Response Schema: application/json
contractor_id
required
string

契約者ID

distributor_id
required
string

配信者ID

required
object

機能設定

required
object

機能設定利用可能上限

created_at
required
string

作成日時

updated_at
required
string

更新日時

distributor_id_alias
required
string or null

配信者IDエイリアス

expires_at
string or null

失効日

Request samples

Content type
application/json
{
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "contractor_id": "32fc4184-39a2-4162-9997-fdfbbe987d3c",
  • "distributor_id": "distributor001",
  • "function_settings": {
    },
  • "function_settings_quota": {
    },
  • "created_at": "2022-03-01T00:00:00.000000+0900",
  • "updated_at": "2022-04-01T00:00:00.000000+0900",
  • "distributor_id_alias": "distributorAlias001",
  • "expires_at": null
}