グラフAPIバージョン

グループライブ動画

ライブ動画APIについて詳しくは、ライブ動画のドキュメントをご覧ください。

作成

次のパスから、live_videosエッジにPOSTリクエストを実行できます。

/{group-id}/live_videos

このエッジに投稿すると、ライブ動画が作成されます。

パラメーター

名前	説明
`app_attribution_tag` 数値文字列または整数	フィードに表示されるライブ動画のアトリビューションタグ。
`attribution_app_id` 数値文字列または整数	アトリビューションアプリのID。
`content_tags` list<numberic string>	動画のコンテンツを説明するタグ。`type=adinterest`を指定して検索エンドポイントを使用し、利用可能なIDを入手します。以下はクエリの例です。 /search?type=adinterest&q=sunsets
`description` UTF-8文字列	ライブ動画の説明。絵文字を使用可能。
`encoding_settings` 文字列	配信者がこのストリーミングで使用しているエンコード設定グループのID。このパラメーターは、現在360度ライブ配信でのみ使用されています。このパラメーターには、事前設定されているエンコード設定の`identifier`キーの値が渡されます。エンコードの事前設定値は、`/broadcaster_encoding_settings`グラフAPIエンドポイントをクエリ(`GET`クエリ)すると見つかります。
`event_params` 整数	配信者がライブ配信を計画している時間のUnixタイムスタンプ。
`fisheye_video_cropped` ブール値	単一魚眼動画をトリミングするかどうか。
`front_z_rotation` float	単一魚眼動画のフロントz回転(度数)。
`game_id` 数値文字列または整数	この動画が取り上げるゲームを設定します。`type=game`を指定して検索エンドポイントを使用し、利用可能なIDを入手します。以下はクエリの例です。 /search?type=game&=pubg
`game_specs` ゲーム仕様のパラメーター	アトリビューション分析の対象となるゲームを表すメタデータを設定します。
`is_spherical` ブール値	配信が360度ライブ配信であることを示すフラグ。
`live_encoders` list<numberic string or integer>	このライブ動画に配信されるライブ配信エンコーダー。
`original_fov` int64	カメラのオリジナルの視野。
`post_surfaces_blacklist` list<enum{1, 2, 3, 4, 5}>	フィードのみのエクスペリエンスに関する、投稿が表示されない箇所のブラックリスト。
`privacy` プライバシーパラメーター	このライブ動画のプライバシー。
`projection` enum{EQUIRECTANGULAR, CUBEMAP}	360度ライブストリーミングの予期されるプロジェクションを示すフラグ。デフォルト値はEQUIRECTANGULARです。
`save_vod` ブール値	動画データを後でVODフォーマットで使用するために保存するかどうか。デフォルトはtrueです。(注: 作成時にのみ設定可能)
`schedule_custom_profile_image` 画像	日時指定されているライブストーリーおよびロビーに表示される、カスタム画像。
`spatial_audio_format` enum{ambiX_4}	スペーシャルオーディオストリーミングのフォーマットを示します。指定されない場合、音声はモノラルまたはステレオと見なされます。
`status` enum {UNPUBLISHED, LIVE_NOW, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_CANCELED}	配信のステータス。`LIVE_NOW`の配信は、現在ユーザーが見ることができるライブ配信です。`UNPUBLISHED`の配信は、他のユーザーが見ることができない準備中の配信です。非公開の配信は、この状態のまま数時間経過すると削除される場合があります。計画に基づく配信を作成するには、日時指定済みステータスを使うことを検討してください。
`stereoscopic_mode` enum {MONO, LEFT_RIGHT, TOP_BOTTOM}	この動画の立体モードに対して、このフラグを設定します。
`stop_on_delete_stream`	`deleteStream` RTMPコマンドを受信したときにストリーミングを停止する必要がある場合は、これを`true` に設定します。
`title` UTF-8文字列	ライブ動画のタイトル。絵文字を使用可能。

戻り値の型

このエンドポイントでは、リードアフターライトがサポートされており、戻り値の型のidで表されるノードを読み取ります。

Struct { id: numeric string, stream_url: string, secure_stream_url: string, stream_secondary_urls: List [ string ], secure_stream_secondary_urls: List [ string ], dash_ingest_url: string, }

検証ルール

エラー	説明
100	無効なパラメーター
200	アクセス許可エラー

読み取り

機能

名前	説明
グループAPI	これはアプリレビューを必要とする機能です。

例

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{group-id}/live_videos",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

GET /v7.0/{group-id}/live_videos HTTP/1.1
Host: graph.facebook.com

// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{group-id}/live_videos"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

/* make the API call */
FB.api(
    "/{group-id}/live_videos",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{group-id}/live_videos',
    'your-access-token'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

グラフAPIについて詳しくは、グラフAPIの利用ガイドをご覧ください。

パラメーター

名前説明

名前	説明
`broadcast_status` list<enum {UNPUBLISHED, LIVE, LIVE_STOPPED, PROCESSING, VOD, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_EXPIRED, SCHEDULED_CANCELED}>	返されるライブ動画の種類を指定できます。値を指定しないと、すべてのステータスタイプが返されます。
`source` enum{target, owner}	デフォルト値: `target` 動画のクエリが行われるソース。例: `target`を指定すると、動画をグループに配信できます。グループライブ動画で指定できるのは`target`だけです。

broadcast_status

list<enum {UNPUBLISHED, LIVE, LIVE_STOPPED, PROCESSING, VOD, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_EXPIRED, SCHEDULED_CANCELED}>

返されるライブ動画の種類を指定できます。値を指定しないと、すべてのステータスタイプが返されます。

source

enum{target, owner}

デフォルト値: target

動画のクエリが行われるソース。例: targetを指定すると、動画をグループに配信できます。グループライブ動画で指定できるのはtargetだけです。

フィールド

このエッジから読み取ると、JSON形式の結果が返されます。

{ "data": [], "paging": {} }

data

ライブ動画フィールドのリスト。

paging

ページネーションについて詳しくは、グラフAPIのガイドをご覧ください。

検証ルール

エラー	説明
200	アクセス許可エラー

更新

この操作は、このエンドポイントでは実行できません。

削除

この操作は、このエンドポイントでは実行できません。