フリップブックに行動喚起（CTA）を追加する

できること

フリップブックのビューアーには、読者を任意の場所へリンクさせる行動喚起（CTA）ボタンを表示できます。3つのエンドポイントで、APIから設定できます。

• プライマリCTAボタンを設定する — ラベル、URL、色、表示するかどうか。
• セカンダリCTAボタンを設定する — 2のサフィックスが付いたフィールドを使う2つ目のボタン。
• プレビュールールを設定する — 読者がプレビュー中にCTAを隠すかどうかを制御する。

始める前に

• APIキー — すべてのリクエストでX-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
• flipbookId — 設定したいフリップブックの数値ID（3つのエンドポイントすべてのパスパラメーター）です。create-by-file／create-by-url（IDとして）や一覧から返されます。
• すべてのリクエストの送信先はベースURL https://go.fliplink.meです。
• リクエストボディは3つのエンドポイントすべてでform-urlencoded（JSONではありません）です。各フィールドは--data-urlencodeで送ってください。

プライマリCTAボタンを設定する

ビューアーのプライマリ行動喚起ボタン（ラベル、URL、色）を設定します。フィールドはIsCTAButton、CTAButtonText、CTAButtonURL（および色のフィールド）であり、Text/URL/Positionではありません。CTAButtonURLの値にmailto: / tel:のプレフィックスが付いている場合、サーバー側で自動的に正規化されます。

curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=' \
  --data-urlencode 'CTAButtonColor=' \
  --data-urlencode 'CTAButtonURL=' \
  --data-urlencode 'CTAButtonTextColor='

レスポンス:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

セカンダリCTAボタンを設定する

ビューアーのセカンダリ行動喚起ボタンを設定します。セカンダリボタンは2のサフィックスが付いたフィールド（IsCTAButton2、CTAButtonText2、CTAButtonURL2、および2のサフィックスが付いた色のフィールド）を使います。

curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=' \
  --data-urlencode 'CTAButtonColor2=' \
  --data-urlencode 'CTAButtonTextColor2=' \
  --data-urlencode 'CTAButtonURL2='

レスポンス:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

プレビュールールを設定する

行動喚起を読者にいつ表示するか（プレビューゲートのルール）を設定します。読者がプレビュー中にCTAを隠すかどうかを制御するには、IsCTAHiddenInPreviewを送ります。

curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'

レスポンス:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

起こりうるエラー

• APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。X-Api-Key（またはAuthorization: Bearer）ヘッダーが存在し、正しいことを確認してください。
• アイテムIDが見つからないか、キーが所有していない場合 → HTTP 200でMessage: "Item not found"。
• 不明またはスペルミスのボディフィールド → HTTP 200でMessage: "Unknown field(s) '…'. Expected: …"。フィールドの正確なスペル（たとえばセカンダリボタンの2のサフィックスが付いたフィールド）を確認してください。

メモ

• 3つのエンドポイントはいずれも、同じ{flipbookId}パスパラメーターと、同じ{ "Result": "OK", "Message": "Updated successfully" }という成功の形を共有します。
• プライマリボタンとセカンダリボタンは独立して設定されます。セカンダリのエンドポイントは、2のサフィックスが付いたフィールド名のみを受け付けます。