Graph API Version

Canvas Video

Reading

A video inside canvas

Examples

Graph API Explorer
GET /v2.10/{canvas-video-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{canvas-video-id}'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{canvas-video-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{canvas-video-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{canvas-video-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription

id

numeric string

The id of the element

bottom_padding

numeric string

The padding below the element

element_group_key

string

The element group key to bundle multiple elements in editing

element_type

enum

The type of the element

name

string

The name of the element

style

enum

The presentation style of the video

top_padding

numeric string

The padding above the element

video

The facebook video node

Edges

No edges

Validation Rules

ErrorDescription
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can update a CanvasVideo by making a POST request to /{canvas_video_id}.

Parameters

NameDescription
bottom_padding
float

The padding below the video

name
string

Name of the video element

style
enum {FIT_TO_WIDTH, FIT_TO_HEIGHT}

The presentation style of the video

top_padding
float

The padding above the video

video_id
id

ID of Facebook video used in the video element

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Deleting

You can delete a CanvasVideo by making a DELETE request to /{canvas_video_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}