アベイルAPI

HTTPコード

説明

再試行可能

200

API呼び出しが成功しました。呼び出し側はレスポンスオブジェクトで追加の詳細をチェックする必要があります。

該当なし

400

検証失敗を含む不正なリクエスト。

No

401

許可されていません。

No

404

見つかりません。

No

500

内部エラー。

Yes

503

依存関係エラー。

Yes

タイプ

説明

Boolean

ブーリアン型。許可される値: true、false

Integer

32ビットの符号付き整数。

LongInteger

64ビットの符号付き整数。

Decimal

浮動小数点数。

String

文字の配列。

Timestamp

ISOタイムスタンプ。

Enum

あらかじめ定義された許容値のセットを含む列挙文字列。

Struct

構造は他の属性を集約する役割を担います。

Array

ASME規格品目のコレクション。[]により指定。

属性

タイプ

必須性

説明

avail

Avail

Yes

利用可能状況データ - これは、putまたはvalidateリクエストの最上位属性です

属性

タイプ

必須性

説明

success

Boolean

Yes

操作ステータス

errors

Error[]

No

失敗の場合のエラーのリスト

属性

タイプ

必須性

説明

requestItems

PutAvailsBatchAPIRequestItem[]

Yes

個々のリクエストのリスト

属性

タイプ

必須性

説明

responseItems

PutAvailsBatchAPIResponseItem[]

Yes

レスポンス項目のリスト

属性

タイプ

必須性

説明

requestItemId

String

Yes

バッチリクエスト内の項目の一意の識別子。バッチ内の各項目を識別するために使用する一意の文字列であり、当社からバッチレスポンスにリンクされます。

path

String

Yes

このリクエスト項目のリソースへのパス。
完全抽出モデルの場合の形式は次のとおりです:
/avails/{licensor}/full-extract/{ALID}

body

PutAvailsBatchAPIRequestItemBody

Yes

利用可能状況データ

属性

タイプ

必須性

説明

avail

Avail

Yes

利用可能状況データ

属性

タイプ

必須性

説明

requestItemId

String

Yes

バッチリクエスト内の項目の一意の識別子

success

Boolean

Yes

操作ステータス

errors

Error[]

No

失敗の場合のエラーのリスト

属性

タイプ

必須性

説明

avail

Avail

Yes

利用可能状況データ

success

Boolean

Yes

操作ステータス

errors

Error[]

No

失敗の場合のエラーのリスト

属性

タイプ

必須性

説明

requestItems

GetAvailsBatchAPIRequestItem[]

Yes

個々のリクエストのリスト

属性

タイプ

必須性

説明

responseItems

GetAvailsBatchAPIResponseItem[]

Yes

レスポンス項目のリスト

属性

タイプ

必須性

説明

requestItemId

String

Yes

バッチリクエスト内の項目の一意の識別子

path

String

Yes

このリクエスト項目のリソースへのパス。
完全抽出モデルの場合の形式は次のとおりです:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

属性

タイプ

必須性

説明

requestItemId

String

Yes

バッチリクエスト内の項目の一意の識別子

success

Boolean

Yes

操作ステータス

errors

Error[]

No

失敗の場合のエラーのリスト

avail

Avail

No

アベイルオブジェクト

属性

タイプ

必須性

説明

avail

Avail

Yes

利用可能状況データ

属性

タイプ

必須性

説明

success

Boolean

Yes

操作ステータス

errors

Error[]

No

失敗の場合のエラーのリスト

属性

タイプ

必須性

説明

requestItems

ValidateAvailsBatchAPIRequestItem[]

Yes

個々のリクエストのリスト

属性

タイプ

必須性

説明

responseItems

ValidateAvailsBatchAPIResponseItem[]

Yes

レスポンス項目のリスト

属性

タイプ

必須性

説明

requestItemId

String

Yes

バッチリクエスト内の項目の一意の識別子

path

String

Yes

リクエストのリソースへのパス:
完全抽出モデル: /avails/{licensor}/full-extract/{ALID}/validate

body

ValidateAvailsBatchAPIRequestItemBody

Yes

リクエスト本文

属性

タイプ

必須性

説明

avail

Avail

Yes

利用可能状況データ

属性

タイプ

必須性

説明

requestItemId

String

Yes

バッチリクエスト内の項目の一意の識別子

success

Boolean

Yes

操作ステータス

errors

Error[]

No

失敗の場合のエラーのリスト

属性

タイプ

必須性

説明

success

Boolean

Yes

操作ステータス

errors

Error[]

No

失敗の場合のエラーのリスト

属性

タイプ

必須性

説明

requestItems

DeleteAvailsBatchAPIRequestItem[]

Yes

個々のリクエストのリスト

属性

タイプ

必須性

説明

responseItems

DeleteAvailsBatchAPIResponseItem[]

Yes

レスポンス項目のリスト。

属性

タイプ

必須性

説明

requestItemId

String

Yes

バッチリクエスト内の項目の一意の識別子

path

String

Yes

このリクエスト項目のリソースへのパス。
完全抽出モデルの場合の形式は次のとおりです:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH|FIXED_FEE}&channelIdentity={Channel}

属性

タイプ

必須性

説明

requestItemId

String

Yes

バッチリクエスト内の項目の一意の識別子

success

Boolean

Yes

操作ステータス

errors

Error[]

No

失敗の場合のエラーのリスト

属性

タイプ

必須性

説明

code

String

Yes

エラータイプを説明する文字列。
検証エラーコード: APIV{number}、CRMSV{number}
サービスエラーコード: APIE{number}、CRMSE{number}
例: APIV400、CRMSE500

メッセージ

String

Yes

人間が読み取れるエラーの説明

属性

タイプ

必須性

注意

EMAファイルマッピング

ALID

String

Yes

タイトル識別子を指定します。メタデータコントリビューションで指定されるALIDと一致する必要があります。

ALID

Disposition

AvailDisposition

Yes

抽出モデルの粒度を指定します。

該当なし

Licensor

Publisher

Yes

Prime Videoにライセンスを付与する企業に関する情報を指定します。

該当なし

Asset

AvailAsset[]

Yes

アセットに関する情報。リストには1つのアセットのみを指定する必要があります。

該当なし

Transaction

AvailTrans[]

Yes

取引に関する情報。

該当なし

SharedEntitlement

AvailSharedEntitlement[]

No

他のサービスの権限付与に関する情報。

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

EntryType

Enum

Yes

許可される値: FullExtract、FullDelete

Disposition

属性

タイプ

必須性

注意

EMAファイルマッピング

DisplayName

String

Yes

Prime Videoパートナーの名前を指定します。この値はPrime Videoによってパートナーに提供されます。EMAファイルで使用される値と同じであることが必要です。

DisplayName

属性

タイプ

必須性

注意

EMAファイルマッピング

_contentID

String

Yes

このアセットのコンテンツIDを指定します。通常はALIDと同じです。

ContentID

WorkType

Enum

Yes

許可される値: Movie、Short、Episode、Season、Supplemental

WorkType

Metadata

AvailUnitMetadata

条件付き

映画またはショート動画のメタデータを説明します。WorkTypeが映画またはショート動画の場合に必須です。

該当なし

EpisodeMetadata

AvailEpisodeMetadata

条件付き

エピソードのメタデータを説明します。WorkTypeがエピソードの場合に必須です。

該当なし

SeasonMetadata

AvailSeasonMetadata

条件付き

シーズンのメタデータを説明します。WorkTypeがシーズンの場合に必須です。

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

_ecosystem

Enum

Yes

許可される値: DMA
注意: UVVU - 紫外線はサポートされていません。

該当なし

EcosystemID

String

Yes

エコシステム固有のタイトル識別子

DMA_ID

属性

タイプ

必須性

注意

EMAファイルマッピング

TitleInternalAlias

String[]

Yes

作品名。リストでは1つの作品名のみを指定する必要があります。

TitleInternalAlias

属性

タイプ

必須性

注意

EMAファイルマッピング

TitleInternalAlias

String[]

Yes

エピソードの作品名。リストでは1つの作品名のみを指定する必要があります。

EpisodeTitleInternalAlias

EpisodeNumber

ContentSequenceInfo

Yes

シーズン内のこのエピソードの番号。

EpisodeNumber

SeasonMetadata

AvailSeasonMetadata

条件付き

シーズンのメタデータを説明します。WorkTypeがエピソードかシーズンの場合は必須です。

該当なし

SeriesMetadata

AvailSeriesMetadata

条件付き

シリーズのメタデータを説明します。WorkTypeがエピソードかシーズンの場合は必須です。

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

SeasonContentID

String

Yes

シーズンのALID。

SeasonContentID

SeasonTitleInternalAlias

String[]

No

シーズンの作品名。リストでは1つの作品名のみを指定する必要があります。

SeasonTitleInternalAlias

SeasonNumber

ContentSequenceInfo

Yes

シリーズ内のこのシーズンの番号。

SeasonNumber

NumberOfEpisodes

Integer

Yes

このシーズン内のエピソード数。

EpisodeCount

SeriesMetadata

AvailSeriesMetadata

条件付き

シリーズのメタデータを説明します。WorkTypeがシーズンの場合に必須です。

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

SeriesContentID

String

Yes

シリーズのALID。

SeriesContentID

SeriesTitleInternalAlias

String[]

No

シリーズの作品名。リストでは1つの作品名のみを指定する必要があります。

SeriesTitleInternalAlias

NumberOfSeasons

Integer

No

このシリーズ内のシーズン数。

SeasonCount

属性

タイプ

必須性

注意

EMAファイルマッピング

_TransactionID

String

No

利用可能状況期間枠の一意の識別子。FullExtractを使用する場合のオプションです。

AvailID

LicenseType

Enum

Yes

許可される値: SVOD、FVOD、EST、POEST、VOD

LicenseType

Territory

Region[]

Yes

配信が許可される地域。1つの地域項目のみが提供される必要があります。1つのアベイルオブジェクト内のすべての取引は、同じ地域であることが必要です。

Territory

Start

DateTime

Yes

ISO形式による配信の開始日時。

注意: タイムゾーンが含まれていない場合、その地域で最も東側のタイムゾーンを使用します。ただし、特定のリリース時刻を希望する場合は、任意のタイムゾーンを含められます。

Start

End

DateTime

No

ISO形式による配信の終了日時。提供されない場合、配信期間は無制限です。

注意: タイムゾーンが含まれていない場合、その地域で最も東側のタイムゾーンを使用します。ただし、特定の終了時間を指定する場合は、任意のタイムゾーンを含められます。

End

AssetLanguage

AssetLanguage[]

No

アセットの言語は、アセットタイプを伴うISO言語コードで表されます。許可されるアセットタイプ: subtitle、audio、subdub、sub、dub、ov、mta、any

AssetLanguage

AllowedLanguage

AssetLanguage[]

No

アセットタイプを伴うISO言語コード。許可されるアセットタイプ: subtitle、audio、sub、dub、subdub、any

AllowedLanguages

HoldbackLanguage

AssetLanguage[]

No

アセットタイプを伴うISO言語コード許可されるアセットタイプ: subtitle、audio、sub、dub、subdub、any

HoldbackLanguage

LicenseRightsDescription

String

No

公開の優先順位を指定するために使用します。

LicenseRightsDescription

FormatProfile

AvailFormatProfile

Yes

利用可能なビデオの画質。許可される値: SD、HD、UHD

FormatProfile

ContractID

String

No

契約情報を指定します。許可される値:
- CPH
- FIXED_FEE
- FIXED_FEE:{Deal ID}
アベイルを送信する場合、FIXED_FEEオプションはライセンサーによって制限されます。

ContractID

Terms

AvailTerms[]

Yes

利用可能状況期間枠のビジネス条件のリストを指定します。

OtherTerms

OtherInstructions

String

No

利用可能状況期間枠に関する追加の処理指示。

OtherInstructions

属性

タイプ

必須性

注意

EMAファイルマッピング

country

String

Yes

2文字のISO 3166-1国コード

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

value

String

Yes

アセットの言語は、アセットタイプを伴うRFC 5646言語コードで表されます。

該当なし

_asset

String

No

AvailTransタイプの言語属性に応じて、異なる値のセットを使用できます。
AvailTrans.AssetLanguageで許可される値:
subtitle、audio、subdub、sub、dub、ov、mta、any。
この属性では、すべての言語で同じアセットが提出される必要があります。
AvailTrans.AllowedLanguageおよびAvailTransで許可される値。HoldbackLanguage:
subtitle、audio、sub、dub、subdub、any。
アセットの値が「subdub」または「any」であるか、アセットの値がない場合は、「subtitle」と「audio」の2つのアセットに分散されます。
アセットの「subtitle」と「audio」は、MDDFの同等の「subtitle」と「audio」に変換されます。

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

value

Enum

Yes

利用可能なビデオの画質。許可される値: SD、HD、UHD

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

_termName

String

Yes

条件を識別します。値は大文字と小文字を区別しません。許可される値のリストについては、以下を参照してください。

該当なし

Money

Money

No

詳細については、以下を参照してください。

該当なし

Text

String

No

詳細については、以下を参照してください。

該当なし

Event

DateTime

No

詳細については、以下を参照してください。

該当なし

Boolean

Boolean

No

詳細については、以下を参照してください。

該当なし

Duration

String

No

詳細については、以下を参照してください。

該当なし

Number

Integer

No

詳細については、以下を参照してください。

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

value

Decimal

No

金額値、一部の価格タイプでは必須

該当なし

_currency

String

Yes

ISO通貨コード

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

value

String

Yes

ISO 8601規格における時間数。形式: PT{N}H。{N}は整数の時間数です。例えば、48時間はPT48H、30日間はPT720Hとなります。

該当なし

属性

タイプ

必須性

注意

EMAファイルマッピング

Number

Integer

Yes

エピソード番号やシーズン番号などの、コンテンツシーケンス番号

該当なし

条件名

属性

必須性

注意

EMAファイルマッピング

ChannelIdentity

Text

Yes

チャンネルまたはチャンネル登録の識別子。

GroupIdentity

Tier

Text

条件付き

価格階層。ライセンスタイプがPOESTの場合は必須です。

PriceType

SRP

Money

条件付き

希望小売価格。ライセンスタイプがPOESTの場合は必須です。

SRP

WSP

Money

条件付き

卸売価格。ライセンスタイプがPOESTの場合は必須です。

PriceValue

Category

Text

条件付き

価格カテゴリー。ライセンスタイプがPOESTの場合は必須です。

PriceValue

AnnounceDate

Event

No

利用可能状況対象地域における作品の利用開始日を小売業者が発表できる日付。

AnnounceDate

SuppressionLiftDate

Event

条件付き

ある作品が、将来の特定日に利用可能な地域で利用可能になるとして公表されることが可能な最初の日付。ライセンスタイプがPOESTの場合は必須です。

SuppressionLiftDate

RentalDuration

Duration

条件付き

時間単位のレンタル期間。ライセンスタイプがSVODの場合は必須です。

RentalDuration

WatchDuration

Duration

条件付き

開始後、ユーザーが視聴を完了するまでの時間数。ライセンスタイプがSVODの場合は必須です。

WatchDuration

Download

Text

No

ライセンスにはダウンロードの許可が含まれます。有効な値は ありといいえです。ライセンスタイプがSVODの場合、レンタル期間と視聴期間の両方を指定する必要があります。

Download

Exclusive

Boolean

No

アセットは取引範囲で独占されるものとなります。

Exclusive

ExclusiveAttributes

Text

No

独占のタイプを指定します。Exclusiveがtrueの場合にのみ考慮されます。Exclusiveがtrueで提供されない場合はデフォルト値が使用されます。

ExclusiveAttributes

BrandingRights

Boolean

No

ブランディングを表示したいというパートナーの意図を示します。

BrandingRights

BrandingRightsAttributes

Text

No

ブランディングのテキストを指定します。BrandingRightsがtrueの場合にのみ考慮されます。BrandingRightsがtrueで提供されない場合はデフォルト値が使用されます。

BrandingRightsAttributes

allowAds

Boolean

No

広告を許可するか禁止するかを決定します。この条件は1回しか表示できません。

EMAでは使用できません

allowedAdPlacement

Text

条件付き

広告を挿入できるロール内の位置を指定します。許可される値: PreRoll、MidRoll、PostRoll、Overlays、PauseAds、Squeezebacks。
許可されるのは、allowAdsがtrueである場合のみです。
この条件は複数回表示できます。allowedAdPlacementまたはprohibitedAdPlacementのいずれかを指定できますが、両方は指定できません。

EMAでは使用できません

prohibitedAdPlacement

Text

条件付き

広告を挿入できないロール内の位置を指定します。許可される値: PreRoll、MidRoll、PostRoll、Overlays、PauseAds、Squeezebacks。
この条件は複数回表示できます。
許可されるのは、allowAdsがtrueである場合のみです。
allowedAdPlacementまたはprohibitedAdPlacementのいずれかを指定できますが、両方は指定できません。

EMAでは使用できません

cuepointDeliveryAndUsage

Text

No

キューポイントの配信と使用の義務事項を指定します。許可される値: PartnerWillDeliverAndPrimeVideoMustUse、PrimeVideoWillUseIfDelivered、NoDeliveryOrUsageObligations、TalentObligated。
許可されるのは、allowAdsがtrueである場合のみです。

EMAでは使用できません

blindBasisSelling

Text

No

許可される値: GuaranteedImpressions、NoGuaranteedImpressions
この属性を使用する必要があるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

sponsorships

Text

No

許可される値: Permitted、Prohibited、PermittedWithRestrictions。
この属性を使用する必要があるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

sponsorshipsRestrictions

Text

条件付き

自由形式のテキスト
この属性を使用する必要があるのは、スポンサーがAllowedWithRestrictionsに設定される場合のみです。

EMAでは使用できません

talentAndAmazon
AdGuidelines

(**には改行があってはなりません)

Text

No

許可される値: NoRestrictions、ConsultationRequired
この属性を使用する必要があるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

talentRestrictions

Text

条件付き

自由形式のテキスト
この属性を使用する必要があるのは、talentAndAmazonAdGuidelinesがConsultationRequiredに設定されている場合のみです。

EMAでは使用できません

adLoadLimit

Text

No

1時間あたりの広告の分数。値は有効な整数であることが必要です。
この属性を使用する必要があるのは、allowAdsがtrueに設定されている場合のみです。

EMAでは使用できません

adKey

Text

No

自由形式のテキスト
コンテンツを広告管理サーバーにマッピングするための一意の識別子。

EMAでは使用できません

CompleteYourBundle
DiscountPercentage

(**には改行があってはなりません)

Number

No

お客様がまだ所有していない残りの作品を購入してセット品を完成させると、パーセント割引が適用されます。たとえば、20%オフの場合、2シーズンのセット品でシーズン1を所有しているお客様はシーズン2を20%オフで購入できます。

EMAでは使用できません

ExcludedFrom
BundleDiscount

(**には改行があってはなりません)

Boolean

No

trueに設定すると、この利用可能状況期間枠をセット品割引対象から除外します。プレミアム価格期間(例: 新作リリース時)や、定価を維持する必要がある作品に使用します。設定なしまたはfalseの場合、作品はセット品割引の対象となります。

EMAでは使用できません

値

説明

TVOD

TVODは購入またはレンタルを意味します。関連するライセンスタイプ: EST、VOD、POEST

PRIME_SUBSCRIPTION

AmazonプライムまたはAmazon Kids+の登録。関連するライセンスタイプ: SVOD

CHANNELS

サードパーティチャンネル登録。関連するライセンスタイプ: SVOD

FVOD

無料コンテンツ。関連するライセンスタイプ: FVOD