Graph API Version

Canvas Video

Reading

A video inside canvas

Example

use FacebookAds\Api;
use FacebookAds\Http\RequestInterface;

$params = array(
  'fields' => array(
    'id',
    'name',
    'video',
  ),
);

$data = Api::instance()->call(
  '/' . <CANVAS_VIDEO_ID>,
  RequestInterface::METHOD_GET,
  $params)->getContent();

curl -G \
  --data-urlencode 'fields=[ 
    "id", 
    "name", 
    "video" 
  ]' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/<CANVAS_VIDEO_ID>

Parameters

This endpoint doesn't have any parameters.

Fields

Field	Description
`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 Default
`name` string	The name of the element Default
`style` enum	The presentation style of the video
`top_padding` numeric string	The padding above the element
`video` Video	The facebook video node

Error Codes

Error	Description
80001	There have been too many calls to this Page account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting.

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

Parameter	Description
`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,

}

Error Codes

Error	Description
100	Invalid parameter

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,

}

Error Codes

Error	Description
210	User not visible