圖形 API
圖形 API 版本

Canvas Header

閱讀中

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>

參數

這個端點沒有任何參數。

欄位

欄位說明
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

錯誤說明
368The action attempted has been deemed abusive or is otherwise disallowed

建立中

你無法在此端點執行此操作。

更新中

你無法在此端點執行此操作。

刪除中

你可以向 /{canvas_header_id} 提出刪除要求，以刪除 a CanvasHeader 。

參數

這個端點沒有任何參數。

傳回類型

Struct {
success: bool,
}

Error Codes

錯誤說明
100Invalid parameter