ページ作成 - UTAGE API ドキュメント

ページ作成

curl --request POST \
  --url https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content_type": "elements",
  "html_source": "<string>",
  "page_title": "<string>",
  "elements": [
    {}
  ],
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_og_image": "<string>",
  "is_no_index": true,
  "pc_width": 1010,
  "background_color": "<string>",
  "background_image_src": "<string>",
  "background_image_style": "<string>",
  "js_head": "<string>",
  "js_body_top": "<string>",
  "js_body": "<string>",
  "css": "<string>",
  "use_popup": true,
  "popup_width": 800,
  "popup_background_color": "<string>",
  "popup_elements": [
    {}
  ],
  "is_high_speed_mode": true
}
'

{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "page_title": "<string>",
    "html_source": "<string>",
    "elements": [
      {}
    ],
    "meta_title": "<string>",
    "meta_description": "<string>",
    "meta_og_image": "<string>",
    "is_no_index": true,
    "pc_width": 123,
    "background_color": "<string>",
    "background_image_src": "<string>",
    "background_image_style": "<string>",
    "js_head": "<string>",
    "js_body_top": "<string>",
    "js_body": "<string>",
    "css": "<string>",
    "use_popup": true,
    "popup_width": 123,
    "popup_background_color": "<string>",
    "popup_elements": [
      {}
    ],
    "is_high_speed_mode": true,
    "order": 123,
    "is_archived": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "step_url": "<string>"
  }
}

ページ作成

curl --request POST \
  --url https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content_type": "elements",
  "html_source": "<string>",
  "page_title": "<string>",
  "elements": [
    {}
  ],
  "meta_title": "<string>",
  "meta_description": "<string>",
  "meta_og_image": "<string>",
  "is_no_index": true,
  "pc_width": 1010,
  "background_color": "<string>",
  "background_image_src": "<string>",
  "background_image_style": "<string>",
  "js_head": "<string>",
  "js_body_top": "<string>",
  "js_body": "<string>",
  "css": "<string>",
  "use_popup": true,
  "popup_width": 800,
  "popup_background_color": "<string>",
  "popup_elements": [
    {}
  ],
  "is_high_speed_mode": true
}
'

{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "page_title": "<string>",
    "html_source": "<string>",
    "elements": [
      {}
    ],
    "meta_title": "<string>",
    "meta_description": "<string>",
    "meta_og_image": "<string>",
    "is_no_index": true,
    "pc_width": 123,
    "background_color": "<string>",
    "background_image_src": "<string>",
    "background_image_style": "<string>",
    "js_head": "<string>",
    "js_body_top": "<string>",
    "js_body": "<string>",
    "css": "<string>",
    "use_popup": true,
    "popup_width": 123,
    "popup_background_color": "<string>",
    "popup_elements": [
      {}
    ],
    "is_high_speed_mode": true,
    "order": 123,
    "is_archived": true,
    "created_at": "<string>",
    "updated_at": "<string>",
    "step_url": "<string>"
  }
}

POST

https://api.utage-system.com/v1/funnels/{funnel_id}/steps/{step_id}/pages

Authorizations

Authorization

string

header

required

APIキーをBearerトークンとして指定

Path Parameters

funnel_id

string

required

ファネルID

step_id

string

required

ステップID

Body

application/json

title

string

required

管理名称（管理画面の一覧に表示される名前）

Maximum string length: 255

content_type

enum<string>

default:elements

コンテンツタイプ（elements: 要素の階層構造、raw_html: HTML直接入力）

Available options:

elements,

raw_html

html_source

string

HTML文字列（content_type=raw_html時に必須、最大4MB）。html/head/bodyタグ必須、DOCTYPEは任意

page_title

string

ページタイトル（ブラウザのtitleタグに表示。content_type=elementsのみ）

elements

object[]

要素の配列（content_type=elements時に必須）。section > row > col > コンテンツ要素のchildren階層構造。

[{
  "type": "section",
  "children": [{
    "type": "row",
    "children": [{
      "type": "col",
      "children": [{
        "type": "text",
        "content": "<p>テキスト</p>"
      }]
    }]
  }]
}]

meta_title

string

タイトル（SNSシェア時に表示されるタイトル）

Maximum string length: 255

meta_description

string

説明（SNSシェア時の説明）

Maximum string length: 500

meta_og_image

string<uri>

OG画像(og:image)URL（SNSシェア時のサムネイル）

is_no_index

boolean

検索エンジン設定（false: 検索エンジンに許可、true: インデックスさせない）

pc_width

integer

ページ幅(PC)。100=全幅(100%)、640-1200=ピクセル指定(10刻み)。LP向けは600-800px、通常ページは1000-1200pxが一般的

Required range: 100 <= x <= 1920

border_type

enum<string>

ページ枠(PC)（shadow: 影、border: 枠線、none: なし）

Available options:

shadow,

border,

none

swipe_type

enum<string>

ページスワイプ（pc_width=100の場合は使用不可）

Available options:

none,

vertical,

horizontal

background_color

string

ページ全体の背景色（#RRGGBB形式推奨）。pc_width=100（全幅）の場合のみ指定すること

Maximum string length: 20

background_image_src

string

ページ全体の背景画像URL（HTTPS）

Maximum string length: 2048

background_image_style

string

背景画像スタイル（cover_fixed: 全体に表示(スクロール時固定)、w100: 幅100%、h100: 高さ100%、no_repeat: 拡大なし繰り返しなし、repeat: 拡大なし繰り返しを推奨）

Maximum string length: 30

js_head

string

head内に挿入するJavaScript（GTMタグ等）

js_body_top

string

body直後に挿入するJavaScript

js_body

string

body末尾に挿入するJavaScript

css

string

カスタムCSS（ページ固有のスタイル調整）

ポップアップ使用

イグジットポップアップ（exit: ページ離脱時、exit_all: 全ページ離脱時）

Available options:

exit,

exit_all

ポップアップ幅（600-1000px）

Required range: 600 <= x <= 1000

ポップアップ背景色（#RRGGBB形式推奨）

Maximum string length: 20

表示位置（top: 上部、centered: 中央）

Available options:

top,

centered

ポップアップ要素の配列（elementsと同じ構造）

is_high_speed_mode

boolean

高速表示モード

Response

作成されたページ

data

object

Show child attributes

ページ一覧取得ページ詳細取得