メディアアセット検索プロトコル - - Alibaba Cloud ドキュメントセンター

このトピックでは、ApsaraVideo VODのメディアアセット検索用プロトコルの構文について説明します。 SearchMedia操作と一緒にプロトコルを使用する必要があります。プロトコルは、検索、フィルタリング、ソート、およびページ付けの機能を統合するリアルタイム検索プロトコルです。このプロトコルを使用して、ApsaraVideo VODのビデオ、オーディオ、画像などのメディアアセットに関する情報を照会できます。

構文

メディアアセットフィールドは、メディアアセット検索のためのプロトコルにおいて定義される構文規則に基づいて、以下のカテゴリに分類される: リターンフィールドとして使用されるフィールド、完全一致に使用されるフィールド、ファジー一致に使用されるフィールド、多値クエリに使用されるフィールド、範囲クエリに使用されるフィールド、およびソートフィールドとして使用されるフィールド。 ApsaraVideo VODでサポートされているすべてのメディアアセットフィールドと適用可能な構文ルールの詳細については、このトピックの「メディアアセット情報」のセクションをご参照ください。

注意

SearchMedia操作を呼び出してメディアアセット情報を照会するときは、照会文に対してURLエンコードを実行する必要があります。さらに、クエリ文では、等号 (=) 、二重引用符 (") 、一重引用符 (') 、括弧 () などの1バイトの句読点を使用する必要があります。メディアアセット検索用のプロトコルで定義されている特殊文字の詳細については、このトピックの「特殊文字」を参照してください。

次の表に、メディアアセット検索用のプロトコルで定義されている構文と検索例を示します。

項目	説明	構文	例
返されたフィールドとして使用されるフィールド	検索結果で返されるフィールドを指定します。デフォルトでは、各メディアアセットのID、作成時間、およびタイプのみが返されます。	field1,field2	Returned field
完全一致に使用されるフィールド	指定されたフィールドの値と完全に一致するメディア資産に関する情報を照会します。	フィールド=値	完全一致
ファジーマッチに使用されるフィールド	指定されたフィールドの値に指定された文字または文字列が含まれているメディア資産に関する情報を照会します。	フィールド ('value1','value2') またはフィールド='value'	Fuzzy match
複数値クエリに使用されるフィールド	指定されたフィールドの値のいずれかに一致するメディア資産に関する情報を照会します。	field in ('value1','value2')	複数値クエリ
範囲クエリに使用されるフィールド	Query the information about the media assets whose value of a specified field falls in a specified open or closed interval.	field = (value1,value2)	範囲クエリ
ソートフィールドとして使用されるフィールド	検索結果をソートするフィールドと、各フィールドに基づいて検索結果をソートする順序を指定します。降順と昇順がサポートされています。複数のソートフィールドは、優先順位に基づいて、降順で左から右にリストされます。	SortBy=フィールド: Desc	Sort field

Special characters

文字	説明	構文
と	Connects two filter conditions to query the information about the media assets that meet both the filter conditions.	field1 = 'value' and field2 = 'value'
or	Connects two filter conditions to query the information about the media assets that meet one of the filter conditions. If you use or in the query statement, you must enclose the filter conditions in a pair of parentheses ().	(field1 = 'value1' or field2 = 'value2')
( )	The parentheses, which are used to enclose a specified open or closed interval for a range query.	field = ('value1','value2')
( )	OR関係で複数のフィルター条件を囲むために使用される括弧。	(field1 = 'value1' またはfield2 = 'value2')
' '	STRING型のフィールド値を囲むために使用される単一引用符。	field = 'value'
,	複数値のクエリに使用されるコンマ。複数のフィールド値はコンマ (,) で区切ることができます。	フィールド ('value1','value2')
( ) [ ]	Specifies an open or closed interval for a range query. 区間の左右の端点を含めるか除外するかを指定できます。	field = ['value1','value2']
in	複数値クエリのフィールドに複数の値を指定して、指定されたフィールドの値の1つと一致するメディアアセットに関する情報を照会します。	フィールド ('value1','value2')

メディア資産情報

ApsaraVideo VODを使用すると、指定されたビデオ、オーディオ、画像、および補助メディアアセットに関する情報をクエリできます。次の表は、さまざまなメディアアセットフィールドに適用可能な構文規則について説明しています。以下の表の √ はサポートされていることを示し、× はサポートされていないことを示します。

ビデオ: ビデオに関する情報を指定します

注意

VideoIdフィールドを使用して、多値クエリで最大100個のビデオIDを指定できます。

フィールド	タイプ	説明	Used as a returned field	厳密な一致のために使用される	ファジーマッチに使用	複数値クエリに使用されます	Used for a range query	ソートフィールドとして使用
VideoId	String	ビデオのID。	√	√	×	√	×	×
AppId	String	アプリケーションの ID を示します。	√	×	×	√	×	×
CateId	Long	ビデオが属するカテゴリのID。	√	√	×	×	×	×
CateName	String	ビデオが属するカテゴリの名前。	√	×	×	×	×	×
StorageLocation	String	ビデオが保存されているリージョン。	√	√	×	√	×	×
タイトル	String	ビデオのタイトル。	√	×	√	√	×	×
タグ	String	ビデオのタグ。	√	×	√	√	×	×
説明	String	ビデオの説明。	√	×	√	√	×	×
ステータス	String	ビデオのステータス。	√	×	×	√	×	×
MediaSource	String	ビデオのソース。	√	×	×	√	×	×
PreprocessStatus	String	ビデオの前処理ステータス。	√	×	×	√	×	×
Size	Long	ビデオのサイズ。	√	×	×	×	√	×
有効期間	Float	ビデオの長さ。	√	×	×	×	√	×
CreationTime	String	ビデオが作成された時刻。	√	×	×	×	√	√
ModificationTime	String	ビデオが最後に更新された時刻。	√	×	×	×	√	√
CoverURL	String	サムネイルのURL。	√	×	×	×	×	×
スナップショット	String[]	自動スナップショットのリスト。	√	×	×	×	×	×
SpriteSnapshots	String[]	画像スプライトのリスト。	√	×	×	×	×	×
ダウンロードスイッチ	String	オフラインダウンロードを有効にするかどうかを指定します。	√	×	×	×	×	×
TranscodeMode	String	コード変換モード。	√	×	×	×	×	×

オーディオ: オーディオファイルに関する情報を指定します。

フィールド	タイプ	説明	返されたフィールドとして使用	厳密な一致のために使用される	ファジーマッチに使用	複数値クエリに使用されます	範囲クエリに使用されます	ソートフィールドとして使用
AudioId	String	オーディオのID。	√	√	×	×	×	×
AppId	String	アプリケーションの ID を示します。	√	×	×	√	×	×
CateId	Long	オーディオが属するカテゴリのID。	√	√	×	×	×	×
CateName	String	オーディオが属するカテゴリの名前。	√	×	×	×	×	×
StorageLocation	String	オーディオが保存されているリージョン。	√	×	×	√	×	×
タイトル	String	オーディオのタイトル。	√	×	√	√	×	×
タグ	String	オーディオのタグ。	√	×	√	√	×	×
説明	String	オーディオの説明。	√	×	√	√	×	×
ステータス	String	オーディオのステータス。The status of the audio.	√	×	×	√	×	×
MediaSource	String	オーディオのソース。	√	×	×	√	×	×
PreprocessStatus	String	オーディオの前処理ステータス。	√	×	×	√	×	×
Size	Long	The size of the audio.	√	×	×	×	√	×
有効期間	Float	オーディオの長さ。	√	×	×	×	√	×
CreationTime	String	The time when the audio was created.	√	×	×	×	√	√
ModificationTime	String	オーディオが最後に更新された時刻。	√	×	×	×	√	√
CoverURL	String	サムネイルのURL。	√	×	×	×	×	×
スナップショット	String[]	自動スナップショットのリスト。	√	×	×	×	×	×
SpriteSnapshots	String[]	The list of image sprites.	√	×	×	×	×	×
ダウンロードスイッチ	String	オフラインダウンロードを有効にするかどうかを指定します。	√	×	×	×	×	×
TranscodeMode	String	コード変換モード。	√	×	×	×	×	×

イメージ: イメージに関する情報を指定します。

フィールド	タイプ	説明	Used as a returned field	厳密な一致のために使用される	ファジーマッチに使用	複数値クエリに使用されます	範囲クエリに使用されます	Used as a sort field
ImageId	String	イメージの ID です。	√	√	×	×	×	×
AppId	String	アプリケーションの ID を示します。	√	×	×	√	×	×
CateId	Long	The ID of the category to which the image belongs.	√	√	×	×	×	×
CateName	String	画像が属するカテゴリの名前。	√	×	×	×	×	×
StorageLocation	String	イメージが保存されている領域。	√	√	×	√	×	×
FileName	String	イメージのファイル名。	√	×	√	√	×	×
タイトル	String	画像のタイトル。	√	×	√	√	×	×
タグ	String	画像のタグ。	√	×	√	√	×	×
説明	String	イメージの説明。	√	×	√	√	×	×
ステータス	String	イメージのステータス。	√	×	×	√	×	×
CreationTime	String	イメージが作成された時刻。	√	×	×	×	√	√
ModificationTime	String	The time when the image was last updated.	√	×	×	×	√	√
URL	String	画像のURL。	√	×	×	×	×	×

AttachedMedia: specifies the information about an auxiliary media asset

フィールド	タイプ	説明	返されたフィールドとして使用	厳密な一致のために使用される	Used for fuzzy match	複数値クエリに使用されます	範囲クエリに使用されます	ソートフィールドとして使用
MediaId	String	補助メディアアセットのID。	√	√	×	×	×	×
AppIdString	String	アプリケーションの ID を示します。	√	×	×	√	×	×
CateId	Long	補助メディア資産が属するカテゴリのID。	×	√	×	×	×	×
Categories	カテゴリ []	カテゴリIDのリスト。	√	×	×	×	×	×
StorageLocation	String	補助メディア資産が格納されているリージョン。	√	√	×	√	×	×
FileName	String	補助メディアアセットのファイル名。	√	×	√	√	×	×
タイトル	String	補助メディアアセットのタイトル。	√	×	√	√	×	×
タグ	String	The tag of the auxiliary media asset.	√	×	√	√	×	×
説明	String	補助メディアアセットの説明。	√	×	√	√	×	×
ステータス	String	補助メディア資産のステータス。	√	×	×	√	×	×
CreationTime	String	補助メディアアセットが作成された時刻。	√	×	×	×	√	√
ModificationTime	String	補助メディアアセットが最後に更新された時刻。	√	×	×	×	√	√
URL	String	補助メディアアセットのURL。	√	×	×	×	×	×
BusinessType	String	ビジネスのタイプ。	√	√	×	×	×	×

AttachedMedia: 補助メディアアセットに関する情報を指定します。

PreprocessStatus: メディアアセットの前処理ステータスを指定します。

ストリーミングパネルでライブストリーミングに使用できるのは、前処理されたメディアアセットのみです。

利点	説明	補足
UnPreprocess	メディアアセットは前処理されていません。	初期状態。
前処理	メディアアセットは前処理されています。	-
PreprocessSucceed	前処理は完了です。	-
PreprocessFailed	前処理が失敗しました。	-

DownloadSwitch: メディアアセットに対してオフラインダウンロードを有効にするかどうかを指定します。

メディアアセットは、オフラインダウンロードが有効になっている場合にのみオフラインモードでダウンロードできます。

利点	説明	補足
on	オフラインダウンロードが有効です。	メディア資産をオフラインモードでダウンロードできる初期状態。
off	オフラインダウンロードは無効です。	オフラインダウンロードが無効になっている場合、メディアアセットはオフラインモードでダウンロードできません。

MediaSource: メディアアセットのソースを指定します。

利点	説明	補足
一般	メディアアセットは、コンソールでApsaraVideo VODにアップロードされます。	シンプルアップロードモード。
short_video	メディアアセットは、ショートビデオSDKを使用してApsaraVideo VODにアップロードされます。	詳細については、「概要」をご参照ください。
編集	メディアアセットは、ビデオ制作タスクを使用してApsaraVideo VODにアップロードされます。	詳細については、「ProduceEditingProjectVideo」をご参照ください。
live	メディアアセットは、ライブストリーム録画を使用してApsaraVideo VODにアップロードされます。	N/A

TranscodeMode: specifies the transcoding mode

メディアアセットがApsaraVideo VODにアップロードされた後、特定の処理方法が実行された後にのみ再生できます。処理方法は、コード変換モードによって異なります。

利点	説明	補足
FastTranscode	一般的なトランスコーディング。	ApsaraVideo VODにアップロードされた後すぐにメディアアセットがトランスコードされるデフォルトモード。メディアアセットは、トランスコードされた後にのみ再生できます。
NoTranscode	メディアアセットは、トランスコードなしで配信されます。	メディアアサートは、ApsaraVideo VODにアップロードされた後はトランスコードされず、トランスコードなしですぐに再生できます。
AsyncTranscode	メディアアセットは、アップロード後すぐに配信され、トランスコードされます。	The media asset can be immediately played and asynchronously transcoded after it is uploaded to ApsaraVideo VOD.