グラフAPI
グラフAPIバージョン

Canvas Header

読み取り

A header inside the canvas.

Example

パラメーター

このエンドポイントにはパラメーターがありません。

フィールド

フィールド説明
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

エラーコード

エラー詳細
200Permissions error

作成

このエンドポイントではこの操作を実行できません。

更新中…

このエンドポイントではこの操作を実行できません。

削除中です

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

パラメーター

このエンドポイントにはパラメーターがありません。

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
100Invalid parameter