Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. スクリプトの使用
  • Apidog ラーニングセンター
  • はじめに
    • Apidog の概要
    • Apidog の基本概念
    • Apidog のナビゲーション
    • クイックスタート
      • 概要
      • エンドポイントの作成
      • リクエストの作成
      • アサーションの追加
      • テストシナリオの作成
      • APIドキュメントの共有
      • さらに詳しく
    • Apidogへの移行
      • 概要
      • 手動インポート
      • スケジュールインポート(データソースのバインド)
      • インポートオプション
      • データのエクスポート
      • インポート元
        • Postman からのインポート
        • OpenAPI 仕様のインポート
        • cURL のインポート
        • Markdown のインポート
        • Insomnia からインポート
        • apiDoc からインポート
        • .har ファイルをインポート
        • WSDL のインポート
  • モックAPIデータ
    • 概要
    • Smart Mock
    • カスタムモック
    • モック優先順位
    • モックスクリプト
    • Cloud Mock
    • セルフホスト Runner モック
    • モック言語(ロケール)
  • アカウントと設定
    • アカウント設定
    • OpenAPI アクセストークンの生成
    • 通知
    • 言語設定
    • ホットキー
    • ネットワークプロキシ設定
    • データのバックアップ
    • Apidog の更新
    • アカウントの削除
    • 実験的機能
  • リクエスト送信
    • 概要
    • SSE デバッグ
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP または WebService
    • GraphQL
    • gRPC
    • デバッグにリクエストプロキシエージェントを使用する
    • リクエスト作成
      • リクエスト履歴
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • リクエストのデバッグ
      • リクエストをエンドポイントとして保存する
      • HTTP/2
    • 認証と認可
      • 概要
      • CA 証明書とクライアント証明書
      • 認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 認証
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとCookie
      • APIレスポンスの表示
      • Cookie の管理
      • 概要
  • APIの開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • デバッグケース
    • テストケース
    • 動的値
    • レスポンスの検証
    • Design-First と Request-First
    • コード生成
    • 環境と変数
      • 概要
      • 変数の使用
      • 環境管理
    • Vaultシークレット
      • 概要
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 動的値モジュール
      • Airline
      • Animal
      • Color
      • Commerce
      • 会社
      • Database
      • データ型
      • 日付
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • 画像
      • Internet
      • Location
      • Lorem
      • 音楽
      • Number
      • Person
      • Phone
      • Science
      • 文字列
      • システム
      • Vehicle
      • Word
    • プリプロセッサとポストプロセッサ
      • 概要
      • アサーション
      • 変数の抽出
      • Wait
      • セキュリティ
      • データベース操作
        • 概要
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • スクリプトの使用
        • 概要
        • プリプロセッサスクリプト
        • ポストプロセッサスクリプト
        • Public Scripts
        • Postman Scripts Reference
        • 他のプログラミング言語の呼び出し
        • JS ライブラリの使用
        • レスポンスの可視化
        • スクリプト例
          • アサーションスクリプト
          • 変数の使用
          • リクエストの変更
          • その他の例
    • APIデバッグ
      • AI Agent Debugger
      • A2A Debugger
  • API設計
    • 概要
    • 新しい API プロジェクトを作成する
    • エンドポイントの基本
    • API設計ガイドライン
    • モジュール
    • 複数のリクエストボディ例を設定する
    • コンポーネント
    • 共通フィールド
    • グローバルパラメータ
    • エンドポイント変更履歴
    • コメント
    • エンドポイントの一括管理
    • カスタムプロトコル API
    • Spec-first Mode(ベータ)
    • セキュリティスキーム
      • 概要
      • セキュリティスキームを作成する
      • セキュリティスキームを使用する
      • オンラインドキュメントにおけるセキュリティスキーム
    • 高度な機能
      • カスタムエンドポイントフィールド
      • 関連するテストシナリオ
      • エンドポイントステータス
      • パラメータ一覧の表示形式
      • エンドポイントの一意識別
    • スキーマ
      • 概要
      • 新しいスキーマを作成する
      • スキーマを構築する
      • JSON などからスキーマを生成
      • oneOf、allOf、anyOf
      • Discriminator の使用
  • APIテスト
    • 概要
    • テストシナリオ
      • テストシナリオを作成する
      • リクエスト間でデータを受け渡す
      • フロー制御条件
      • エンドポイントおよびエンドポイントケースからデータを同期する
      • 他のプロジェクトからエンドポイントとエンドポイントケースをインポートする
      • テストシナリオのエクスポート
    • テストレポート
      • テストレポート
    • テストシナリオの実行
      • テストシナリオを実行する
      • テストシナリオを一括実行する
      • データ駆動テスト
      • 共有テストデータ
      • スケジュールされたタスク
      • 他のプロジェクトの API の実行環境を管理する
    • テストスイート
      • 概要
      • テストスイートを作成する
      • テストスイートを編成する
      • テストスイートをローカルで実行する
      • CLI でテストスイートを実行する
      • スケジュールタスク
    • APIのテスト
      • 統合テスト
      • パフォーマンステスト
      • エンドツーエンドテスト
      • 回帰テスト
      • コントラクトテスト
    • Apidog CLI
      • 概要
      • Apidog CLI のインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Github Actions との連携
      • Gitlab との統合
      • Jenkins との連携
      • Git コミットによるテストのトリガー
  • APIドキュメントの公開
    • 概要
    • サポートされているAPI技術
    • クイック共有
    • API ドキュメントの閲覧
    • Markdown ドキュメント
    • ドキュメントサイトの公開
    • カスタムログインページ
    • カスタムレイアウト
    • カスタム CSS、JavaScript、HTML
    • カスタムドメイン
    • AI 機能
    • SEO 設定
    • 詳細設定
      • ドキュメント検索
      • CORS プロキシ
      • Google Analytics の連携
      • フォルダツリー設定
      • 表示設定
      • ドキュメントURLへの値の埋め込み
    • APIバージョン
      • 概要
      • API バージョンの作成
      • API バージョンの公開
      • API バージョンを指定したエンドポイントの共有
  • ブランチ
    • 概要
    • スプリントブランチの作成
    • ブランチでAPIをテストする
    • ブランチで API を設計する
    • スプリントブランチのマージ
    • スプリントブランチの管理
    • AI Branch(ベータ)
  • AI機能
    • 概要
    • AI機能の有効化
    • テストケースの生成
    • AI によるスキーマの変更
    • エンドポイントコンプライアンスチェック
    • APIドキュメント完全性チェック
    • AIを活用したフィールド命名
    • FAQ
  • Apidog MCPサーバー
    • 概要
    • Apidog プロジェクトを AI に接続する
    • 公開済みドキュメントを AI に接続する
    • OpenAPI ファイルを AI に接続する
  • ベストプラクティス
    • API署名の処理
    • OAuth 2.0 で保護された API へのアクセス
    • コラボレーションワークフロー
    • 認証状態の管理
  • オフラインスペース
    • 概要
  • 管理
    • プロジェクト管理
      • プロジェクトの管理
      • 通知設定
      • プロジェクトメンバーの管理
      • プロジェクトリソース
        • データベース接続
        • Git 接続
    • チーム管理
      • チームの管理
      • チームメンバーの管理
      • チームアクティビティ
      • チームのロールと権限
      • チームリソース
        • General Runner
        • チーム変数
        • リクエストプロキシエージェント
      • リアルタイムコラボレーション
        • チームコラボレーション
    • オンボーディングチェックリスト
      • 基本概念
      • オンボーディングガイド
    • 組織管理
      • 組織の管理
      • 組織ロールと権限
      • プラン管理
        • 組織の請求管理者
      • シングルサインオン(SSO)
        • SSO 概要
        • Microsoft Entra ID の設定
        • Okta の設定
        • 組織の SSO を設定する
        • ユーザーアカウントの管理
        • グループをチームにマッピングする
      • SCIMプロビジョニング
        • SCIM プロビジョニングの概要
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホスト Runner
  • 請求
    • 概要
    • クレジット
    • プランのアップグレード
    • 代替支払い方法
    • サブスクリプションの管理
    • 有料チームの組織への移動
  • Apidog Europe
    • Apidog Europe
  • アドオン
    • API Hub
    • Apidog Intellij IDEA プラグイン
    • ブラウザ拡張機能
      • Chrome
      • Microsoft Edge
    • リクエストプロキシ
      • Web でのリクエストプロキシ
      • 共有ドキュメントにおけるリクエストプロキシ
      • クライアントでのリクエストプロキシ
  • データとセキュリティ
    • データストレージとセキュリティ
    • ユーザーデータのプライバシーとセキュリティ
    • リクエストルーティングとデータセキュリティ
  • リファレンス
    • APIデザインファーストアプローチ
    • Apidog OpenAPI 仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSON Schema
    • CSVファイル形式
    • Java 環境のインストール
    • Runner デプロイ環境
    • Apidog Markdown 構文
    • Apidog Swagger拡張
      • 概要
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema拡張
      • 概要
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • サポートセンター
  1. スクリプトの使用

Postman Scripts Reference

Apidog のスクリプトエンジンは、pm オブジェクトを使用して、リクエスト、レスポンス、変数に関するデータへアクセスします。この方法は Postman と互換性があります。

pm オブジェクト#

pm オブジェクトには、次の主なプロパティがあります。
プロパティデータ型説明
pm.info.eventNameString現在実行中のスクリプトの種類(プリプロセッサスクリプトまたはポストプロセッサスクリプト)です。
pm.info.iterationNumber現在の反復回数です(テストコレクションでのみ有効です)。
pm.info.iterationCountNumber合計反復回数です(テストコレクションでのみ有効です)。
pm.info.requestNameString現在実行中の API の名前です。
pm.info.requestIdString現在実行中の API の ID です。

リクエストの送信(pm.sendRequest)#

pm.sendRequest:Function
pm.sendRequest は、スクリプト内で非同期 HTTP/HTTPS リクエストを送信するために使用されます。
このメソッドは、Collection SDK と互換性のあるリクエストパラメータと、コールバック関数パラメータを受け取ります。コールバックには 2 つの引数があります。1 つ目はエラーで、2 つ目は Collection SDK と互換性のあるレスポンスです。詳細については、Collection SDK documentation を参照してください。
プリプロセッサスクリプトとポストプロセッサスクリプトの両方で使用できます。
その他の参照情報については、次をご覧ください。
Request JSON 構造
Response 構造

pm.variables#

pm.variables:Variable SDK のドキュメントをこちらで参照してください。
ローカル変数です。各種変数の優先順位は次のとおりです。
Local Variables > Environment Variables > Global Variables Shared within Project > Global Variables Shared within Team。
pm.variables.has(variableName:String):function → Boolean: 一時変数が存在するかどうかを確認します。
pm.variables.get(variableName:String):function → *: 一時変数を取得します。
pm.variables.set(variableName:String, variableValue:String):function → void: 一時変数を設定します。
pm.variables.replaceIn(variableName:String):function: 文字列内の「動的変数」(例: {{variable_name}})を実際の値に置き換えます。例:
// Define a string containing a dynamic variable
let stringWithVariable = "Hello, {{username}}";

// Use the replaceIn method to replace the {{username}} placeholder
let realValueString = pm.variables.replaceIn(stringWithVariable);

// Output the replaced value
console.log(realValueString); // Output: "Hello, john_doe"
pm.variables.replaceInAsync(variableName:String):function: 文字列内の「動的値式」(例: {{$person.fullName}})を実際の値に置き換えます。このメソッドは Promise を返すため、呼び出す際には await を使用する必要があります。例:
// Define a string containing a dynamic value expression
let stringWithVariable = "Hello, {{$person.fullName}}";

// Use the replaceInAsync method to replace the {{$person.fullName}}
let realValueString = await pm.variables.replaceInAsync(stringWithVariable);
pm.variables.toObject():function → Object: すべてのローカル変数をオブジェクトとして取得します。

pm.iterationData#

pm.iterationData:
テストデータ変数
テストデータは個別に管理されているため、現在、スクリプト内でテストデータ変数を直接設定することはサポートしていません。ただし、以下のようにスクリプト内で変数にアクセスできます。
pm.iterationData.has(variableName:String):function → Boolean: テスト変数が存在するかどうかを確認します。
pm.iterationData.get(variableName:String):function → *: テスト変数を取得します。
pm.iterationData.replaceIn(variableName:String):function: 文字列内の動的変数を実際の値に置き換えます。例: {{variable_name}}。
pm.iterationData.toObject():function → Object: すべてのローカル変数をオブジェクトとして取得します。

pm.environment#

pm.environment.name:String: 環境名です。
pm.environment.has(variableName:String):function → Boolean: 環境変数が存在するかどうかを確認します。
pm.environment.get(variableName:String):function → *: 環境変数を取得します。
pm.environment.set(variableName:String, variableValue:String):function: 環境変数を設定します。
pm.environment.replaceIn(variableName:String):function: 文字列内の動的変数を実際の値に置き換えます。例: {{variable_name}}。
pm.environment.toObject():function → Object: すべてのローカル変数をオブジェクトとして取得します。
pm.environment.unset(variableName:String):function: 環境変数の設定を解除します。
pm.environment.clear():function: 現在の環境配下のすべての環境変数をクリアします。
ヒント: 上記の操作は現在値のみを読み書きし、リモート値は読み書きしません。

pm.moduleVariables#

pm.moduleVariables: Object
モジュールレベル変数の Current Value を管理するために使用します。
pm.moduleVariables.has(variableName: String): function → Boolean
特定のモジュール変数が存在するかどうかを確認します。
pm.moduleVariables.get(variableName: String): function → *
特定のモジュール変数の値を取得します。
pm.moduleVariables.set(variableName: String, variableValue: String): function
特定のモジュール変数の値を設定します。
pm.moduleVariables.replaceIn(variableName: String): function
文字列内の {{variable}} プレースホルダーを実際の値に置き換えます。
pm.moduleVariables.toObject(): function → Object
すべてのモジュール変数をキーと値のオブジェクトとして返します。
pm.moduleVariables.unset(variableName: String): function
特定のモジュール変数を削除します。
pm.moduleVariables.clear(): function
現在のモジュール内のすべてのモジュール変数をクリアします。
例:
互換性に関する注記:
pm.collectionVariables は pm.moduleVariables と同じように動作し、相互に置き換えて使用できます。

pm.globals#

pm.globals.has(variableName:String):function → Boolean: グローバル変数が存在するかどうかを確認します。
pm.globals.get(variableName:String,variableScope:String):function → *: グローバル変数を取得します。変数のスコープを指定するには、'PROJECT'(デフォルト)または 'TEAM' を使用します。
pm.globals.set(variableName:String,variableValue:String, variableScope:String):function: グローバル変数を設定します。変数のスコープを指定するには、'PROJECT'(デフォルト)または 'TEAM' を使用します。
pm.globals.replaceIn(variableName:String):function: 文字列内の動的変数を実際の値に置き換えます。例: {{variable_name}}。
プリプロセッサスクリプトで変数を含むリクエストパラメータの値を取得するには、pm.globals.replaceIn を使用して変数を実際の値に置き換えます。
pm.globals.toObject():function → Object: すべてのグローバル変数をオブジェクトとして取得します。
pm.globals.unset(variableName:String,variableScope:String):function: グローバル変数の設定を解除します。変数のスコープを指定するには、'PROJECT'(デフォルト)または 'TEAM' を使用します。
pm.globals.clear():function: 現在の環境配下のすべてのグローバル変数をクリアします。
TIP
1.
上記のすべての操作は、initial values ではなく current values にのみ影響します。
2.
'TEAM' スコープで set を使用する場合、既存のチーム変数の現在値のみが更新されます。チーム変数が存在しない場合は作成されません。代わりに、その変数はローカル変数として扱われます。

pm.request#

pm.request: Request SDK のドキュメントをこちらで参照してください。
request は API リクエストオブジェクトです。プリプロセッサスクリプトでは、これから送信されるリクエストです。ポストプロセッサスクリプトでは、すでに送信されたリクエストです。
request には次の情報が含まれます。
pm.request.url:Url: 現在のリクエストの URL です。
pm.request.getBaseUrl(): 現在の実行環境で選択されている BASE URL を取得します。この機能はバージョン 2.1.39 以降でサポートされています。
pm.request.headers:HeaderList: 現在のリクエストのヘッダーリストです。
pm.request.method:String: 現在のリクエストのメソッドです。GET、POST などです。
pm.request.body: RequestBody: 現在のリクエストのボディです。
pm.request.headers.add({ key: headerName:String, value: headerValue:String}):function: 現在のリクエストに、キー headerName を持つヘッダーを追加します。
pm.request.headers.remove(headerName:String):function: 現在のリクエストから、キー headerName を持つヘッダーを削除します。
pm.request.headers.upsert({ key: headerName:String, value: headerValue:String}):function: 現在のリクエストに、キー headerName を持つヘッダーを upsert します。キーがすでに存在する場合は変更されます。
次の API は postprocessor scripts でのみ使用できます。

pm.response#

pm.response: Response SDK documentation をこちらで参照してください。
ポストプロセッサスクリプトで返却レスポンス情報にアクセスするには、pm.response を使用します。
pm.response には次の情報が含まれます。
pm.response.code:Number
pm.response.status:String
pm.response.headers:HeaderList
pm.response.responseTime:Number
pm.response.responseSize:Number
pm.response.text():Function → String
pm.response.json():Function → Object

pm.cookies#

pm.cookies: CookieList SDK documentation をこちらで参照してください。
Cookies は、現在のリクエストのドメイン名配下の Cookie リストです。
pm.cookies.has(cookieName:String):Function → Boolean
cookieName の Cookie 値が存在するかどうかを確認します。
pm.cookies.get(cookieName:String):Function → String
cookieName から Cookie 値を取得します。
pm.cookies.toObject:Function → Object
現在のドメイン配下のすべての Cookie をオブジェクトとして取得します。
pm.cookies.jar().clear(pm.request.url)
すべての Cookie をクリアします。
TIP
pm.cookies は、API リクエストによって送信された Cookie ではなく、API リクエスト後に返される Cookie です。

pm.test#

この関数は、結果が期待を満たしているかどうかをアサートするために使用されます。
以下の例は、レスポンスが正しいかどうかを判断するために使用できます。
コールバック関数内で done(任意のパラメータ)を使用して、非同期テストを実行できます。
pm.test.index():Function → Number
特定の場所からテストの合計数を取得します。

pm.expect#

pm.expect はアサーションメソッドです。ChaiJS expects BDD ライブラリのドキュメントをこちらで参照してください。
このメソッドは、レスポンスまたは変数内のデータをアサートするために設計されています。その他の pm.expect の例については、Assertion library examples をご覧ください。

pm.response.to.have.*#

pm.response.to.have.status(code:Number)
pm.response.to.have.status(reason:String)
pm.response.to.have.header(key:String)
pm.response.to.have.header(key:String, optionalValue:String)
pm.response.to.have.body()
pm.response.to.have.body(optionalValue:String)
pm.response.to.have.body(optionalValue:RegExp)
pm.response.to.have.jsonBody()
pm.response.to.have.jsonBody(optionalExpectEqual:Object)
pm.response.to.have.jsonBody(optionalExpectPath:String)
pm.response.to.have.jsonBody(optionalExpectPath:String, optionalValue:*)
pm.response.to.have.jsonSchema(schema:Object)
pm.response.to.have.jsonSchema(schema:Object, ajvOptions:Object)

pm.response.to.be.*#

組み込みの pm.response.to.be を使用して、クイックアサーションを行うことができます。
pm.response.to.be.info
ステータスコードが 1XX かどうかを確認します。
pm.response.to.be.success
ステータスコードが 2XX かどうかを確認します。
pm.response.to.be.redirection
ステータスコードが 3XX かどうかを確認します。
pm.response.to.be.clientError
ステータスコードが 4XX かどうかを確認します。
pm.response.to.be.serverError
ステータスコードが 5XX かどうかを確認します。
pm.response.to.be.error
ステータスコードが 4XX または 5XX かどうかを確認します。
pm.response.to.be.ok
ステータスコードが 200 かどうかを確認します。
pm.response.to.be.accepted
ステータスコードが 202 かどうかを確認します。
pm.response.to.be.badRequest
ステータスコードが 400 かどうかを確認します。
pm.response.to.be.unauthorized
ステータスコードが 401 かどうかを確認します。
pm.response.to.be.forbidden
ステータスコードが 403 かどうかを確認します。
pm.response.to.be.notFound
ステータスコードが 404 かどうかを確認します。
pm.response.to.be.rateLimited
ステータスコードが 429 かどうかを確認します。
Modified at 2026-06-11 07:06:02
Previous
Public Scripts
Next
他のプログラミング言語の呼び出し
Built with