Graph API
Graph API-Version

Canvas Header

Wird gelesen

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>

Parameter

Dieser Endpunkt hat keine Parameter.

Felder

FeldBeschreibung
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

Standard
name
string

The name of the element

Standard
top_padding
numeric string

The padding above the element

Error Codes

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

Wird erstellt

Diese Handlung kann auf diesem Endpunkt nicht durchgeführt werden.

Wird aktualisiert

Diese Handlung kann auf diesem Endpunkt nicht durchgeführt werden.

Wird gelöscht

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

Parameter

Dieser Endpunkt hat keine Parameter.

Rückgabetyp

Struct {
success: bool,
}

Error Codes

FehlerBeschreibung
100Invalid parameter