入門
ジオフィルタリングプロパティは、POSTリクエストを使用して最初にビデオを作成するとき、またはPATCHリクエストを使用してビデオメタデータを更新するときに追加できます。見るを使用してビデオを更新するCMS API更新リクエストの例については。
ジオフィルタリングへのアクセス
認証
ビデオメタデータを更新するためにアクセス許可が必要になる操作は次のとおりです。video-cloud/video/update
またはvideo-cloud/video/all
。
構文
geo
次の3つのプロパティを持つオブジェクトです。
プロパティ | タイプ | 必須 | コメント |
---|---|---|---|
geo.countries |
国コード文字列の配列 | いいえ | アン2文字コードのISO3166リスト小文字でビデオを視聴するためにホワイトリストまたはブラックリストに登録される国の場合 |
geo.exclude_countries |
ブール値 | いいえ | 場合true 、表示はないに含まれる国で許可されていますgeo.countries リスト;もしfalse 、表示はのみそれらの国では許可されています。 |
geo.restricted |
ブール値 | いいえ | 場合true ビデオに対してジオフィルタリングが有効になっている |
要求
https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/{video_ID}
リクエスト本文:
リクエストの本文は、含めるまたは除外する国の略語の配列を含むJSONオブジェクトになります。
{"geo" : {
"restricted" : true,
"exclude_countries" : false,
"countries" : ["ph","in","my","ja"]
}
}