--- title: XMLHttpRequest.setRequestHeader() slug: Web/API/XMLHttpRequest/setRequestHeader tags: - API - HTTP - HTTP Header - Method - NeedsExample - Reference - Request header - XHR - XHR Request - XMLHttpRequest - header - request - setRequestHeader translation_of: Web/API/XMLHttpRequest/setRequestHeader ---
{{domxref("XMLHttpRequest")}} の setRequestHeader()
メソッドは、 HTTP リクエストヘッダーの値を設定します。 setRequestHeader()
は、 {{domxref("XMLHttpRequest.open", "open()")}} の呼び出しの後、 {{domxref("XMLHttpRequest.send", "send()")}} の呼び出しの前に呼び出さなければなりません。同じヘッダーについてこのメソッドを複数回呼び出された場合は、複数の値が単一のリクエストヘッダーにマージされます。
最初に setRequestHeader()
を呼び出した後、呼び出す度に、指定されたテキストは既存のヘッダーの内容の末尾に追加されます。
この関数を使用して {{HTTPHeader("Accept")}} ヘッダーが設定されなかった場合、 {{domxref("XMLHttpRequest.send", "send()")}} が呼び出されると、 Accept
ヘッダーは */*
の値で送信されます。
セキュリティ上の理由で、いくつかのヘッダは、ユーザエージェントからしか制御できません。これらのヘッダーには、 {{Glossary("Forbidden_header_name", "禁止ヘッダー名", 1)}} および {{Glossary("Forbidden_response_header_name", "禁止レスポンスヘッダー名", 1)}} を含みます。
注: カスタムフィールドについては、ドメインをまたがってリクエストを行うと、 "not allowed by Access-Control-Allow-Headers in preflight response" の例外に遭遇することがあります。この場合、サーバー側でレスポンスヘッダーに {{HTTPHeader("Access-Control-Allow-Headers")}} を設定する必要があります。
XMLHttpRequest.setRequestHeader(header, value)
header
value
undefined
です。
仕様書 | 状態 | 備考 |
---|---|---|
{{SpecName('XMLHttpRequest', '#the-setrequestheader()-method', 'setRequestHeader()')}} | {{Spec2('XMLHttpRequest')}} | WHATWG living standard |
{{Compat("api.XMLHttpRequest.setRequestHeader")}}