---
title: PushSubscription
slug: Web/API/PushSubscription
tags:
  - API
  - Experimental
  - Interface
  - Push
  - Push API
  - PushSubscription
  - Reference
  - Service Workers
translation_of: Web/API/PushSubscription
---
<div>{{SeeCompatTable}}{{ApiRef("Push API")}}</div>

<p><a href="/ja/docs/Web/API/Push_API">Push API</a> の <code>PushSubscription</code> インターフェースは、サブスクリプションの URL エンドポイントを提供するとともに、プッシュサービスの登録を解除できます。</p>

<p>このインターフェースのインスタンスはシリアライズできます。</p>

<h2 id="Properties" name="Properties">プロパティ</h2>

<dl>
 <dt>{{domxref("PushSubscription.endpoint")}} {{readonlyinline}}</dt>
 <dd>プッシュサービスに関連したエンドポイントを含む {{domxref("USVString")}}。</dd>
 <dt>{{domxref("PushSubscription.expirationTime")}} {{readonlyinline}}</dt>
 <dd>プッシュサブスクリプションに関連付いたサブスクリプション期限切れ時間を表す {{domxref("DOMHighResTimeStamp")}} 。存在しない場合は null。</dd>
 <dt>{{domxref("PushSubscription.options")}} {{readonlyinline}}</dt>
 <dd>サブスクリプションを作成するために用いられるオプションを含むオブジェクト。</dd>
</dl>

<dl>
 <dt>{{domxref("PushSubscription.subscriptionId")}} {{deprecated_inline}} {{readonlyinline}}</dt>
 <dd>プッシュサービスに関連したサブスクリプション ID を含む {{domxref("DOMString")}}。</dd>
</dl>

<h2 id="Methods" name="Methods">メソッド</h2>

<dl>
 <dt>{{domxref("PushSubscription.getKey()")}}</dt>
 <dd>サーバーに送信されてプッシュメッセージの暗号化に使用される、クライアントのパブリックキーを含む {{domxref("ArrayBuffer")}} を返します。</dd>
 <dt>{{domxref("PushSubscription.toJSON()")}}</dt>
 <dd>標準シリアライザー — サブスクリプションプロパティの JSON 記法を返します。</dd>
 <dt>{{domxref("PushSubscription.unsubscribe()")}}</dt>
 <dd>プッシュサービスの登録を解除する非同期プロセスを開始します。現在のサブスクリプションが成功裏に登録解除できた場合、{{domxref("Boolean")}} で解決される {{jsxref("Promise")}} を返します。</dd>
</dl>

<h2 id="Example" name="Example">例</h2>

<pre class="brush: js">navigator.serviceWorker.ready.then(function(reg) {
  reg.pushManager.getSubscription().then(function(subscription) {
    subscription.unsubscribe().then(function(successful) {
      // 成功裏に登録解除。
    }).catch(function(e) {
      // 登録解除失敗。
    })
  })
});</pre>

<h2 id="Specifications" name="Specifications">仕様</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">仕様</th>
   <th scope="col">状態</th>
   <th scope="col">コメント</th>
  </tr>
  <tr>
   <td>{{SpecName("Push API", "#pushsubscription-interface", "PushSubscription")}}</td>
   <td>{{Spec2("Push API")}}</td>
   <td>初期定義。</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザー実装状況</h2>

<div>
<p>{{Compat("api.PushSubscription")}}</p>
</div>

<h2 id="See_also" name="See_also">関連項目</h2>

<ul>
 <li><a href="/ja/docs/Web/API/Push_API">Push API</a></li>
 <li><a href="/ja/docs/Web/API/Service_Worker_API">Service Worker API</a></li>
</ul>