Graph API Version

Canvas Carousel

Reading

A carousel inside a canvas

Example

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

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

$data = Api::instance()->call(
  '/' . <CANVAS_CAROUSEL_ID>,
  RequestInterface::METHOD_GET,
  $params)->getContent();
curl -G \
  --data-urlencode 'fields=[ 
    "child_elements", 
    "id", 
    "name" 
  ]' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v2.11/<CANVAS_CAROUSEL_ID>

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

child_elements
list<CanvasPhoto|CanvasDynamicPhoto>

The child elements of the carousel

element_type
enum

The type of the element

name
string

The name of the element

style
enum

The presentation style of the carousel

top_padding
numeric string

The padding above the element

Error Codes

ErrorDescription
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can update a CanvasCarousel by making a POST request to /{canvas_carousel_id}.

Parameters

ParameterDescription
bottom_padding
float

The padding below the carousel

child_elements
list<id>

The child elements of the carousel

name
string

Name of the carousel element

style
enum {FIT_TO_WIDTH, FIT_TO_HEIGHT}

The presentation style of the carousel

top_padding
float

The padding above the carousel

Return Type

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

Error Codes

ErrorDescription
100Invalid parameter

Deleting

You can delete a CanvasCarousel by making a DELETE request to /{canvas_carousel_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
262Incorrect permission to publish pages