> ## Documentation Index
> Fetch the complete documentation index at: https://docs.utage-system.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 置き換え文字一覧

> **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオで使用できる置き換え文字（書式は `%name%`）の一覧を取得します。カテゴリで絞り込みできます。

- `is_filterable=true` の `reader_item` のみ、読者一覧の `conditions.rules[].key` として使用できます。
- `system` / `payment` / `event` は固定リストです。`text_template` は `%original-{key}%` 形式です。


`GET`

```
https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/placeholders
```

<Note>この機能はプレビュー版です。仕様が変更される場合があります。</Note>


## OpenAPI

````yaml GET /accounts/{account_id}/scenarios/{scenario_id}/placeholders
openapi: 3.0.3
info:
  title: UTAGE API
  description: |
    UTAGEのパブリックAPIです。ファネル、配信アカウント、シナリオ、メディアなどのリソースをプログラムから操作できます。

    ## 認証
    すべてのリクエストにAPIキーによるBearer認証が必要です（要素タイプエンドポイントを除く）。

    ```
    Authorization: Bearer {api_key}
    ```

    APIキーはUTAGE管理画面から発行できます。

    ## レート制限
    リクエスト数には以下の制限があります。

    | 分間上限 | 日間上限 |
    |----------|----------|
    | 60リクエスト/分 | 10,000リクエスト/日 |

    レスポンスヘッダーで現在の使用状況を確認できます。

    | ヘッダー | 説明 |
    |----------|------|
    | X-RateLimit-Limit | 分間の上限値 |
    | X-RateLimit-Remaining | 分間の残りリクエスト数 |
    | X-RateLimit-Reset | 制限がリセットされるUNIXタイムスタンプ |

    上限を超えた場合は `429 Too Many Requests` が返されます。

    ## エラーレスポンス
    エラー時は以下の形式で返されます。

    ```json
    {
      "error": {
        "code": "error_code",
        "message": "エラーメッセージ"
      }
    }
    ```
  version: '1.0'
  contact:
    name: UTAGE サポート
servers:
  - url: https://api.utage-system.com/v1
    description: UTAGE API
security:
  - BearerAuth: []
tags:
  - name: ファネル
    description: ファネルの作成・更新・一覧取得
  - name: ステップ
    description: ファネル内のステップの作成・更新・並び替え
  - name: ページ
    description: ステップ内のページの作成・更新・取得・削除
  - name: 配信アカウント
    description: 配信アカウントの作成・一覧取得
  - name: シナリオ
    description: シナリオの作成・一覧取得
  - name: メディア
    description: 動画・音声・通常メディアの一覧取得とアップロード
  - name: 要素タイプ
    description: ファネルページ・HTMLメールの要素タイプ定義、LINEメッセージタイプ・配信条件タイプの取得（認証不要）
  - name: ファネル統計
    description: ファネルの集計データ・登録者・登録経路の取得（プレビュー）
  - name: 配信メッセージ
    description: 配信メッセージの作成・更新・テスト送信・配信統計、置き換え文字の取得（プレビュー）
  - name: 読者
    description: 読者の作成・更新・取得、ラベル・配信履歴・開封/クリック履歴の取得（プレビュー）
  - name: LINE
    description: LINE友だち・カスタム送信者・1対1チャット・テンプレートの操作（プレビュー）
  - name: ラベル・共通読者・登録経路
    description: ラベル・共通読者・アクション・登録経路の操作（プレビュー）
paths:
  /accounts/{account_id}/scenarios/{scenario_id}/placeholders:
    get:
      tags:
        - 配信メッセージ
      summary: 置き換え文字一覧
      description: >
        **プレビュー機能。仕様は今後変更される可能性があります。** 指定シナリオで使用できる置き換え文字（書式は
        `%name%`）の一覧を取得します。カテゴリで絞り込みできます。


        - `is_filterable=true` の `reader_item` のみ、読者一覧の `conditions.rules[].key`
        として使用できます。

        - `system` / `payment` / `event` は固定リストです。`text_template` は
        `%original-{key}%` 形式です。
      operationId: listPlaceholders
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - name: scenario_id
          in: path
          required: true
          description: シナリオID
          schema:
            type: string
        - name: category
          in: query
          description: |
            カテゴリで絞り込み
            - `reader_item`: 読者項目
            - `system`: システム変数
            - `text_template`: 独自置き換え文字
            - `payment`: 決済連携
            - `event`: イベント連携
          schema:
            type: string
            enum:
              - reader_item
              - system
              - text_template
              - payment
              - event
      responses:
        '200':
          description: 置き換え文字一覧
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Placeholder'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      description: アカウントID
      schema:
        type: string
  schemas:
    Placeholder:
      type: object
      description: 置き換え文字
      properties:
        placeholder:
          type: string
          description: 置き換え文字（書式は %xxx%）
          example: '%name%'
        name:
          type: string
          description: 表示名
        category:
          type: string
          enum:
            - reader_item
            - system
            - text_template
            - payment
            - event
          description: >-
            カテゴリ（reader_item: 読者項目、system: システム変数、text_template:
            独自置き換え文字、payment: 決済連携、event: イベント連携）
        field_group:
          type: string
          enum:
            - scenario_fields
            - common_fields
          description: |
            項目グループ（category=reader_item のときのみ）。scenario_fields=シナリオ固有、
            common_fields=全シナリオ共通（更新すると同一人物の全シナリオに波及）。
        is_filterable:
          type: boolean
          description: |
            読者絞り込み条件に使用できるか（category=reader_item のときのみ）。true の項目のみ
            読者一覧の conditions.rules[].key として使用できます。
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: エラーコード
            message:
              type: string
              description: エラーメッセージ
            details:
              type: object
              nullable: true
              description: エラーの補足情報（retry_afterやフィールド別エラー等）。エラー種別により含まれる場合があります。
  responses:
    Unauthorized:
      description: 認証エラー。APIキーが無効または未指定。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthorized
              message: 認証に失敗しました
    NotFound:
      description: 指定されたリソースが見つかりません。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: not_found
              message: リソースが見つかりません
    RateLimitExceeded:
      description: レート制限超過。時間を空けて再試行してください。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limit_exceeded
              message: リクエスト上限を超えました。しばらく時間を空けて再試行してください
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: APIキーをBearerトークンとして指定

````