Version API du graphe

Canvas Header

Lecture

A header inside the canvas.

Example

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

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

$data = Api::instance()->call(
  '/' . <CANVAS_HEADER_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_HEADER_ID>

Paramètres

Ce point de terminaison n’a aucun paramètre.

Champs

ChampDescription
id
numeric string

The id of the element

background_color
string

The background color of the header

bottom_padding
numeric string

The padding below the element

child_elements
list<CanvasPhoto>

The child elements inside the header. You can only specify images, not text or other media.

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

top_padding
numeric string

The padding above the element

Error Codes

ErreurDescription
368The action attempted has been deemed abusive or is otherwise disallowed

Création

Vous ne pouvez pas effectuer cette opération sur ce point de terminaison.

Mise à jour

Vous ne pouvez pas effectuer cette opération sur ce point de terminaison.

Suppression

You can delete a CanvasHeader by making a DELETE request to /{canvas_header_id}.

Paramètres

Ce point de terminaison n’a aucun paramètre.

Type de retour

Struct {
success: bool,
}

Error Codes

ErreurDescription
100Invalid parameter