メインコンテンツにスキップ

APIRequestContext

このAPIはWeb APIテストに使用されます。APIエンドポイントのトリガー、マイクロサービスの構成、e2eテストのための環境またはサービスの準備に使用できます。

各Playwrightブラウザコンテキストには、ブラウザコンテキストとクッキーストレージを共有し、APIRequestContextインスタンスが関連付けられており、BrowserContext.APIRequestまたはPage.APIRequestを介してアクセスできます。ApiRequest.NewContextAsync()を呼び出すことで、新しいAPIRequestContextインスタンスを手動で作成することも可能です。

クッキー管理

APIRequestContextはBrowserContext.APIRequestとPage.APIRequestによって返され、対応するBrowserContextとクッキーストレージを共有します。各APIリクエストには、ブラウザコンテキストからの値でCookieヘッダーが設定されます。API応答にSet-Cookieヘッダーが含まれている場合、自動的にBrowserContextのクッキーが更新され、ページからのリクエストはそれらを取得します。これは、このAPIを使用してログインした場合、e2eテストもログイン状態になり、その逆もまた然りであることを意味します。

APIリクエストがブラウザのクッキーと干渉しないようにしたい場合は、ApiRequest.NewContextAsync()を呼び出して新しいAPIRequestContextを作成する必要があります。このようなAPIRequestContextオブジェクトは、独自の隔離されたクッキーストレージを持ちます。

メソッド​

CreateFormData​

追加バージョン: v1.23 apiRequestContext.CreateFormData

HTTPリクエストを作成する際に、フォームおよびマルチパートデータを提供するために使用される新しいFormDataインスタンスを作成します。

使用法

ApiRequestContext.CreateFormData

戻り値

DeleteAsync​

追加バージョン: v1.16 apiRequestContext.DeleteAsync

HTTP(S) DELETEリクエストを送信し、その応答を返します。このメソッドは、コンテキストからリクエストクッキーを設定し、応答からコンテキストクッキーを更新します。このメソッドは自動的にリダイレクトに従います。

使用法

await ApiRequestContext.DeleteAsync(url, options);

引数

  • url string#

    ターゲットURL。

  • options ApiRequestContextDeleteOptions? (オプション)

    • Data|DataByte|DataObject string? | byte[]? | [object]? (オプション)追加バージョン: v1.17#

      リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限りcontent-typeヘッダーがapplication/jsonに設定されます。それ以外の場合、明示的に設定されていない限りcontent-typeヘッダーはapplication/octet-streamに設定されます。

    • FailOnStatusCode bool? (オプション)#

      2xxおよび3xx以外の応答コードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードに対して応答オブジェクトが返されます。

    • Form FormData? (オプション)追加バージョン: v1.17#

      このリクエストボディとして送信されるapplication/x-www-form-urlencodedエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Headers IDictionary?<string, string> (オプション)#

      HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

    • IgnoreHTTPSErrors bool? (オプション)#

      ネットワークリクエスト送信時にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

    • MaxRedirects int? (オプション)追加バージョン: v1.26#

      自動的に追従されるリクエストリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは20です。0を渡すとリダイレクトは追従されません。

    • MaxRetries int? (オプション)追加バージョン: v1.46#

      ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTP応答コードに基づいて再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは0（再試行なし）です。

    • Multipart FormData? (オプション)追加バージョン: v1.17#

      このリクエストボディとして送信されるmultipart/form-dataエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはmultipart/form-dataに設定されます。ファイル値は、ファイル名、MIMEタイプ、およびその内容を含むファイルのようなオブジェクトとして渡すことができます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Params IDictionary?<string, [object]> (オプション)#

      URLとともに送信されるクエリパラメータ。

    • ParamsString string? (オプション)追加バージョン: v1.47#

      URLとともに送信されるクエリパラメータ。

    • Timeout [float]? (オプション)#

      リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。

戻り値

DisposeAsync​

追加バージョン: v1.16 apiRequestContext.DisposeAsync

ApiRequestContext.GetAsync()および類似のメソッドによって返されるすべての応答はメモリに保存されるため、後でApiResponse.BodyAsync()を呼び出すことができます。このメソッドは、そのすべてのリソースを破棄し、破棄されたAPIRequestContextに対してメソッドを呼び出すと例外がスローされます。

使用法

await ApiRequestContext.DisposeAsync(options);

引数

  • options ApiRequestContextDisposeOptions? (オプション)

    • Reason string? (オプション)追加バージョン: v1.45#

      コンテキストの破棄によって中断された操作に報告される理由。

戻り値

FetchAsync​

追加バージョン: v1.16 apiRequestContext.FetchAsync

HTTP(S)リクエストを送信し、その応答を返します。このメソッドは、コンテキストからリクエストクッキーを設定し、応答からコンテキストクッキーを更新します。このメソッドは自動的にリダイレクトに従います。

使用法

JSONオブジェクトはリクエストに直接渡すことができます。

var data = new Dictionary<string, object>() {
  { "title", "Book Title" },
  { "body", "John Doe" }
};
await Request.FetchAsync("https://example.com/api/createBook", new() { Method = "post", DataObject = data });

リクエストの本文でファイルを送信する一般的な方法は、multipart/form-dataエンコーディングを使用してフォームフィールドとしてアップロードすることです。これはmultipartパラメータを指定することによって行います。

var file = new FilePayload()
{
    Name = "f.js",
    MimeType = "text/javascript",
    Buffer = System.Text.Encoding.UTF8.GetBytes("console.log(2022);")
};
var multipart = Context.APIRequest.CreateFormData();
multipart.Set("fileField", file);
await Request.FetchAsync("https://example.com/api/uploadScript", new() { Method = "post", Multipart = multipart });

引数

  • urlOrRequest string | Request#

    すべてのパラメータを取得するターゲットURLまたはリクエスト。

  • options ApiRequestContextFetchOptions? (オプション)

    • Data|DataByte|DataObject string? | byte[]? | [object]? (オプション)#

      リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限りcontent-typeヘッダーがapplication/jsonに設定されます。それ以外の場合、明示的に設定されていない限りcontent-typeヘッダーはapplication/octet-streamに設定されます。

    • FailOnStatusCode bool? (オプション)#

      2xxおよび3xx以外の応答コードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードに対して応答オブジェクトが返されます。

    • Form FormData? (オプション)#

      このリクエストボディとして送信されるapplication/x-www-form-urlencodedエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Headers IDictionary?<string, string> (オプション)#

      HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

    • IgnoreHTTPSErrors bool? (オプション)#

      ネットワークリクエスト送信時にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

    • MaxRedirects int? (オプション)追加バージョン: v1.26#

      自動的に追従されるリクエストリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは20です。0を渡すとリダイレクトは追従されません。

    • MaxRetries int? (オプション)追加バージョン: v1.46#

      ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTP応答コードに基づいて再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは0（再試行なし）です。

    • Method string? (オプション)#

      設定されている場合、フェッチメソッドを変更します（例：PUTまたはPOST）。指定しない場合、GETメソッドが使用されます。

    • Multipart FormData? (オプション)#

      このリクエストボディとして送信されるmultipart/form-dataエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはmultipart/form-dataに設定されます。ファイル値は、ファイル名、MIMEタイプ、およびその内容を含むファイルのようなオブジェクトとして渡すことができます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Params IDictionary?<string, [object]> (オプション)#

      URLとともに送信されるクエリパラメータ。

    • ParamsString string? (オプション)追加バージョン: v1.47#

      URLとともに送信されるクエリパラメータ。

    • Timeout [float]? (オプション)#

      リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。

戻り値

GetAsync​

追加バージョン: v1.16 apiRequestContext.GetAsync

HTTP(S) GETリクエストを送信し、その応答を返します。このメソッドは、コンテキストからリクエストクッキーを設定し、応答からコンテキストクッキーを更新します。このメソッドは自動的にリダイレクトに従います。

使用法

リクエストパラメータはparamsオプションで設定でき、URL検索パラメータにシリアル化されます。

var queryParams = new Dictionary<string, object>()
{
  { "isbn", "1234" },
  { "page", 23 },
};
await request.GetAsync("https://example.com/api/getText", new() { Params = queryParams });

引数

  • url string#

    ターゲットURL。

  • options ApiRequestContextGetOptions? (オプション)

    • Data|DataByte|DataObject string? | byte[]? | [object]? (オプション)追加バージョン: v1.26#

      リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限りcontent-typeヘッダーがapplication/jsonに設定されます。それ以外の場合、明示的に設定されていない限りcontent-typeヘッダーはapplication/octet-streamに設定されます。

    • FailOnStatusCode bool? (オプション)#

      2xxおよび3xx以外の応答コードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードに対して応答オブジェクトが返されます。

    • Form FormData? (オプション)追加バージョン: v1.26#

      このリクエストボディとして送信されるapplication/x-www-form-urlencodedエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Headers IDictionary?<string, string> (オプション)#

      HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

    • IgnoreHTTPSErrors bool? (オプション)#

      ネットワークリクエスト送信時にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

    • MaxRedirects int? (オプション)追加バージョン: v1.26#

      自動的に追従されるリクエストリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは20です。0を渡すとリダイレクトは追従されません。

    • MaxRetries int? (オプション)追加バージョン: v1.46#

      ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTP応答コードに基づいて再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは0（再試行なし）です。

    • Multipart FormData? (オプション)追加バージョン: v1.26#

      このリクエストボディとして送信されるmultipart/form-dataエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはmultipart/form-dataに設定されます。ファイル値は、ファイル名、MIMEタイプ、およびその内容を含むファイルのようなオブジェクトとして渡すことができます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Params IDictionary?<string, [object]> (オプション)#

      URLとともに送信されるクエリパラメータ。

    • ParamsString string? (オプション)追加バージョン: v1.47#

      URLとともに送信されるクエリパラメータ。

    • Timeout [float]? (オプション)#

      リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。

戻り値

HeadAsync​

追加バージョン: v1.16 apiRequestContext.HeadAsync

HTTP(S) HEADリクエストを送信し、その応答を返します。このメソッドは、コンテキストからリクエストクッキーを設定し、応答からコンテキストクッキーを更新します。このメソッドは自動的にリダイレクトに従います。

使用法

await ApiRequestContext.HeadAsync(url, options);

引数

  • url string#

    ターゲットURL。

  • options ApiRequestContextHeadOptions? (オプション)

    • Data|DataByte|DataObject string? | byte[]? | [object]? (オプション)追加バージョン: v1.26#

      リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限りcontent-typeヘッダーがapplication/jsonに設定されます。それ以外の場合、明示的に設定されていない限りcontent-typeヘッダーはapplication/octet-streamに設定されます。

    • FailOnStatusCode bool? (オプション)#

      2xxおよび3xx以外の応答コードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードに対して応答オブジェクトが返されます。

    • Form FormData? (オプション)追加バージョン: v1.26#

      このリクエストボディとして送信されるapplication/x-www-form-urlencodedエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Headers IDictionary?<string, string> (オプション)#

      HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

    • IgnoreHTTPSErrors bool? (オプション)#

      ネットワークリクエスト送信時にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

    • MaxRedirects int? (オプション)追加バージョン: v1.26#

      自動的に追従されるリクエストリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは20です。0を渡すとリダイレクトは追従されません。

    • MaxRetries int? (オプション)追加バージョン: v1.46#

      ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTP応答コードに基づいて再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは0（再試行なし）です。

    • Multipart FormData? (オプション)追加バージョン: v1.26#

      このリクエストボディとして送信されるmultipart/form-dataエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはmultipart/form-dataに設定されます。ファイル値は、ファイル名、MIMEタイプ、およびその内容を含むファイルのようなオブジェクトとして渡すことができます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Params IDictionary?<string, [object]> (オプション)#

      URLとともに送信されるクエリパラメータ。

    • ParamsString string? (オプション)追加バージョン: v1.47#

      URLとともに送信されるクエリパラメータ。

    • Timeout [float]? (オプション)#

      リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。

戻り値

PatchAsync​

追加バージョン: v1.16 apiRequestContext.PatchAsync

HTTP(S) PATCHリクエストを送信し、その応答を返します。このメソッドは、コンテキストからリクエストクッキーを設定し、応答からコンテキストクッキーを更新します。このメソッドは自動的にリダイレクトに従います。

使用法

await ApiRequestContext.PatchAsync(url, options);

引数

  • url string#

    ターゲットURL。

  • options ApiRequestContextPatchOptions? (オプション)

    • Data|DataByte|DataObject string? | byte[]? | [object]? (オプション)#

      リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限りcontent-typeヘッダーがapplication/jsonに設定されます。それ以外の場合、明示的に設定されていない限りcontent-typeヘッダーはapplication/octet-streamに設定されます。

    • FailOnStatusCode bool? (オプション)#

      2xxおよび3xx以外の応答コードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードに対して応答オブジェクトが返されます。

    • Form FormData? (オプション)#

      このリクエストボディとして送信されるapplication/x-www-form-urlencodedエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Headers IDictionary?<string, string> (オプション)#

      HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

    • IgnoreHTTPSErrors bool? (オプション)#

      ネットワークリクエスト送信時にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

    • MaxRedirects int? (オプション)追加バージョン: v1.26#

      自動的に追従されるリクエストリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは20です。0を渡すとリダイレクトは追従されません。

    • MaxRetries int? (オプション)追加バージョン: v1.46#

      ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTP応答コードに基づいて再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは0（再試行なし）です。

    • Multipart FormData? (オプション)#

      このリクエストボディとして送信されるmultipart/form-dataエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはmultipart/form-dataに設定されます。ファイル値は、ファイル名、MIMEタイプ、およびその内容を含むファイルのようなオブジェクトとして渡すことができます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Params IDictionary?<string, [object]> (オプション)#

      URLとともに送信されるクエリパラメータ。

    • ParamsString string? (オプション)追加バージョン: v1.47#

      URLとともに送信されるクエリパラメータ。

    • Timeout [float]? (オプション)#

      リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。

戻り値

PostAsync​

追加バージョン: v1.16 apiRequestContext.PostAsync

HTTP(S) POSTリクエストを送信し、その応答を返します。このメソッドは、コンテキストからリクエストクッキーを設定し、応答からコンテキストクッキーを更新します。このメソッドは自動的にリダイレクトに従います。

使用法

JSONオブジェクトはリクエストに直接渡すことができます。

var data = new Dictionary<string, object>() {
  { "firstName", "John" },
  { "lastName", "Doe" }
};
await request.PostAsync("https://example.com/api/createBook", new() { DataObject = data });

サーバーにフォームデータを送信するには、formオプションを使用します。その値はapplication/x-www-form-urlencodedエンコーディングでリクエストボディにエンコードされます（ファイルを送信するためのmultipart/form-dataフォームエンコーディングの使用方法は以下を参照）。

var formData = Context.APIRequest.CreateFormData();
formData.Set("title", "Book Title");
formData.Set("body", "John Doe");
await request.PostAsync("https://example.com/api/findBook", new() { Form = formData });

リクエストの本文でファイルを送信する一般的な方法は、multipart/form-dataエンコーディングを使用してフォームフィールドとしてアップロードすることです。FormDataを使用してリクエストボディを構築し、それをmultipartパラメータとしてリクエストに渡します。

var file = new FilePayload()
{
    Name = "f.js",
    MimeType = "text/javascript",
    Buffer = System.Text.Encoding.UTF8.GetBytes("console.log(2022);")
};
var multipart = Context.APIRequest.CreateFormData();
multipart.Set("fileField", file);
await request.PostAsync("https://example.com/api/uploadScript", new() { Multipart = multipart });

引数

  • url string#

    ターゲットURL。

  • options ApiRequestContextPostOptions? (オプション)

    • Data|DataByte|DataObject string? | byte[]? | [object]? (オプション)#

      リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限りcontent-typeヘッダーがapplication/jsonに設定されます。それ以外の場合、明示的に設定されていない限りcontent-typeヘッダーはapplication/octet-streamに設定されます。

    • FailOnStatusCode bool? (オプション)#

      2xxおよび3xx以外の応答コードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードに対して応答オブジェクトが返されます。

    • Form FormData? (オプション)#

      このリクエストボディとして送信されるapplication/x-www-form-urlencodedエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Headers IDictionary?<string, string> (オプション)#

      HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

    • IgnoreHTTPSErrors bool? (オプション)#

      ネットワークリクエスト送信時にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

    • MaxRedirects int? (オプション)追加バージョン: v1.26#

      自動的に追従されるリクエストリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは20です。0を渡すとリダイレクトは追従されません。

    • MaxRetries int? (オプション)追加バージョン: v1.46#

      ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTP応答コードに基づいて再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは0（再試行なし）です。

    • Multipart FormData? (オプション)#

      このリクエストボディとして送信されるmultipart/form-dataエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはmultipart/form-dataに設定されます。ファイル値は、ファイル名、MIMEタイプ、およびその内容を含むファイルのようなオブジェクトとして渡すことができます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Params IDictionary?<string, [object]> (オプション)#

      URLとともに送信されるクエリパラメータ。

    • ParamsString string? (オプション)追加バージョン: v1.47#

      URLとともに送信されるクエリパラメータ。

    • Timeout [float]? (オプション)#

      リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。

戻り値

PutAsync​

追加バージョン: v1.16 apiRequestContext.PutAsync

HTTP(S) PUTリクエストを送信し、その応答を返します。このメソッドは、コンテキストからリクエストクッキーを設定し、応答からコンテキストクッキーを更新します。このメソッドは自動的にリダイレクトに従います。

使用法

await ApiRequestContext.PutAsync(url, options);

引数

  • url string#

    ターゲットURL。

  • options ApiRequestContextPutOptions? (オプション)

    • Data|DataByte|DataObject string? | byte[]? | [object]? (オプション)#

      リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限りcontent-typeヘッダーがapplication/jsonに設定されます。それ以外の場合、明示的に設定されていない限りcontent-typeヘッダーはapplication/octet-streamに設定されます。

    • FailOnStatusCode bool? (オプション)#

      2xxおよび3xx以外の応答コードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードに対して応答オブジェクトが返されます。

    • Form FormData? (オプション)#

      このリクエストボディとして送信されるapplication/x-www-form-urlencodedエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Headers IDictionary?<string, string> (オプション)#

      HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

    • IgnoreHTTPSErrors bool? (オプション)#

      ネットワークリクエスト送信時にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

    • MaxRedirects int? (オプション)追加バージョン: v1.26#

      自動的に追従されるリクエストリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは20です。0を渡すとリダイレクトは追従されません。

    • MaxRetries int? (オプション)追加バージョン: v1.46#

      ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTP応答コードに基づいて再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは0（再試行なし）です。

    • Multipart FormData? (オプション)#

      このリクエストボディとして送信されるmultipart/form-dataエンコーディングを使用してHTMLフォームとしてシリアル化されるオブジェクトを提供します。このパラメータが指定された場合、明示的に提供されない限りcontent-typeヘッダーはmultipart/form-dataに設定されます。ファイル値は、ファイル名、MIMEタイプ、およびその内容を含むファイルのようなオブジェクトとして渡すことができます。

      FormDataのインスタンスは、ApiRequestContext.CreateFormDataを介して作成できます。

    • Params IDictionary?<string, [object]> (オプション)#

      URLとともに送信されるクエリパラメータ。

    • ParamsString string? (オプション)追加バージョン: v1.47#

      URLとともに送信されるクエリパラメータ。

    • Timeout [float]? (オプション)#

      リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトは無効になります。

戻り値

StorageStateAsync​

追加バージョン: v1.16 apiRequestContext.StorageStateAsync

このリクエストコンテキストのストレージ状態を返します。コンストラクタに渡された場合、現在のクッキーとローカルストレージのスナップショットが含まれます。

使用法

await ApiRequestContext.StorageStateAsync(options);

引数

  • options ApiRequestContextStorageStateOptions? (オプション)

    • IndexedDB bool? (オプション)追加バージョン: v1.51#

      ストレージ状態スナップショットにIndexedDBを含めるには、trueに設定します。

    • Path string? (オプション)#

      ストレージ状態を保存するファイルパス。Pathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。パスが指定されていない場合でもストレージ状態は返されますが、ディスクには保存されません。

戻り値