Graph API Version

Canvas Text

Reading

Text element of the canvas

Example

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

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

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

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The id of the element

background_color
string

The color of the background for 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

font_family
string

The font family

font_size
numeric string

The size of the font for the text

line_height
numeric string

The line height of the text

name
string

The name of the element

rich_text

The text content of the element

text_alignment
enum

The alignment of the text

text_color
string

The color of the text

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 CanvasText by making a POST request to /{canvas_text_id}.

Parameters

ParameterDescription
background_color
string

The color of the background for the text

bottom_padding
float

The padding below the text

font_family
string

The font family of the text

font_size
int64

The size of the font for the text

line_height
float

The line height of the text

name
string

Name of the text element

rich_text
Object

The text content of the text element

text_alignment
enum {LEFT, CENTER, RIGHT}

The alignment of the text

text_color
string

The color of the text

top_padding
float

The padding above the text

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 CanvasText by making a DELETE request to /{canvas_text_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
210User not visible