blob: 41c8609690c2282a400c7c64ad747f1a7e4769db (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
---
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
---
<div>{{APIRef('XMLHttpRequest')}}</div>
<p>{{domxref("XMLHttpRequest")}} の <code><strong>setRequestHeader()</strong></code> メソッドは、 HTTP リクエストヘッダーの値を設定します。 <code>setRequestHeader()</code> は、 {{domxref("XMLHttpRequest.open", "open()")}} の呼び出しの後、 {{domxref("XMLHttpRequest.send", "send()")}} の呼び出しの前に呼び出さなければなりません。同じヘッダーについてこのメソッドを複数回呼び出された場合は、複数の値が単一のリクエストヘッダーにマージされます。</p>
<p>最初に <code>setRequestHeader()</code> を呼び出した後、呼び出す度に、指定されたテキストは既存のヘッダーの内容の末尾に追加されます。</p>
<p>この関数を使用して {{HTTPHeader("Accept")}} ヘッダーが設定されなかった場合、 {{domxref("XMLHttpRequest.send", "send()")}} が呼び出されると、 <code>Accept</code> ヘッダーは <code>*/*</code> の値で送信されます。</p>
<p>セキュリティ上の理由で、いくつかのヘッダは、ユーザエージェントからしか制御できません。これらのヘッダーには、 {{Glossary("Forbidden_header_name", "禁止ヘッダー名", 1)}} および {{Glossary("Forbidden_response_header_name", "禁止レスポンスヘッダー名", 1)}} を含みます。</p>
<div class="note">
<p><strong>注:</strong> カスタムフィールドについては、ドメインをまたがってリクエストを行うと、 "<strong>not allowed by Access-Control-Allow-Headers in preflight response</strong>" の例外に遭遇することがあります。この場合、サーバー側でレスポンスヘッダーに {{HTTPHeader("Access-Control-Allow-Headers")}} を設定する必要があります。</p>
</div>
<h2 id="構文">構文</h2>
<pre class="syntaxbox notranslate"><var>XMLHttpRequest</var>.setRequestHeader(<var>header</var>, <var>value</var>)
</pre>
<h3 id="Parameters" name="Parameters">引数</h3>
<dl>
<dt><code>header</code></dt>
<dd>値を設定するヘッダーの名前。</dd>
<dt><code>value</code></dt>
<dd>そのヘッダーの本体として設定する値。</dd>
</dl>
<h3 id="Return_value" name="Return_value">返値</h3>
<p><code>undefined</code> です。</p>
<h2 id="Specifications" name="Specifications">仕様書</h2>
<table class="standard-table">
<thead>
<tr>
<th scope="col">仕様書</th>
<th scope="col">状態</th>
<th scope="col">備考</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{SpecName('XMLHttpRequest', '#the-setrequestheader()-method', 'setRequestHeader()')}}</td>
<td>{{Spec2('XMLHttpRequest')}}</td>
<td>WHATWG living standard</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>
<p>{{Compat("api.XMLHttpRequest.setRequestHeader")}}</p>
<h2 id="See_also" name="See_also">関連情報</h2>
<ul>
<li><a href="/ja/docs/Web/API/XMLHttpRequest/Using_XMLHttpRequest">XMLHttpRequest の使用</a></li>
<li><a href="/ja/docs/Web/API/XMLHttpRequest/HTML_in_XMLHttpRequest">XMLHttpRequest での HTML</a></li>
</ul>
|
