Table of contents
TOC
目次を折りたたむ
目次を展開する

ビデオ REST API リファレンス

最終更新日: 2017/11/10

適用対象:SharePoint Online | Office 365

REST ビデオ API を使用すると、SharePoint Online で Office 365 ビデオ サービスのビデオを検出して対話できます。ビデオおよびチャネルに関する情報を取得したり、新しいビデオをアップロードしたり、ビデオをストリーミングするための情報を取得できます。

ビデオ REST API の使用

ビデオ REST API で使用されるオブジェクトには、ビデオとチャネルの 2 種類があります。

ビデオ REST API を操作するには、サポートされているメソッド ( GET、POST、MERGE または DELETE) を使用する HTTP 要求を送信します。

「ビデオ ポータルの操作」セクションで説明されているように、すべてのビデオ API 要求は、探索サービスから取得したルート URL を使用します。

パス URL リソース名とクエリ パラメーターは、大文字と小文字が区別されません。ただし、割り当てた値、エンティティ ID、その他の base64 でエンコードされた値では大文字と小文字を区別します。

Office 365 API は Microsoft Azure Active Directory (Azure AD) と OAuth を使用して、アプリケーション要求を認証します。 アプリケーションからビデオ API にアクセスする場合は、適切な範囲のアクセス許可で Azure AD に登録する必要があります。 Office 365 ビデオ REST API は、OData 4.0 標準をサポートしており、アプリは RESTful インターフェイスを使用して Office 365 のビデオ データと対話することができます。

アクセス許可の対象は、3 つのカスタム グループに分かれます。

  • 管理者は、チャネルの設定を変更し、ビデオを編集できます。
  • コントリビューターは、ビデオの作成、読み取り、更新、削除 (CRUD) を行うことができます。
  • 閲覧者は、ビデオを表示することだけができます。

各チャネルのチャネル所有者は、組織内のユーザーがどのグループに属するかを決定します。さらに、SharePoint テナント管理者も同じことを決定できます。

詳しくは、「Office 365 プラットフォームでの開発」を参照してください。

ビデオ ポータルの操作

ビデオ ポータルのルート URL を取得して、他のすべてのビデオ REST API 操作で使用できます。ビデオ ポータルがセットアップされていて有効かどうかを判別できます。


ビデオ ポータルに関する情報の取得

O365 探索サービスを使用してルート SharePoint サイト コレクション URL (RootSite) を取得した後、その URL から VideoService.Discover を呼び出して、SharePoint Online のビデオ ポータルの URL を取得します。それを以降のすべての呼び出しで使用します。 ビデオ ポータルがセットアップされていて有効かどうかを判別します。

注: 探索サービスにアクセスするには、会社の SharePoint ポータルにログインする必要があります。

通常、SharePoint のルート サイト コレクションのエンドポイント URL は次のようになります (架空の企業 Contoso の場合)。

https://contoso.sharepoint.com/

探索サービスによって返される同じ会社のビデオ ポータルのエンドポイント URL は、次のようになります。

https://contoso.sharepoint.com/portals/hub

GET {RootSite}/_api/VideoService.Discover

注:RootSite パラメーターは、SharePoint のルート サイト コレクションのエンドポイント URL を表す文字列であり、探索サービスから取得します。

応答の種類

  • IsVideoPortalEnabled - ポータルが有効でセットアップされている場合は True を返し、ポータルが有効ではないか、またはセットアップされていない場合は False を返します。
  • VideoPortalURL - 以降のすべての呼び出しで使用されるビデオ ポータルのエンドポイント URL です。

バージョン管理情報が使用できるようになったときに簡単に追加できるよう、この URL に対して定数を定義して使用することをお勧めします。

要求のサンプル

GET https://a830edad9050849nda1.sharepoint.com/_api/VideoService.Discover

応答のサンプル

状態コード:200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/_api/$metadata#SP.ApiData.VideoServiceDiscoverers/@Element",
  "odata.type": "SP.Publishing.VideoServiceDiscoverer",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/_api/VideoService.Discover",
  "odata.editLink": "VideoService.Discover",
  "ChannelUrlTemplate": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_layouts/15/videochannel.aspx?channel={0}",
  "IsVideoPortalEnabled": true,
  "PlayerUrlTemplate": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_layouts/15/videoplayer.aspx?v={0}",
  "VideoPortalLayoutsUrl": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_layouts/15",
  "VideoPortalUrl": "https://a830edad9050849nda1.sharepoint.com/portals/hub"
}

チャネルの操作

ビデオはチャネルに保存されます。ユーザーがビデオをアップロードできるをすべてのチャネルのリストと、ユーザーが表示できるすべてのチャネルのリストを取得できます。チャネルの ID、チャネルの色、チャネルのタイトル、チャネルに含まれるすべてのビデオのリストなど、特定のチャネルについての情報を取得することもできます。


ユーザーが表示またはアップロードできるチャネルに関する情報の取得

ユーザーがビデオをアップロードできるチャネルのリストの取得

ユーザーがビデオをアップロードできるチャネルのリストを取得します。これらは、ユーザーが所有者またはエディターのアクセス許可を持っているチャネルです。

GET {VideoPortalURL}/_api/VideoService/CanEditChannels

この呼び出しおよび以降のすべての呼び出しでは、VideoPortalURL は、VideoService.Discover の呼び出しで取得した、ビデオ ポータルのエンドポイント URL を表す文字列です。

応答の種類

Channel オブジェクトのリストを返します。

ビデオ ポータルに多くのチャネルがある場合、この API が戻るまでに長い時間がかかる可能性があります。


ユーザーが表示できるチャネルのリストの取得

ユーザーが表示できる全チャネルのリストを取得します。これらは、ユーザーが所有者、エディター、またはビューアーのアクセス許可を持っているチャネルです。

GET {VideoPortalURL}/_api/VideoService/Channels

応答の種類

Channel オブジェクトのリストを返します。

要求のサンプル

GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels

応答のサンプル

状態コード:200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoChannels",
  "value": [
    {
      "odata.type": "SP.Publishing.VideoChannel",
      "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
      "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
      "Description": "",
      "Id": "1833f204-bb2a-4e93-b8dd-b236daeccae8",
      "ServerRelativeUrl": "/portals/Red-Channel",
      "TileHtmlColor": "#FF0000",
      "Title": "Red Channel",
      "YammerEnabled": true
    },
    {
      "odata.type": "SP.Publishing.VideoChannel",
      "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'c0949ba6-44fb-4db4-9d44-a395f7e9070f')",
      "odata.editLink": "VideoService/Channels(guid'c0949ba6-44fb-4db4-9d44-a395f7e9070f')",
      "Description": "",
      "Id": "c0949ba6-44fb-4db4-9d44-a395f7e9070f",
      "ServerRelativeUrl": "/portals/Blue-Channel",
      "TileHtmlColor": "#0072c6",
      "Title": "Blue Channel",
      "YammerEnabled": true
    },
    {
      "odata.type": "SP.Publishing.VideoChannel",
      "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'f92879ac-63bb-4247-a267-73e91cd2fe59')",
      "odata.editLink": "VideoService/Channels(guid'f92879ac-63bb-4247-a267-73e91cd2fe59')",
      "Description": "",
      "Id": "f92879ac-63bb-4247-a267-73e91cd2fe59",
      "ServerRelativeUrl": "/portals/community",
      "TileHtmlColor": "#2A8DD4",
      "Title": "Community",
      "YammerEnabled": true
    }
  ]
}

特定のチャネルに関する情報の取得

チャネル ID、チャネルの色、チャネルのタイトルの取得

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。

応答の種類

チャネルに関する次の情報を返します。

  • ID - チャネルの ID。
  • TileHtmlColor - チャネルの色。
  • Title - チャネルのタイトル。

要求のサンプル

GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')

応答のサンプル

状態コード:200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoChannels/@Element",
  "odata.type": "SP.Publishing.VideoChannel",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
  "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
  "Description": "",
  "Id": "1833f204-bb2a-4e93-b8dd-b236daeccae8",
  "ServerRelativeUrl": "/portals/Red-Channel",
  "TileHtmlColor": "#FF0000",
  "Title": "Red Channel",
  "YammerEnabled": true
}

チャネルの全ビデオのリストの取得

指定されたチャネルのすべてのビデオのリストを取得します。

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。

応答の種類

Video オブジェクトのリストを返します。

要求のサンプル

GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos

応答のサンプル

状態コード:200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoChannels/@Element",
  "odata.type": "SP.Publishing.VideoChannel",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
  "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')",
  "Description": "",
  "Id": "1833f204-bb2a-4e93-b8dd-b236daeccae8",
  "ServerRelativeUrl": "/portals/Red-Channel",
  "TileHtmlColor": "#FF0000",
  "Title": "Red Channel",
  "YammerEnabled": true
}

チャネルで再生可能な最新のビデオのリストの取得

チャネルにアップロードされた最新のビデオのソートされたリストを取得し、再生する準備がまだできていないビデオをすべて除外します。ただし、自分でアップロードしたものは除外されません。

チャネルでコード変換が完了して生成できる状態 (VideoProcessingStatus = 2) になっているすべてのビデオ、および再生する準備ができていなくても現在ログインしているユーザーによってアップロードされたビデオの、ソートされたリストが返されます。

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/GetAllVideos

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。

応答の種類

Video オブジェクトのリストを返します


ビデオの操作

チャネルから特定のビデオの情報を取得し、ビデオが表示された回数および再生の情報を取得します。また、チャネルにビデオをアップロードし、チャネルのビデオを更新し、チャネルからビデオを削除します。


ビデオに関する情報の取得

作成日、タイトル、再生時間、ビデオのサムネイルの URL、処理状態など、特定のビデオに関する情報を取得します。

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。

応答の種類

次の情報を返します。

  • CreatedDate -- ビデオが最初にアップロードされた日付。
  • Title -- ビデオのタイトル。
  • VideoDurationInSeconds -- ビデオの再生時間 (秒単位)。
  • ThumbnailURL - ビデオのサムネイル イメージの URL。
  • VideoProcessingStatus - ビデオの処理の状態。以下の値が設定されます。
    • 0 -- (既定値) -- ビデオはまだ再生用に処理されていません。
    • 1 -- ビデオは取得されて処理中です。
    • 2 -- ビデオは再生できる状態です。
    • 3 -- ビデオは、処理のために Azure Media Services へのアップロード中にエラーが発生しました。
    • 4 -- エラー -- 一般エラー -- ストリーミング用にビデオを処理できません。
    • 5 -- エラー -- タイムアウト エラー -- ストリーミング用にビデオを処理できません。
    • 6 -- エラー -- サポートされない形式 -- ビデオ ファイルの種類は、Azure Media Services によるストリーミング再生にサポートされていません。

要求のサンプル

GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')

応答のサンプル

状態コード:200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoItems/@Element",
  "odata.type": "SP.Publishing.VideoItem",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')",
  "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')",
  "ChannelID": "1833f204-bb2a-4e93-b8dd-b236daeccae8",
  "CreatedDate": "2015-07-08T05:05:06Z",
  "Description": "",
  "DisplayFormUrl": "https://a830edad9050849nda1.sharepoint.com/portals/Red-Channel/pVid/Forms/DispForm.aspx?ID=5",
  "FileName": "Divers - Future of Productivity.mp4",
  "OwnerName": "TEST_TEST_SPOProvHeartbeat_E3_15_4911090814_22,#i:0#.f|membership|admin@a830edad9050849nda1.onmicrosoft.com,#admin@a830edad9050849NDA1.onmicrosoft.com,#admin@a830edad9050849NDA1.onmicrosoft.com,#TEST_TEST_SPOProvHeartbeat_E3_15_4911090814_22,#https://a830edad9050849nda1-my.sharepoint.com:443/User%20Photos/Profile%20Pictures/admin_a830edad9050849nda1_onmicrosoft_com_MThumb.jpg,#,#",
  "ServerRelativeUrl": "/portals/Red-Channel/pVid/Divers - Future of Productivity.mp4",
  "ThumbnailUrl": "https://a830edad9050849nda1.sharepoint.com/portals/Red-Channel/pVid/Divers - Future of Productivity.mp4.PNG?VideoPreview=1",
  "Title": "Divers - Future of Productivity",
  "ID": "6b518eae-b0d9-4951-b6da-1e5f58a43daa",
  "Url": "https://a830edad9050849nda1.sharepoint.com/portals/Red-Channel/pVid/Divers - Future of Productivity.mp4",
  "VideoDurationInSeconds": 388,
  "VideoProcessingStatus": 2,
  "ViewCount": -1,
  "YammerObjectUrl": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_layouts/15/videoplayer.aspx?v=https%3A%2F%2Fa830edad9050849nda1%2Esharepoint%2Ecom%2Fportals%2FRed%2DChannel%2FpVid%2FDivers%20%2D%20Future%20of%20Productivity%2Emp4"
}

ビデオの表示回数の取得

表示回数は検索分析によって集計されるので、表示回数は検索エンドポイントから Video オブジェクトを取得するときにのみ返されます。したがって、ハブまたはチャネルの /Search エンドポイントから取得されたとき以外は、ViewCount プロパティの値は正しくありません。1 つのビデオの表示数を取得するには、ビデオの ID を使用して検索クエリを実行します。

GET {VideoPortalURL}/_api/videoservice/Channels('{channelId}')/search/query('{videoId}')?$Select=ViewCount

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。

クエリ パラメーター

名前説明
_$Select=ViewCountstring応答に含める表示回数。

応答の種類

ビデオが表示された回数を返します。

要求のサンプル

GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')?$Select=ViewCount

応答のサンプル

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#SP.ApiData.VideoItems/@Element&$select=ViewCount",
  "odata.type": "SP.Publishing.VideoItem",
  "odata.id": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')",
  "odata.editLink": "VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')",
  "ViewCount": -1
}

ビデオの再生に関する情報の取得

ビデオの Azure Media Services マニフェストの URL の取得

ビデオの Azure Media Services マニフェストの URL を取得します。Azure Media Services アセットの再生をサポートするプレーヤーに、このマニフェストをフィードできます。

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetPlaybackUrl('{streamingFormatType}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。
streamingFormatTypenumericビデオのストリーミング形式の種類。

streamingFormatType パラメーターは次のいずれかの値です。

  • 1 -- Smooth Streaming または MPEG-DASH
  • 0 -- HLS ストリーミング

応答の種類

ビデオのマニフェストの URL を返します。

要求のサンプル

GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')/GetPlaybackUrl(1)

応答のサンプル

状態コード:200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#Edm.String",
  "value": "https://cdn-cvprbl201m01.streaming.mediaservices.windows.net/dc91ba77-e23b-4f2d-9a6b-1b4e96ed554a/9c9b55ed-24d3-45d5-b8dd-f262856a8812.ism/Manifest"
}

ビデオの暗号化の解除にアクセスするためのベアラー トークンの取得

O365 のビデオはすべて AES で暗号化されます。Smooth Streaming または MPEG-DASH 形式でビデオを再生するには、最初に、コンテンツの復号化にアクセスするためのベアラー トークンを取得する必要があります。この API は、プレーヤーがコンテンツを復号化できる認証トークンを返します。

ただし、HLS ストリーミングの場合は、HLS 形式のマニフェストを取得するときに使用するマニフェスト URL の一部になっているため、キー アクセス トークンを別途取得する必要はありません。

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetStreamingKeyAccessToken

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。

応答の種類

プレーヤーがコンテンツの暗号化の解除ができる認証トークンを返します。

要求のサンプル

GET https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/VideoService/Channels(guid'1833f204-bb2a-4e93-b8dd-b236daeccae8')/Videos(guid'6b518eae-b0d9-4951-b6da-1e5f58a43daa')/GetStreamingKeyAccessToken

応答のサンプル

状態コード:200

{
  "odata.metadata": "https://a830edad9050849nda1.sharepoint.com/portals/hub/_api/$metadata#Edm.String",
  "value": "Bearer=urn%3amicrosoft%3aazure%3amediaservices%3acontentkeyidentifier=589ae2f2-969e-43bb-bd04-8d5dad4cce4b&urn%3amicrosoft%3aazure%3amediaservices%3akeyacquisitionhostname=cvprbl201m01.keydelivery.mediaservices.windows.net&http%3a%2f%2fschemas.microsoft.com%2faccesscontrolservice%2f2010%2f07%2fclaims%2fidentityprovider=https%3a%2f%2fnimbuslkgglobacs.accesscontrol.windows.net&urn%3aServiceAccessible=service&Audience=urn%3aNimbus&ExpiresOn=1438217438&Issuer=https%3a%2f%2fnimbuslkgglobacs.accesscontrol.windows.net%2f&HMACSHA256=QHrVRPwi4z1ogCTC5VSbzB%2bS4ThTAaZMvIRCrPQSYno%3d"
}

チャネルへのビデオのアップロード

ビデオをアップロードするプレースホルダーとして機能する空のビデオ オブジェクトを作成します。

それが済むと、小さい 1 つのビデオを 1 つの POST 呼び出しで、またはチャンクになった大きい1 つのビデオを複数の POST 呼び出しで、アップロードできます。

ビデオをアップロードするためのプレースホルダーの作成

ビデオをアップロードする場所のプレースホルダーとして機能する空のビデオ オブジェクトを作成します。

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。

要求本文

{ '__metadata': { 'type':'SP.Publishing.VideoItem' }, 'Description': ' { 説明のテキスト } ', 'Title': ' { ビデオのタイトル } ' }

名前説明
metadataSP.Publishing.VideoItem更新するオブジェクトの種類
Descriptionstringビデオの説明。
Titlestringビデオのタイトル。
FileNamestringビデオのファイル名。

応答の種類

VideoObject -- ビデオのアップロード先のオブジェクト。返される ID を、アップロードを開始するビデオ ID として使用します。


単一の POST での小さいビデオのアップロード

1 回の POST 送信に収まる小さな単一のビデオをアップロードします。

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/SaveBinaryStream

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。

要求本文

ファイルのバイナリ ストリーム。

応答の種類

200 を返します。応答本文はありません。


チャンクでの大きいビデオのアップロード

1 回の POST 呼び出しには収まらない大きさのビデオをアップロードする場合、またはチャンクでのアップロードをキャンセルするには、次の呼び出しを使用します。

前に作成したビデオ オブジェクトへのアップロードの開始

チャンクになったビデオのアップロードを開始します。

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/StartUpload(uploadId=guid'{yourGeneratedGuid}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。
yourGeneratedGuidGUIDアップロード セッション用に生成する GUID。

応答の種類

200 を返します。応答本文はありません。


前に作成したビデオ オブジェクトへのファイルの各チャンクのアップロード

ファイルの次のチャンクのアップロードを続けます。必要な回数だけ繰り返します。

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/ContinueUpload(uploadId=guid'{yourGeneratedGuid}',fileOffset='{offsetSize}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。
yourGeneratedGuidGUIDアップロード セッション用に生成する GUID。
offsetSizeinteger既にアップロードされたバイト数。

注:8 MB のチャンクをアップロードした場合、最初のチャンクのオフセットは 0 で、2 番目のチャンクのオフセットは 8 * 1024 = 8192 です。

要求本文

このチャンクのファイルのバイナリ ストリーム。

応答の種類

200 を返します。応答本文はありません。


前に作成したビデオ オブジェクトへのファイルの最終チャンクのアップロード終了

チャンクになったビデオのアップロードを終了します。

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/FinishUpload(uploadId=guid'{yourGeneratedGuid}',fileOffset='{offsetSize}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。
yourGeneratedGuidGUIDアップロード セッション用に生成する GUID。
offsetSizeinteger既にアップロードされたバイト数。

要求本文

最後のチャンクのファイルのバイナリ ストリーム。

応答の種類

200 を返します。応答本文はありません。


アップロードのキャンセル

チャンクになったビデオのアップロードをキャンセルします。

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetFile()/CancelUpload(uploadId=guid'{yourGeneratedGuid}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。
yourGeneratedGuidGUIDアップロード セッション用に生成する GUID。

応答の種類

200 を返します。応答本文はありません。


ビデオのメタデータの更新

チャネルの既存ビデオのメタデータの更新

ビデオのタイトルと説明を変更します。

POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。

要求ヘッダー

名前説明
X-HTTP-MethodstringX-HTTP-Method プロパティの値は MERGE です。

要求本文

{'__metadata':{'type':'SP.Publishing.VideoItem'},'Description':'{説明のテキスト}', 'Title':'{ビデオのタイトル}'}

名前説明
metadataSP.Publishing.VideoItemビデオ オブジェクトの型。
Descriptionstringビデオの説明。
Titlestringビデオのタイトル。

応答の種類

200 を返します。応答本文はありません。


チャネルからのビデオの削除

チャネルからの既存ビデオの削除

 POST {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。

要求ヘッダー

名前説明
X-HTTP-MethodstringX-HTTP-Method プロパティの値は DELETE です。

応答の種類

200 を返します。応答本文はありません。


別のページにビデオを埋め込む


別の Web ページにビデオ アイテムを埋め込むためのコードを取得し、パラメーターの値を指定する

この呼び出しを使用して、埋め込まれたウィンドウの幅と高さや、ページを開いたときにビデオを自動的に再生させるかどうか、ビデオを一時停止したときに特定の情報をビデオ プレーヤーに表示するかどうかなど、渡すパラメーターの値を指定できます。この情報には、ビデオのタイトル、再生時間、再生回数のカウント、およびチャネルの名前が含まれています。

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/GetVideoEmbedCode?width={width}&height={height}&autoplay={true/false}&showinfo={true/false}

パラメーターの値を渡さなかった場合、Office 365 はいくつかの実用的な既定設定 (幅 120、高さ 230 など) を選択します。

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。
widthnumeric埋め込みビデオ ウィンドウの幅。
heightnumeric埋め込みビデオ ウィンドウの高さ。
Autoplaytrue/false埋め込まれたビデオを自動的に再生するかどうか。
ShowInfotrue/falseビデオを一時停止したときにビデオのタイトル、再生時間、表示回数、およびチャネル名をプレーヤーに表示するかどうか。

応答の種類

埋め込みコードを返します。


既定値を使用して、別の Web ページにビデオ アイテムを埋め込むためのコードを取得する

この呼び出しを使用して、埋め込みビデオ プレーヤーの既定値を指定する埋め込みコードを取得できます。

GET {VideoPortalURL}/_api/VideoService/Channels('{channelId}')/Videos('{videoId}')/?$Select=Title,DefaultEmbedCode

ビデオ オブジェクトでは、"DefaultEmbedCode" プロパティは自動的に返されません。"DefaultEmbedCode" を取得するには、$select オプションを使用する必要があります。

$select オプションを使用して、タイトル、既定値の埋め込みコードなど、いずれかのビデオ プロパティを返すビデオ アイテムを要求することができます。

要求 URL パラメーター

必須パラメーター説明
channelIdstringチャネルの ID。
videoIdstringビデオの ID。

応答の種類

$select を使用して、要求する既定のプロパティ (既定の埋め込みコード値など) を返します。


プレーヤー ページ URL からビデオ アイテムの情報および既定の埋め込みコードを取得する

O365 ビデオ ポータル プレーヤー ページの URL がわかっている場合は、この呼び出しを使用して、ビデオ ID、チャンネル ID、およびビデオに関する他の情報を取得できます。

POST {VideoPortalURL}/_api/VideoService/GetVideoByURL?$Select=Title,Description,CreatedDate,DefaultEmbedCode,VideoDurationInSeconds,ID,VideoProcessingStatus

$select オプションを使用して、以下に示すように、タイトル、既定値の埋め込みコードなど、いずれかのビデオ プロパティを返すビデオ アイテムを要求することができます。

要求ヘッダー

Accept=application/json;odata=verbose

Content-Type=application/json;odata=verbose

要求本文

{'videoFileRelativeUrl':'https://root_SharePoint_site/portals/hub/_layouts/15/PointPublishing.aspx?app=video&p=p&chid=b74774cb-faad-43a0-8de9-cb263e38d75d&vid=e5b66725-9f87-4813-9b50-b24fe80c9c20'}

VideoFileRelativeURL は、O365 ビデオ ポータル プレーヤー ページのビデオの相対パスまたは絶対 URL です。


次の手順

アプリケーションのビルドを開始する準備ができている方にも、単に詳しい情報を必要としている方にも、最適なコンテンツをご用意しています。

Office 365 プラットフォームの使い方の詳細については、次のリンク先をご覧ください。

© 2018 Microsoft