}
}
]
}
```
#### user\_event
```
{
"user_event": {
"revoke": {
"date_time": "2018-05-24T09:48:12+00:00",
"target": {
"app_id": "13090192"
},
"source": {
"user_id": "63046977"
}
}
}
}
```
#### direct\_message\_events
```
{
"for_user_id": "4337869213",
"direct_message_events": [{
"type": "message_create",
"id": "954491830116155396",
"created_timestamp": "1516403560557",
"message_create": {
"target": {
"recipient_id": "4337869213"
},
"sender_id": "3001969357",
"source_app_id": "13090192",
"message_data": {
"text": "Hello World!",
"entities": {
"hashtags": [],
"symbols": [],
"user_mentions": [],
"urls": []
}
}
}
}],
"apps": {
"13090192": {
"id": "13090192",
"name": "FuriousCamperTestApp1",
"url": "https://x.com/furiouscamper"
},
"users": {},
"3001969357": {
"id": "3001969357",
"created_timestamp": "1422556069340",
"name": "Jordan Brinks",
"screen_name": "furiouscamper",
"location": "Boulder, CO",
"description": "Alter Ego - X PE opinions-are-my-own",
"url": "https://t.co/SnxaA15ZuY",
"protected": false,
"verified": false,
"followers_count": 22,
"friends_count": 45,
"statuses_count": 494,
"profile_image_url": "null",
"profile_image_url_https": "https://pbs.twimg.com/profile_images/851526626785480705/cW4WTi7C_normal.jpg"
},
"4337869213": {
"id": "4337869213",
"created_timestamp": "1448312972328",
"name": "Harrison Test",
"screen_name": "Harris_0ff",
"location": "Burlington, MA",
"protected": false,
"verified": false,
"followers_count": 8,
"friends_count": 8,
"profile_image_url": "null",
"statuses_count": 240,
"profile_image_url_https": "https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png"
}
}
}
```
#### direct\_message\_indicate\_typing\_events
```
{
"for_user_id": "4337869213",
"direct_message_indicate_typing_events": [{
"created_timestamp": "1518127183443",
"sender_id": "3284025577",
"target": {
"recipient_id": "3001969357"
}
}],
"users": {
"3001969357": {
"id": "3001969357",
"created_timestamp": "1422556069340",
"name": "Jordan Brinks",
"screen_name": "furiouscamper",
"location": "Boulder, CO",
"description": "Alter Ego - X PE opinions-are-my-own",
"url": "https://t.co/SnxaA15ZuY",
"protected": false,
"verified": false,
"followers_count": 23,
"friends_count": 47,
"statuses_count": 509,
"profile_image_url": "null",
"profile_image_url_https": "https://pbs.twimg.com/profile_images/851526626785480705/cW4WTi7C_normal.jpg"
},
"3284025577": {
"id": "3284025577",
"created_timestamp": "1437281176085",
"name": "Bogus Bogart",
"screen_name": "bogusbogart",
"protected": true,
"verified": false,
"followers_count": 1,
"friends_count": 4,
"statuses_count": 35,
"profile_image_url": "null",
"profile_image_url_https": "https://pbs.twimg.com/profile_images/763383202857779200/ndvZ96mE_normal.jpg"
}
}
}
```
#### direct\_message\_mark\_read\_events
```
{
"for_user_id": "4337869213",
"direct_message_mark_read_events": [{
"created_timestamp": "1518452444662",
"sender_id": "199566737",
"target": {
"recipient_id": "3001969357"
},
"last_read_event_id": "963085315333238788"
}],
"users": {
"199566737": {
"id": "199566737",
"created_timestamp": "1286429788000",
"name": "Le Braat",
"screen_name": "LeBraat",
"location": "Denver, CO",
"description": "data by day @X, design by dusk",
"protected": false,
"verified": false,
"followers_count": 299,
"friends_count": 336,
"statuses_count": 752,
"profile_image_url": "null",
"profile_image_url_https": "https://pbs.twimg.com/profile_images/936652894371119105/YHEozVAg_normal.jpg"
},
"3001969357": {
"id": "3001969357",
"created_timestamp": "1422556069340",
"name": "Jordan Brinks",
"screen_name": "furiouscamper",
"location": "Boulder, CO",
"description": "Alter Ego - X PE opinions-are-my-own",
"url": "https://t.co/SnxaA15ZuY",
"protected": false,
"verified": false,
"followers_count": 23,
"friends_count": 48,
"statuses_count": 510,
"profile_image_url": "null",
"profile_image_url_https": "https://pbs.twimg.com/profile_images/851526626785480705/cW4WTi7C_normal.jpg"
}
}
}
```
```
{
"for_user_id": "930524282358325248",
"tweet_delete_events": [
{
"status": {
"id": "1045405559317569537",
"user_id": "930524282358325248"
},
"timestamp_ms": "1432228155593"
}
]
}
```
## Account Activity Replay API
`Enterprise`
Account Activity Replay API は、最大 5 日前までのイベントを取得できるデータリカバリツールです。[webhook](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#enterprise-account-activity-api) サーバーがイベントの受信に失敗した状況、たとえば [retry window](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#retries) を超える切断が発生した場合や、システムを通常どおりの状態に復旧するまでに数日を要するディザスタリカバリのシナリオにおいて、データを復旧する目的で使用します。
Account Activity Replay API は、ある期間にわたって [activities](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity) の取り込みに失敗したあらゆるシナリオを想定して開発されました。アクティビティは、元のリアルタイム配信で使用されていたものと同じ webhook に配信されます。本プロダクトはリカバリツールでありバックフィルツールではないため、過去に配信が試行されたイベントのみがリプレイされます。Account Activity Replay API は、サブスクリプションが作成された時刻より前の期間のイベントを配信することはできません。
### Account Activity Replay API の使用
アカウントで Replay 機能が有効になっている場合、Account Activity API へのリクエストとほぼ同様の方法でリクエストを送信できます。重要な点として、どの webhook のアクティビティをリプレイしたいかを示すために、リクエストで webhook id パラメーターを指定する必要があります。言い換えると、Replay リクエストは、webhook id と application id に基づいて、開始日時から終了日時までのイベントを取得するよう Account Activity Replay API に要求するものです。
UTC 時刻で指定する必要がある点に注意してください。これらのアクティビティは、その id に関連付けられた登録済み webhook を通じて、1 秒あたり最大 2,500 件のイベントの速度で配信されます。また、1 つの webhook につき同時に実行できる Replay ジョブは 1 つだけですが、その webhook で指定された日時の期間中にアクティブだったすべてのサブスクリプションがリプレイされることも覚えておいてください。
イベントは、指定した期間の最初 (最も古い) 1 分間から配信が開始され、その後は最終分が配信されるまで、 (可能な限り) 時系列順に続きます。その時点で、Replay は [ジョブ完了イベント](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#job-completed-successfully-message) を webhook に配信します。アクティビティは時系列順に配信されるため、開始時刻付近に一致する結果がほとんどない、またはまったくない場合、最初の結果が配信されるまでに時間が空く可能性があります。
### 制限事項
Replay は、最大で 5 日前までのアクティビティを簡単に取得するためのツールとして設計されていますが、サブスクリプションが作成された時刻より前のイベントは配信されません。たとえば、3 日前に新しいサブスクリプションを追加し、本日から過去 5 日間を対象とする Replay ジョブを実行した場合、受信できるのはこの新しいサブスクリプションが有効だった 3 日間分のデータのみです。
### データの可用性と種類
Account Activity Replay API からのアクティビティは、リクエストの開始から 5 日間利用可能で、各アクティビティが作成されてからおよそ 10 分後に新しいデータが利用可能になります。from\_date パラメータと to\_date パラメータを使用して、この 5 日間の範囲内の任意の期間を指定してリクエストを行うことができます。Replay へのアクセス権を得る前に元々配信されていたイベントは、Replay を使ってリプレイすることはできません。たとえば、お使いのアカウントが 2019 年 6 月 1 日 3:30PM UTC に Account Activity Replay API へのアクセスが有効化された場合、その日時より前のイベントを Replay を使って取得することはできません。
[Account Activity Replay APIリファレンス](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#delete-account-activity-webhooks-webhook-id-subscriptions-all-deprecated)を参照してください。
## 移行の概要
**Site Streams、User Streams、および Account Activity API - DM Only の標準ベータ版プロダクトは 2018 年に提供終了しました。これらのプロダクトを利用していた場合は、必ず Account Activity API のプレミアム版またはエンタープライズ版へ移行してください。**
**レガシーの Direct Message エンドポイントも提供終了しました。これらのエンドポイントを利用していた場合は、新しい DM エンドポイント、または Account Activity API のプレミアム版もしくはエンタープライズ版のいずれかに必ず移行してください。**
**詳しくは [このアナウンス](https://devcommunity.x.com/t/details-and-what-to-expect-from-the-api-deprecations-this-week-on-august-16-2018/110746) を参照してください。**
これらの変更により影響を受けるエンドポイントは次のとおりです。
* User Streams
* Site Streams
* GET direct\_messages
* GET direct\_messages/sent
* GET direct\_messages/show
* POST direct\_messages/new
* POST direct\_messages/destroy
これらと同様のアクセス手段を提供し、Direct Message については追加機能も備えた新しいエンドポイントとサービスが用意されています。
* Account Activity API の [enterprise](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#enterprise-account-activity-api) および [premium](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#account-activity-api-reference-index)
* [GET direct\_messages/events/list](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/list-events)
* [GET direct\_messages/events/show](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/get-event)
* [POST direct\_messages/events/new](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/new-event)
* [POST direct\_messages/events/destroy](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/delete-message-event)
これらの新しいエンドポイントやサービスへのスムーズな移行を支援するため、以下の 2 つの移行ガイドを用意しています。
* User Streams および Site Streams から新しい Webhook ベースのサービスへ移行する方向けの [Account Activity API 移行ガイド](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#migration-guide-moving-from-user-streams-site-streams-to-account-activity-api)
* Direct Message の REST エンドポイント間で移行する方向けの [Direct Message 移行ガイド](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/guides/direct-message-migration)
さらに、Account Activity API とその始め方について解説した [一連の動画](https://www.youtube.com/playlist?list=PLFKjcMIU2WshGG6Yj940XM7Z6BFs1zfBg) も用意しています。
最後に、理解を深め、すぐに使い始められるようにするためのコードサンプルも提供しています。
* [Account Activity Dashboard](https://github.com/xdevplatform/Account-Activity-dashboard) は、Account Activity API の利用を開始するためのヘルパースクリプトを備えたサンプルの Node.js Web アプリです。
* [SnowBot](https://github.com/xdevplatform/SnowBotDev) は、Account Activity API と REST の Direct Message エンドポイントを利用するサンプルチャットボットです。Ruby で実装され、Sinatra Web アプリフレームワークを使用し、Heroku にデプロイされています。
## 移行ガイド: User Streams/Site Streams から Account Activity API への移行
**2018 年 8 月 23 日をもって、Site Streams と User Streams は廃止されました。必ず Account Activity API へ移行してください。**
**詳細については、[このお知らせ](https://devcommunity.x.com/t/details-and-what-to-expect-from-the-api-deprecations-this-week-on-august-16-2018/110746) を参照してください。**
このガイドは、従来の User Streams および Site Streams API から、その後継である Account Activity API への移行を支援することを目的としています。以下では、変更点の概要、新機能の一覧、および移行を進めるうえで役立つ主な相違点や考慮事項を説明します。基本的な DM エンドポイントからの移行方法については、[ダイレクトメッセージ移行ガイド](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/guides/direct-message-migration) を参照してください。
### 変更点の概要
Account Activity API は、User Streams や Site Streams のようなストリーミング接続ではなく、Webhook を通じて、認証およびサブスクライブ済みアカウントのイベントを配信します。
#### 非推奨 API
GET user
GET site (制御ストリームを含む: GET site/c/:stream\_id, GET site/c/:stream\_id/info.json, GET site/c/:stream\_id/friends/ids.json, POST site/c/:stream\_id/add\_user.json, POST /site/c/:stream\_id/remove\_user.json)
#### 後継 API
[Enterprise Account Activity API - すべてのアクティビティ](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#enterprise-account-activity-api)
### 違いと移行時の考慮事項
**API 形式:** 新しい Account Activity API は、User Streams や Site Streams とは動作が異なります。webhooks でデータを受信できるよう、Web アプリを変更する必要があります。webhooks の詳細は[こちら](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#getting-started-with-webhooks)をご覧ください。
**利用可能なデータ:** もう 1 つの大きな違いは、配信されるデータの内容です。X は、あなたが X 上でフォローしているユーザー (いわゆるホームタイムライン) からのイベントを今後は送信しません。これは意図的な変更であり、今後変更する予定はありません。
**信頼性:** ストリーミングと異なり、webhooks では配信確認が可能であり、webhook URL に到達しなかった POST されたアクティビティを再試行するオプションも提供します。これにより、短時間の切断やダウンタイムが発生した場合でも、App が該当するすべてのアクティビティを確実に受信できる可能性が高まります。
### 新機能
Account Activity API では多くの新機能が提供されていますが、特に大きな変更点は、データがストリーミングではなく Webhook 経由で配信されるようになったことです。Webhook にはストリーミングと比べて多くの利点がありますが、その中でも最も大きいのは速度と信頼性です。API は、データが利用可能になり次第、JSON イベントとして送信するため、アクティブな接続を維持したり、エンドポイントをポーリングしたりする必要がなくなります。これにより冗長化機能の必要性が抑えられ、全体的な効率が向上します。Webhook の詳細については、[技術ドキュメント](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#getting-started-with-webhooks)を参照してください。
### ユーザーサブスクリプションの管理
Account Activity API では、1 つの登録済み webhook に対して複数のサブスクリプションを設定できます。これにより、Site Streams のアーキテクチャと同様に、複数のユーザーサブスクリプションのアクティビティを、webhooks を使って同じ場所に配信できます。これは、サブスクリプション数の上限管理の観点から、サブスクリプションを webhook 接続とは独立して追跡できることも意味します。また、これにより、1 つまたは少数のサブスクリプションから、1 つの webhook あたり数千のサブスクリプションへとスケールさせることができます。
### **移行手順**
### **以下の手順に従って、Site Streams API から Account Activity API へ簡単に移行できます**
**ステップ 1: パッケージを決定する**
現在 User Streams または Site Streams をどのように運用しているかに応じて、Account Activity API の enterprise 版か premium 版のいずれかへの移行を検討する必要があります。現在サポートしているアプリケーション数または認可済みユーザー数を考慮し、必要なボリュームと信頼性に応じて適切にスケールしてください。どのパッケージがニーズに最も適しているかを決定する際には、次の点を考慮してください。
* 必要な webhook の数
* アプリケーションで管理している現在/将来想定の購読/認可済みユーザー数
* 現在の X クライアントアプリケーション数
* X から希望するサポートレベル (フォーラムサポートか、マネージド enterprise レベルの 1:1 サポートか)
* 各パッケージの価格
**ステップ 2:** **開発者コンソールで X App のセットアップを確認する**
現在 User Streams または Site Streams に使用している [X app](/ja/resources/fundamentals/developer-apps) は、[開発者コンソール](/ja/resources/fundamentals/developer-portal) 上で所有ユーザーに紐づいて一覧表示されています。 この X app は、同じアプリケーションの認可済みユーザーを保持するために Account Activity API でも利用できます。 新しい App を作成し、必要に応じてユーザーに対してこの新しい App への再認可を行ってもかまいません。 企業を代表して新しい App を作成する場合は、企業の X の @handle アカウントで App を作成することを推奨します。
* X app ページの [permissions](/ja/resources/fundamentals/developer-apps#app-permissions) タブで「Read, Write and Access direct messages」を有効にします。
\*これらの設定変更は遡及的には適用されず、既に認可済みのユーザーは認可時点の設定を維持することに注意してください。ユーザーがまだ read、write、direct message アクセスを付与していない場合は、そのユーザーにアプリケーションを再認可してもらう必要があります。
* [X Sign-in](/ja/resources/fundamentals/authentication#log-in-with-x) や、X API におけるユーザーコンテキストの仕組みに不慣れな場合は、[Obtaining Access Tokens](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#getting-started-with-webhooks) を確認してください。
* 「Keys and Tokens」タブの下部で、X app のオーナー用のアクセストークンを生成します。同じタブで、Consumer Key、Consumer Secret、Access Token、Access Token Secret を控えておいてください。API を利用する際に必要になります。
* [application-only](/ja/resources/fundamentals/authentication#bearer-token-also-known-as-app-only) API メソッド用に、Consumer Key と Consumer Secret を使用してベアラートークンを生成します。
**ステップ 3: Webhook のセットアップと設定**
* イベントを受信するための webhook として使用するエンドポイントを備えた Web アプリを作成します (例: [https://your\_domain.com/webhook/twitter](https://your\_domain.com/webhook/twitter) または [https://webhooks.your\_domain.com](https://webhooks.your\_domain.com)) 。
* webhook を作成する際に、Consumer Key、Consumer Secret、Access Token、Access Token Secret を使用します。エンドポイントは、response\_token を含む JSON レスポンスを返す必要があり、response\_token は crc\_token と App の Consumer Secret から生成される base64 エンコードされた HMAC SHA-256 ハッシュでなければなりません。
* [Securing Webhooks](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#securing-webhooks) ドキュメントを確認し、特に Challenge Response Check (CRC) の要件をよく確認してください。
* webhook が着信イベント用の POST リクエストと、CRC 用の GET リクエストをサポートしていることを確認します。
* webhook が低レイテンシであることを確認します (POST リクエストへの応答が 3 秒未満) 。
**ステップ 4: Webhook 設定を検証する**
* Webhook API は、次の 2 つの方法で webhook を保護します。
- Challenge Response Check を要求し、webhook の所有者が Web アプリの所有者であることを検証します。
- 各 POST リクエストに署名ヘッダーを付与し、Web アプリ側で送信元を検証できるようにします。
* あなたが Web アプリと webhook URL の両方の所有者であることを検証するために、X は Challenge Response Check (CRC) を実行します。これは cyclic redundancy check とは異なることに注意してください。
* crc\_token という名前のパラメータを含む GET リクエストが webhook URL に送信されます。エンドポイントは、crc\_token と App の Consumer Secret から生成された base64 エンコード済み HMAC SHA-256 ハッシュである response\_token を含む JSON レスポンスを返さなければなりません。
* crc\_token は、受信する各 CRC リクエストごとに変更されると想定してください。crc\_token は計算時のメッセージとして使用し、Consumer Secret をキーとして使用します。
* 応答が無効な場合、登録された webhook へのイベント送信は停止されます。
**ステップ 5: 各 User Stream または Site Streams の認可済みユーザーに対してサブスクリプションを作成する**
User Streams から Account Activity API へ移行する場合:
* User Streams 上で、現在のユーザーサブスクリプションの一覧を取得します
* 次のリクエストを使用して、新しい Account Activity API のサブスクリプションを設定します: *POST account\_activity/all/:env\_name/subscriptions*
* 次のリクエストを使用して、Account Activity API のサブスクリプションを確認します: \_GET account\_activity/all/:env\_name/subscriptions/list
\_
Site Streams から Account Activity API への移行: (コントロールストリームを使用)
* 次のリクエストを使用して、Site Streams 上で現在のサブスクリプションの一覧を取得します: *GET /1.1/site/c/:stream\_id/info.json*
* 次のリクエストを使用して、新しい Account Activity API のサブスクリプションを設定します: *POST account\_activity/all/:env\_name/subscriptions*
* 次のリクエストを使用して、Account Activity API のサブスクリプションを確認します: \_GET account\_activity/all/:env\_name/subscriptions/list
\_
Webhook の登録とサブスクリプションの作成 (Site Streams または User Streams からの移行ではない場合)
* [POST webhooks](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#enterprise-account-activity-api) を使用して App に webhook URL を登録し、webhook\_id を受け取ります。
* 返された webhook\_id を使用して、[POST webhooks/:webhook\_id/subscriptions/all](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#post-account-activity-webhooks-webhook-id-subscriptions-all) でユーザーサブスクリプションを追加します。
### Account Activity ダッシュボード (Account Activity API サンプルアプリ)
Account Activity API のテストを少しでも早く行えるよう、サンプルアプリを用意しました。
* Account Activity Dashboard サンプルアプリケーションを [こちら](https://github.com/xdevplatform/Account-Activity-dashboard) からダウンロードします (Node.js を使用します)
* README の手順に従ってアプリをインストールし、起動します
* アプリケーションを起動したら、UI から webhook を簡単に設定し、新しいサブスクリプションを作成できます
### 利用可能なアクティビティ
| メッセージタイプ | 詳細 |
| :--------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- |
| [tweet\_create\_events](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#tweet-create-events-posts-retweets-replies-quotetweets) | サブスクリプションユーザーが行う、またはサブスクリプションユーザーに対して行われる次のいずれかのアクション時のポストステータスのペイロード：投稿、リツイート、返信、@メンション、引用ツイート |
| [favorite\_events](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#favorite-events) | ユーザーと対象ユーザーを含む「いいね」 (Favorite) イベントのステータス。 |
| [follow\_events](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#follow-events) | ユーザーと対象ユーザーを含むフォローイベント。 |
| [block\_events](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#block-events) | ユーザーと対象ユーザーを含むブロックイベント。 |
| [mute\_events](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#mute-events) | ユーザーと対象ユーザーを含むミュートイベント。 |
| [direct\_message\_events](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#direct-message-events) | ユーザーと対象ユーザーを含むダイレクトメッセージのステータス。 |
| [direct\_message\_indicate\_typing\_events](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#direct-message-indicate-typing-events) | ユーザーと対象ユーザーを含むダイレクトメッセージの入力中イベント。 |
| [direct\_message\_mark\_read\_events](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#direct-message-mark-read-events) | ユーザーと対象ユーザーを含むダイレクトメッセージの既読イベント。 |
### 廃止されたストリーミングメッセージ種別
| | |
| :------ | :--------------------------------------------------------------------------------------------------------- |
| 空行 | 空行は User Streams および Site Streams ではキープアライブメッセージとして使われていましたが、Account Activity API では今後配信されません。 |
| 制限通知 | 制限通知は特定の webhook 宛てには今後送信されません。代わりに、利用可能なハンドルの現在の使用状況を取得するために API を呼び出すことができます。これは将来的に開発者コンソールにも表示される予定です。 |
| 切断メッセージ | webhook はアクティブな接続に依存しないため、切断通知は今後不要になります。 |
| 停滞警告 | webhook は大量の受信メッセージを処理できるアクティブな接続に依存しないため、停滞警告は今後不要になります。 |
| フレンドリスト | フレンドリストは今後事前に送信されることはありません。代わりに、この情報を取得するための REST エンドポイントが提供されます。 |
### 非推奨のイベント種別
| | | | | |
| :-------------------- | :----------------------- | :------------ | :----------- | :-------------- |
| **説明** | **イベント名** | **ソース** | **ターゲット** | **ターゲットオブジェクト** |
| ユーザーがポストを削除する | delete | 現在のユーザー | 現在のユーザー | ポスト |
| フォローしているユーザーがポストを削除する | delete | フォローしているユーザー | フォローしているユーザー | ポスト |
| ユーザーがポストのいいねを取り消す | unfavorite | 現在のユーザー | ポストの作成者 | ポスト |
| ユーザーのポストのいいねが取り消される | unfavorite | いいねを取り消したユーザー | 現在のユーザー | ポスト |
| ユーザーが誰かのフォローを解除する | unfollow | 現在のユーザー | フォローしていたユーザー | Null |
| ユーザーがリストを作成する | list\_created | 現在のユーザー | 現在のユーザー | リスト |
| ユーザーがリストを削除する | list\_destroyed | 現在のユーザー | 現在のユーザー | リスト |
| ユーザーがリストを編集する | list\_updated | 現在のユーザー | 現在のユーザー | リスト |
| ユーザーが誰かをリストに追加する | list\_member\_added | 現在のユーザー | 追加されたユーザー | リスト |
| ユーザーがリストに追加される | list\_member\_added | 追加したユーザー | 現在のユーザー | リスト |
| ユーザーが誰かをリストから削除する | list\_member\_removed | 現在のユーザー | 削除されたユーザー | リスト |
| ユーザーがリストから削除される | list\_member\_removed | 削除したユーザー | 現在のユーザー | リスト |
| ユーザーがリストを購読する | list\_user\_subscribed | 現在のユーザー | リストの所有者 | リスト |
| ユーザーのリストが購読される | list\_user\_subscribed | 購読したユーザー | 現在のユーザー | リスト |
| ユーザーがリストの購読を解除する | list\_user\_unsubscribed | 現在のユーザー | リストの所有者 | リスト |
| ユーザーのリストの購読が解除される | list\_user\_unsubscribed | 購読を解除したユーザー | 現在のユーザー | リスト |
| ユーザーがプロフィールを更新する | user\_update | 現在のユーザー | 現在のユーザー | Null |
| ユーザーが保護状態を更新する | user\_update | 現在のユーザー | 現在のユーザー | Null |
## ダイレクトメッセージ移行ガイド
**2018 年 9 月 17 日に従来のダイレクトメッセージ用エンドポイントを廃止しました。
これらのエンドポイントを利用していた場合は、新しいダイレクトメッセージ用エンドポイントまたは Account Activity API へ必ず移行してください。**
**詳しくは、[このお知らせ](https://devcommunity.x.com//t/details-and-what-to-expect-from-the-api-deprecations-this-week-on-august-16-2018/110746)をご確認ください。**
このガイドは、従来のダイレクトメッセージ REST API から、ベータ版を卒業した強化版 API へ移行する際の支援を目的としています。以下では、変更点の概要、新機能の一覧、移行に役立つ主な相違点と考慮事項を説明します。新しいダイレクトメッセージ用エンドポイントは、すべての開発者にご利用いただけます。User Streams または Site Streams からの移行については、[Account Activity API への移行ガイド](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#migration-guide-moving-from-user-streams-site-streams-to-account-activity-api)を参照してください。
* [変更点の概要](#summary)
* [新機能](#features)
* [ダイレクトメッセージの送信](#sending)
* [ダイレクトメッセージの受信](#receiving)
* [ダイレクトメッセージの削除](#deleting)
### 変更概要
以下のDMエンドポイントをまだ使用している場合は、新しいエンドポイントへ移行する必要があります。
| 非推奨エンドポイント | 移行先エンドポイント |
| :------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [POST direct\_messages/new](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/new-event) | [POST direct\_messages/events/new](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/new-event) |
| [GET direct\_messages/show](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/get-event) | [GET direct\_messages/events/show](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/get-event) |
| [GET direct\_messages](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/list-events) | [GET direct\_messages/events/list](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/list-events) |
| [GET direct\_messages/sent](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/get-event) | [GET direct\_messages/events/list](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/list-events) |
| [POST direct\_messages/destroy](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/delete-message-event) | [DELETE direct\_messages/events/destroy](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/delete-message-event "GET direct_messages/events/list") |
### 新機能
新しい Direct Message API エンドポイントは、さまざまな新機能に対応し、既存のダイレクトメッセージへのアクセスを改善します。新機能には次のようなものがあります。
* メディア (画像、GIF、動画) の添付に対応。
* あらかじめ定義された選択肢リストを使って、ユーザーに構造化された返信を促す機能。
* 過去 30 日分のダイレクトメッセージへのアクセス。
新しい Direct Message 機能の一覧およびその他の新しい API エンドポイントについては、[技術ドキュメント](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/overview)を参照してください。
### 違いと移行時の考慮事項
新しい API エンドポイントは、従来のエンドポイントとは大きく動作が異なります。単にエンドポイントの URL を更新するだけでは、アプリケーションでエラーが発生します。移行に向けてアプリケーションを更新する際は、次の点を考慮してください。
#### 新しいダイレクトメッセージオブジェクト
最初に気づくのは、ダイレクトメッセージの新しいオブジェクト構造でしょう。[Quick Replies](https://developer.x.com/en/docs/x-api/v1/direct-messages/quick-replies/overview) や [Attachments](https://developer.x.com/en/docs/x-api/v1/direct-messages/message-attachments/overview) などの新しい機能をサポートするために、この新しい Message Create オブジェクト構造が導入されています。この新しいオブジェクトには、よりコンパクトなユーザーオブジェクトも含まれます。アプリケーションは、この新しいオブジェクト構造を考慮して、パース処理や、場合によってはデータモデルやストレージを更新する必要があります。各プロパティの説明については、[Message Create オブジェクトに関する詳細なドキュメント](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/guides/message-create-object)を参照してください。
**Message Create オブジェクトの例**
```json theme={null}
{
"type": "message_create",
"id": "1234858592",
"created_timestamp": "1392078023603",
"initiated_via": {
"tweet_id": "123456",
"welcome_message_id": "456789"
},
"message_create": {
"target": {
"recipient_id": "1234858592"
},
"sender_id": "3805104374",
"source_app_id": "268278",
"message_data": {
"text": "青い鳥",
"entities": {
"hashtags": [],
"symbols": [],
"urls": [],
"user_mentions": [],
},
"quick_reply_response": {
"type": "options",
"metadata": "external_id_2"
},
"attachment": {
"type": "media",
"media": {
...
}
}
}
}
```
#### 概要
* ダイレクトメッセージ (Direct Message) オブジェクト構造が完全に刷新されました。
* user オブジェクトが簡略化されました。
* 新しい情報が追加されました (クイック返信の応答、添付ファイルなど) 。
### ダイレクトメッセージの送信
[POST direct\_messages/events/new](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/new-event) は、ダイレクトメッセージ送信のための代替エンドポイントです。主な違いは、このエンドポイントではすべての情報が個々の POST パラメータではなく、POST リクエストボディ内の JSON として送信される点です。
**Twurl リクエスト例**
```bash theme={null}
twurl -A 'Content-type: application/json' -X POST /1.1/direct\_messages/events/new.json -d '{"event": {"type": "message\_create", "message\_create": {"target": {"recipient\_id": "4534871"}, "message_data": {"text": "Hello World!"}}}}'
```
上記のリクエストでは、Content-Type ヘッダーが application/x-www-form-urlencoded ではなく application/json に設定されている点に注意してください。さらに、OAuth 1.0a の署名を生成する場合、その署名の生成には JSON 本文が含まれないことにも注意してください。ほとんどの OAuth ライブラリは既にこの点を考慮しています。[twurl](https://github.com/twitter/twurl) を使用している場合は、バージョン 0.9.3 以上を使用していることを確認してください。
#### 概要
* メッセージは JSON の POST リクエストボディ内で定義されます。
* Content-Type ヘッダーは application/json に設定する必要があります。
* JSON ボディは OAuth 署名生成の対象には含まれません。
### ダイレクトメッセージの取得
過去のダイレクトメッセージは、単一の API エンドポイントで取得できるようになりました: [GET direct\_messages/events/list](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/list-events)。この新しいエンドポイントの大きな違いは、送信メッセージと受信メッセージの両方を、新しいものから古いものへ並べて返す点です。これにより、会話を再構築しやすくなります。ただし、送信メッセージまたは受信メッセージのみを取得したい場合は、sender\_id プロパティを参照してレスポンスを後処理する必要があります。
ページネーションは、ダイレクトメッセージの ID ではなく、カーソル値に基づく方式になりました。各レスポンスには cursor プロパティが返されます。[GET direct\_messages/events/list](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/list-events) は、過去 30 日以内に存在するメッセージ数にかかわらず、最大で過去 30 日分のメッセージを返します。cursor が返されない場合は、それ以上返せるメッセージがないことを意味します。[GET direct\_messages/events/show](https://developer.x.com/en/docs/x-api/v1/direct-messages/sending-and-receiving/api-reference/get-event) による個別のダイレクトメッセージへのアクセス方法は従来どおりですが、返されるダイレクトメッセージオブジェクトの構造は、前述のとおり変更されています。
最後に、ダイレクトメッセージへのリアルタイムアクセスは、[Account Activity API](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity) を用いた webhook によって行うようになりました。User Streams や Site Streams からの移行に関するガイダンスについては、Account Activity API への移行ガイドを参照してください。
#### 概要
* 送信メッセージと受信メッセージが同じエンドポイントで返されるようになりました。
* 最大30日分のメッセージが返されます。
* カーソルベースのページネーションに対応しました。
* Webhook を通じてダイレクトメッセージにリアルタイムでアクセスできます。
### ダイレクトメッセージの削除
ダイレクトメッセージは、`DELETE direct_messages/events/destroy` を使用して削除できるようになりました。インターフェースはほぼ同じで、削除するメッセージの ID が必要です。主な違いは、このエンドポイントでは `POST` リクエストではなく `DELETE` リクエストが必要になった点です。
削除されたダイレクトメッセージが公式 X クライアントにどのように反映されるかは、従来どおりです。ダイレクトメッセージは、指定されたユーザーコンテキストのユーザーのインターフェースからのみ削除されます。会話の他の参加者は、そのダイレクトメッセージに引き続きアクセスできます。
#### 概要
* ダイレクトメッセージを削除するには ID が必要です。
* 新しいエンドポイントでは DELETE リクエストが必要です。
* 削除されたダイレクトメッセージが公式 X クライアントにどのように反映されるかは、これまでと変わりません。
\*\*新しいダイレクトメッセージエンドポイントへの移行について質問がありますか？\
\*\*質問は開発者コミュニティフォーラム ([devcommunity.com](https://devcommunity.x.com/)) に投稿してください。
## よくある質問
### 一般
**Account Activity API を利用する利点は何ですか？**
Account Activity API は webhook を使用します。つまり、ストリーミング API と異なり、こちらから情報を送信するためにオープンな接続を維持しておく必要がありません。Webhook は REST API とも異なり、必要なデータを取得するために 15 分ごとに何百回もポーリングする必要もありません。イベント発生と同時にデータを配信できるため、ユーザーとアプリケーション間のやり取りをより効率的に行えます。
Account Activity API には、次のような多くの利点があります。
1. **速度**: X のスピードでデータを配信します。
2. **シンプルさ**: アカウントのすべてのイベントを、単一の webhook 接続を通じて配信します。API で配信されるアクティビティには、投稿、@メンション、返信、Retweet、Quote Tweet、Quote Tweet の Retweet、いいね、送信された Direct Message、受信した Direct Message、フォロー、ブロック、ミュートが含まれます。
3. **スケール**: レート制限やイベント数の上限に縛られることなく、管理対象アカウントのすべてのアクティビティを受信できます。
Account Activity API は、プレミアムサンドボックス、プレミアム有料版、およびエンタープライズ版として提供されており、責任関連機能のためにより多くのアカウントが必要になった場合や、追加機能が必要になった場合でも、ニーズに応じてスケールできます。
利用を開始するには、[GitHub](https://github.com/xdevplatform/account-activity-dashboard) からサンプルのコードスニペットをダウンロードしてください。
**自分に最適なプロダクトティアを見分けるにはどうすればよいですか？**
プレミアムオプションとエンタープライズオプションの違いについて詳しく知るには、[Account Activity API Overview](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity) ページをお読みください。
**プレミアム環境とエンタープライズ webhook の違いは何ですか？**
違いはありません。各プレミアム環境には、それぞれ独自の webhook\_id が付与されます。
**Account Activity API 用に開発／ステージング／本番環境が必要です。これは可能ですか？**
はい。Account Activity API の有料階層 (有料プレミアムおよびエンタープライズ) では、複数の webhook URL を登録し、各 URL ごとに API メソッドを通じて購読を個別に管理できます。さらに、複数のクライアント App を allowlist に追加して、現在認可されているユーザーの認可状態を維持できます。
**Account Activity API のセットアップ方法について、ステップバイステップのガイドはありますか？**
あります。
* これから始める場合は、[Getting started with webhooks](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#getting-started-with-webhooks) ガイドを参照することをおすすめします
* X Dev 提供のスクリプトもあわせてご利用ください:
* [Account Activity API dashboard](https://github.com/xdevplatform/account-activity-dashboard): webhook イベントを表示する Node.js のウェブアプリケーションです。
* [SnowBot chatbot](https://github.com/xdevplatform/SnowBotDev): Account Activity API および Direct Message API 上に構築された Ruby のウェブアプリケーションです。このコードベースには、Account Activity API の webhook セットアップを支援する[スクリプト](https://github.com/xdevplatform/SnowBotDev/wiki/Account-Activity-API-setup-script)が含まれています。
**システムが一定時間ダウンした場合、データを復旧する方法はありますか？**
Account Activity API の有料階層 (有料プレミアムおよびエンタープライズ) では、当社システムが 4 時間の期間内に複数回、アクティビティの送信を[再試行](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#retries)します。その 4 時間内にあなたのシステムが応答しない場合、そのアクティビティは失われ、7 日以内のデータを復旧するには他の REST エンドポイントを使用する必要があります。
複数の webhook や環境を、[Account Activity Replay API](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#account-activity-replay-api) のような冗長化ツールとして使用し、いずれかのシステムがダウンした場合でもアクティビティを取り逃さないようにすることをおすすめします。
**Account Activity API では、どの認証方式を使用する必要がありますか？**
Account Activity API で必要となる認可方式は、[APIリファレンスページ](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#account-activity-api-reference-index)の各メソッドに記載されています。X の認証を初めて利用する場合は、[このセクション](/ja/resources/fundamentals/authentication)をお読みいただくことをおすすめします。
**challenge-response check (CRC) とは何ですか？**
Account Activity API のチャレンジレスポンスチェックは、Account Activity API のアクティビティが正しい開発者に送信されていることを保証するために導入されたセキュリティ機能です。これはまた、開発者が受信しているデータが X から送信されていることを確認する目的でも使用できます。X は、webhook URL が最後に検証された時点から 24 時間ごとに 1 回、自動的に CRC を webhook URL に送信します。システムは、検証状態を維持するために 3 秒以内に有効なレスポンスを返す必要があります。
詳しくは、[Securing webhooks](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#securing-webhooks) のページをご覧ください。
**webhook URL が即座に無効化されるケースはありますか？**
次のいずれかが発生した場合、webhook は即座に無効としてマークされます。
* サーバーが CRC に対して誤ったトークンで応答した場合。この場合、弊社システムはアクティビティを送信するための[再試行](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#retries)を行いません。
* webhook URL に誤った証明書が設定されている場合。この場合も、弊社システムはアクティビティを送信するための[再試行](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#retries)を行いません。
* サーバーが 2XX、4XXX、5XXX 以外のレスポンスコードを返した場合。
* gzip を使用すると指定しているにもかかわらず、実際には gzip を使用して送信していない場合。
* gzip の使用を指定していないにもかかわらず、実際には gzip を使用してレスポンスを送信している場合。
**互いにやり取りしているユーザーを購読した場合、重複したアクティビティを受け取ることはありますか？**
はい。Web アプリがユーザー A とユーザー B に対して有効なサブスクリプションを持っており、ユーザー A がポスト内でユーザー B に言及した場合、登録済みの webhook には 2 件の POST アクティビティが送信されます。それぞれのアクティビティには、そのアクティビティがどのサブスクリプションに属するかを示す "for\_user\_id" フィールドが含まれます。
**webhook へのサブスクリプションを作成する際、次のエンドポイントの `/all/` 部分を他のアカウントアクティビティのデータオブジェクトに置き換えて、API が配信するアクティビティを制限することはできますか？**`POST https://api.x.com/1.1/account_activity/all/:env_name/subscriptions.json`
いいえ、これはできません。現時点では、利用可能なプロダクトは `/all/` のみです。
**ユーザーから Direct Messages の権限を要求せずに Account Activity API を使用する方法はありますか？**
現時点では、この API では Direct Messages アクティビティだけを「フィルタリングして除外する」方法がないため、Direct Messages の権限が必須となります。
**Account Activity API のサンドボックス版はありますか？**
はい、テスト用のサンドボックスオプションを提供しています。サンドボックスオプションでは、webhook は 1 つに制限され、サブスクリプションの最大数は 15 件までとなります。サンドボックスオプションの詳細については、[ドキュメント](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity) を参照してください。
**購読しているユーザーに言及しているポストに対する Retweets を、Account Activity API で取得することはできますか？**
残念ながら、これはこの API で配信されるアクティビティには含まれていません。この用途には、代わりに Streaming API の利用をお勧めします。
**tweet\_create\_event で表される可能性のあるアクティビティタイプにはどのようなものがありますか？**
tweet\_create\_event のペイロードは、次の場合に送信されます。
サブスクリプション対象ユーザーが次のいずれかの操作を行った場合:
* ポストを作成したとき
* Retweet したとき
* ポストに返信したとき
別のユーザーが次のことを行った場合:
* サブスクリプションユーザーを @mentions\* したとき
* サブスクリプションユーザーが作成したツイートを引用したとき
\*注: Account Activity API は、サブスクリプションユーザーが X から通知を受け取り、そのイベントを公開で確認できる場合にのみイベントを配信します。つまり、言及されたアカウント (@userA) が保護されたアカウント (@userB) をフォローしている場合、User A は User B から言及されたことの通知を受け取ります。User A が User B をフォローしていない (かつ User B に承認されていない) 場合、User A は通知を受け取らず、そのため @userA がサブスクリプションを持っていたとしても、tweet\_create\_event は AAA 経由で送信されません。
**ブロックしているユーザーが、サブスクライブしているユーザーに言及した場合、どのように判別できますか？**
json レスポンスのトップレベルにあるブール型フィールド `user_has_blocked` が "true" または "false" のいずれかに設定されているのが確認できます。このフィールドは、ポストへの言及に対してのみ公開されます。
エンタープライズ
**自分の App を allowlist に追加する、または既に allowlist に追加されているか確認するにはどうすればよいですか？**
Enterprise API へのアクセス用に許可リスト (allowlist) に追加した [X apps](/ja/resources/fundamentals/developer-apps) を管理するには、App の `id` (app ID) を添えてアカウントマネージャーまでご連絡ください。app ID は、[開発者コンソール](/ja/resources/fundamentals/developer-portal) の ["Apps"](/ja/resources/fundamentals/developer-apps) ページに移動すると確認できます。
**3 つの webhook へのアクセス権がある場合、エンタープライズ利用として登録した各 App ごとに 3 つずつ webhook を使用できますか？**
webhook の上限は App 単位ではなくアカウント単位で設定されています。3 つの webhook へのアクセス権があり、エンタープライズ利用として 2 つの App を登録している場合、1 つの App に 2 つ、もう一方の App に 1 つという形で利用できますが、各 App で 3 つずつ利用することはできません。
**Account Activity Replay API で再配信されるイベントの種類を指定できますか？**
リプレイするイベントの種類を指定することはできません。指定した日時の範囲内で配信されたすべてのイベントが再配信されます。
**アプリケーションが Account Activity Replay API のイベントの取り込みに失敗した場合、再試行は行われますか？**
いいえ、再試行は行われません。アプリケーションが Account Activity Replay API から送信されたイベントの取り込みに失敗した場合は、同じ期間を対象とする別の Replay ジョブを送信して、取り逃した Replay イベントの再配信を試みることができます。
**部分的成功 (partial success) の完了イベントを受け取った場合、どうすればよいですか？**
受信できたイベントのタイムスタンプを控え、受信できなかったイベントに対して別の Replay ジョブをリクエストすることをお勧めします。
**同時に実行できる Account Activity Replay API ジョブはいくつまでですか？**
1 つの webhook につき同時に実行できる Account Activity Replay API ジョブは 1 件のみです。
**Webhook に配信されるイベントについて、Account Activity Replay API のイベントとリアルタイムの本番イベントをどのように区別できますか？**
Account Activity Replay API は常に過去のイベントを配信するため、イベントのタイムスタンプに基づいてリアルタイムの本番イベントと区別できます。
**アプリケーションがドロップまたは取り逃したアクティビティを再配信するために、どのくらい早く Account Activity Replay API を利用し始めることができますか？**
アクティビティは、作成から約 10 分後に再配信が可能になります。
### エラーのトラブルシューティングガイド
#### Code 32
このエラーは一般的に、指定しているリクエスト、ヘッダー、認可、または URL のいずれかの形式が不正であることを意味します。これは Account Activity API 固有のエラーではなく、認可エラーであり、X が適切な OAuth 設定や URL を受け取れていない状態です。
* **Enterprise** - 使用しているコンシューマーキーとアクセストークンが、Enterprise 製品の利用のために登録されている [X app](/ja/resources/fundamentals/developer-apps) に属していることを確認してください。コンシューマーキーやアクセストークンをお持ちでない場合、または X app を allowlist (許可リスト) に追加する必要がある場合は、アカウントマネージャーまでお問い合わせください。
* ユーザーコンテキストで認証している場合は、`oauth_nonce`、`oauth_signature`、`oauth_timestamp` を含めて、[リクエストを正しく認可](/ja/resources/fundamentals/authentication#authorizing-a-request) していることを確認してください。
* アクセストークンに適切な権限レベルが付与されていることを確認してください。
* [app dashboard](/ja/resources/fundamentals/developer-apps) の「Keys and tokens」タブで、アクセストークンの[権限レベル](/ja/resources/fundamentals/developer-apps#app-permissions)が「Read, write, and direct messages」になっていることを確認してください。
* トークンの権限レベルがこれより低く設定されている場合は、「Permissions」タブに移動し、アクセス権限を「Read, write, and direct messages」に変更してから、「Keys and tokens」タブでアクセストークンとシークレットを再生成してください。
* URL が正しい形式で構成されていることを確認してください。
* `:env_name` は大文字と小文字を区別する点に注意してください。
#### Code 200 - Forbidden
* **Premium** - API にリクエストを送信する前に、承認済みの[開発者アカウント](/ja/resources/fundamentals/developer-portal)を持っていることを確認してください。また、リクエスト内で適切な :env\_name を使用する必要があります。これは [dev environments](/ja/resources/fundamentals/developer-portal) ページで設定できます。
* **Enterprise** - アカウントマネージャーが、Account Activity API へのアクセス権を付与していることを確認してください。
* URI を正しく設定していることを確認してください。リクエストで誤った URI を指定している場合、このエラーが発生する可能性があります。
#### コード 214 - webhook URL が要件を満たしていません。
* HTTPS を使用していることを確認してください。
* webhook URL が正しい形式になっているか確認してください。
* webhook URL の設定方法については、[Getting started with webhooks](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#getting-started-with-webhooks) ページの [Develop webhook consumer app](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#3-develop-webhook-consumer-app) セクションを参照してください。
#### Code 214 - CRC GET リクエストでレイテンシーが高い状態です。Webhook は 3 秒以内に応答する必要があります。
* これは、サーバーの処理が遅いことを意味します。CRC に 3 秒以内に応答していることを確認してください。
#### コード 214 - CRC GET リクエスト中の 200 以外のレスポンスコード (例: 404、500 など)
* サーバーがダウンしている可能性があります。サーバーが正常に稼働していることを確認してください。
#### コード 214 - 作成済みリソースが多すぎます。
* **Enterprise** - すでに利用可能な webhook をすべて使い切っています。登録済みの各 App について [GET webhooks](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#get-account-activity-webhooks) エンドポイントを使用し、webhook がどこに割り当てられているかを特定してください。
#### Code 261 - アプリケーションは書き込み操作を実行できません。
* 使用している API 用の App のアクセス トークンおよびアクセス トークンシークレットに、適切な[権限レベル](/ja/resources/fundamentals/developer-apps#app-permissions)が設定されていません。[X apps](/ja/resources/fundamentals/developer-apps) ダッシュボードの「Keys and tokens」タブに移動し、アクセス トークンおよびアクセス トークンシークレットに割り当てられている権限レベルを確認してください。これが 'Read, write and Direct Messages' 以外に設定されている場合は、「Permission」タブで設定を変更し、新しい設定を反映させるためにアクセス トークンおよびアクセス トークンシークレットを再生成する必要があります。
* 別の可能性として、サポートされていない app-only 認証を使用して webhook を登録しようとしている場合があります。その場合は、[Enterprise Account Activity API](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#post-account-activity-webhooks) の webhook 登録に関する APIリファレンスのセクションに記載されているとおり、代わりにユーザーコンテキストで認証してください。
## Account Activity API リファレンスインデックス
| | |
| :------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **用途** | エンタープライズ |
| webhook URL を登録する / webhook\_id を生成する | [POST
webhooks](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#enterprise-account-activity-api) |
| すべての webhook URL とそのステータスを返す | [GET
webhooks](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#get-account-activity-webhooks) |
| チャレンジレスポンスチェックを手動でトリガーする | [PUT
webhooks/:webhook\_id](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#put-account-activity-webhooks-webhook-id) |
| アプリケーションをアカウントのイベントにサブスクライブさせる | [POST
webhooks/:webhook\_id/subscriptions/all](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#post-account-activity-webhooks-webhook-id-subscriptions-all) |
| 現在アクティブなサブスクリプション数を返す | [GET
subscriptions/count](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#get-account-activity-subscriptions-count) |
| webhook がアカウントに対してサブスクライブされているか確認する | [GET
webhooks/:webhook\_id/subscriptions/all](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#get-account-activity-webhooks-webhook-id-subscriptions-all) |
| 現在アクティブなサブスクリプションのリストを返す | [GET
webhooks/:webhook\_id/subscriptions/all/list](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#get-account-activity-subscriptions-count) |
| webhook を削除する | [DELETE
webhooks/:webhook\_id](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#delete-account-activity-webhooks-webhook-id) |
| 3-legged OAuth を使用してサブスクリプションを無効化する (非推奨) | [DELETE
webhooks/:webhook\_id/subscriptions/all](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#delete-account-activity-webhooks-webhook-id-subscriptions-all-deprecated) |
| application-only OAuth を使用してサブスクリプションを無効化する | [DELETE
webhooks/:webhook\_id/subscriptions/:user\_id/all.json](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#delete-account-activity-webhooks-webhook-id-subscriptions-user-id-all-json) |
| アクティビティを webhook に再配信する | [POST
replay/webhooks/:webhook\_id/subscriptions/all](/ja/x-api/enterprise-gnip-2.0/fundamentals/account-activity#delete-account-activity-webhooks-webhook-id-subscriptions-all-deprecated) |
### エンタープライズアカウントアクティビティAPI
#### POST account\_activity/webhooks[](#post-account-activity-webhooks "Permalink to this headline")
指定されたアプリケーションコンテキストに対して、新しい webhook URL を登録します。保存前に、URL は CRC リクエストによって検証されます。検証に失敗した場合は、リクエスト送信者に詳細なエラーメッセージを返します。
許可される webhook の数は、課金パッケージによって決まります。
### リソース URL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :----------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Response Format | JSON |
| Requires Authentication | はい (ユーザーコンテキスト：すべてのコンシューマートークンおよびアクセストークン) |
| Rate Limited | はい |
| Requests / 15-min window (user auth) | 15 |
| Support for Tweet edits | すべての Tweet オブジェクトには、その Tweet の編集履歴を示す Tweet 編集メタデータが含まれます。詳細については、[「Tweet edits」の基本](/ja/x-api/enterprise-gnip-2.0/fundamentals/edit-tweets) ページを参照してください。 |
### パラメータ[](#parameters "Permalink to this headline")
| | |
| :------- | :--------------------------- |
| url (必須) | コールバック用エンドポイントのエンコードされた URL。 |
### リクエスト例[](#example-request "Permalink to this headline")
\$ curl --request POST
\--url '[https://api.x.com/1.1/account\_activity/webhooks.json?url=https%3A%2F%2Fyour\_domain.com%2Fwebhooks%2Ftwitter%2F0\'](https://api.x.com/1.1/account\_activity/webhooks.json?url=https%3A%2F%2Fyour\_domain.com%2Fwebhooks%2Ftwitter%2F0\');
\--header 'authorization: OAuth oauth\_consumer\_key="CONSUMER\_KEY", oauth\_nonce="GENERATED", oauth\_signature="GENERATED", oauth\_signature\_method="HMAC-SHA1", oauth\_timestamp="GENERATED", oauth\_token="ACCESS\_TOKEN", oauth\_version="1.0"'
### HTTPレスポンス[](#http-responses "Permalink to this headline")
| HTTP Code | メッセージ |
| :-------- | :---------------------------------------- |
| 200 | Webhook URL が指定されたアプリケーションに登録されています |
| 403 | リクエストにエラーがあります。以下のエラーメッセージセクションを参照してください。 |
### レスポンス例 - 成功時[](#example-response-success "Permalink to this headline")
```json theme={null}
_HTTP 200_
{
"id": "1234567890",
"url": "https://your_domain.com/webhook/twitter/0",
"valid": true,
"created_at": "2016-06-02T23:54:02Z"
}
```
### エラーメッセージ[](#error-messages "Permalink to this headline")
| Code | Message |
| :--- | :--------------------------------------------------------------- |
| 214 | Webhook URL が要件を満たしていません。 |
| 214 | 既に作成済みのリソースが多すぎます。 |
| 214 | Webhook URL が要件を満たしていません。CRC トークンが無効であるか、JSON レスポンスの形式が正しくありません。 |
| 214 | CRC GET リクエストのレイテンシが高すぎます。Webhook は 3 秒未満で応答する必要があります。 |
| 214 | CRC GET リクエスト中に 200 以外のレスポンスコード (例：404、500 など) が返されました。 |
*HTTP 403*
```json theme={null}
{
"errors": [
{
"code": 214,
"message": "Too many resources already created."
}
]
}
```
#### GET account\_activity/webhooks[](#get-account-activity-webhooks "Permalink to this headline")
指定されたアプリケーションに対するすべての URL とそのステータスを返します。
URL が日次の検証チェックに失敗した場合、その URL は無効としてマークされます。URL を再度有効にするには、update エンドポイントを呼び出してください。
### リソースURL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :------------------------- | :----------------------- |
| レスポンス形式 | JSON |
| 認証が必要 | はい (アプリケーションのみ・ベアラートークン) |
| レート制限 | あり |
| 15分あたりのリクエスト数 (アプリケーション認証) | 15 |
### リクエスト例[](#example-request "Permalink to this headline")
```bash theme={null}
$ curl --request GET
--url https://api.x.com/1.1/account_activity/webhooks.json
--header 'authorization: Bearer TOKEN'
```
### レスポンス例[](#example-response "Permalink to this headline")
*HTTP 200 OK*
```json theme={null}
[
{
"id": "1234567890",
"url": "https://your_domain.com/webhook/twitter/0",
"valid": true,
"created_at": "2016-06-02T23:54:02Z"
}
{
"id": "2468013579",
"url": "https://your_domain2.com/webhook/twitter/0",
"valid": true,
"created_at": "2016-06-04T22:31:29Z"
}
]
```
### エラーメッセージ[](#error-messages "Permalink to this headline")
| コード | メッセージ |
| :-- | :--------------------- |
| 99 | このリソースにアクセスする権限がありません。 |
#### PUT account\_activity/webhooks/:webhook\_id[](#put-account-activity-webhooks-webhook-id "この見出しへのパーマリンク")
指定した webhook の URL に対してチャレンジレスポンスチェック (challenge response check、CRC) をトリガーします。チェックが成功した場合、204 を返し、その webhook のステータスを `valid` に設定して再度有効化します。
### リソース URL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks/:webhook_id.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :--------------------------- | :----------------------------------------- |
| レスポンス形式 | JSON |
| 認証が必要 | はい (ユーザーコンテキスト - すべてのコンシューマーキーおよびアクセストークン) |
| レート制限あり | はい |
| リクエスト数 / 15 分間ウィンドウ (ユーザー認証) | 15 |
### パラメータ[](#parameters "Permalink to this headline")
| | |
| :--------------- | :------------------------ |
| webhook\_id (必須) | Webhook ID。リソースパスで定義されます。 |
### リクエストの例[](#example-request "Permalink to this headline")
```json theme={null}
$ curl --request PUT
--url https://api.x.com/1.1/account_activity/webhooks/:WEBHOOK_ID.json
--header 'authorization: OAuth oauth_consumer_key="CONSUMER_KEY", oauth_nonce="GENERATED", oauth_signature="GENERATED", oauth_signature_method="HMAC-SHA1", oauth_timestamp="GENERATED", oauth_token="ACCESS_TOKEN", oauth_version="1.0"'
```
### レスポンス[](#response "Permalink to this headline")
*HTTP 204 OK*
```
{ }
```
### エラーメッセージ[](#error-messages "Permalink to this headline")
| Code | メッセージ |
| :--- | :---------------------------------------------------------- |
| 34 | Webhook が存在しないか、別の X アプリケーションに関連付けられています。 |
| 214 | Webhook URL が要件を満たしていません。 |
| 214 | Webhook URL が要件を満たしていません。CRC トークンが無効であるか、JSON レスポンス形式が不正です。 |
| 214 | CRC GET リクエストのレイテンシーが高すぎます。Webhook は 3 秒未満で応答する必要があります。 |
| 214 | CRC GET リクエスト時に 200 以外のレスポンスコードが返されました (例: 404、500 など)。 |
#### POST account\_activity/webhooks/:webhook\_id/subscriptions/all[](#post-account-activity-webhooks-webhook-id-subscriptions-all "この見出しへのパーマリンク")
指定したユーザーコンテキストについて、すべてのメッセージ種別に関するすべてのイベントを、指定したアプリケーションに配信するよう登録します。有効化後は、リクエストしたユーザーに関するすべてのイベントが、POST リクエストを通じてアプリケーションの webhook に送信されます。
サブスクリプション数は現在、ご利用のアカウント設定に基づき制限されています。さらにサブスクリプションを追加する必要がある場合は、担当のアカウントマネージャーまでお問い合わせください。
### リソースURL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks/:webhook_id/subscriptions/all.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :--------------------------- | :---------------------------------------------------------- |
| レスポンス形式 | JSON |
| 認証が必要 | はい (3-legged OAuth - ホワイトリスト登録されたコンシューマーキーと購読ユーザーのアクセストークン) |
| レート制限 | あり |
| リクエスト数 / 15分間のウィンドウ (ユーザー認証) | 500 |
### パラメータ[](#parameters "Permalink to this headline")
| | |
| :--------------- | :-------------------------- |
| webhook\_id (必須) | Webhook の id。リソースパスで定義されます。 |
### サンプルリクエスト[](#example-request "Permalink to this headline")
```bash theme={null}
$ curl --request POST
--url https://api.x.com/1.1/account_activity/webhooks/:WEBHOOK_ID/subscriptions/all.json
--header 'authorization: OAuth oauth_consumer_key="WHITELISTED_CONSUMER_KEY", oauth_nonce="GENERATED", oauth_signature="GENERATED", oauth_signature_method="HMAC-SHA1", oauth_timestamp="GENERATED", oauth_token="SUBSCRIBING_USER'S_ACCESS_TOKEN", oauth_version="1.0"'
```
### レスポンス例 - 成功時[](#example-response-success "Permalink to this headline")
*HTTP 204 NO CONTENT*
```
{}
```
### エラーメッセージ[](#error-messages "Permalink to this headline")
| コード | メッセージ |
| :-- | :------------------------------------------------------- |
| 34 | webhook が存在しないか、別の X アプリケーションに関連付けられています。 |
| 348 | クライアントアプリケーションには、このユーザーの webhook サブスクリプションへのアクセス権がありません。 |
#### GET account\_activity/subscriptions/count[](#get-account-activity-subscriptions-count "Permalink to this headline")
あなたのアカウントで現在アクティブなサブスクリプション数を返します。`/count` エンドポイントにはアプリケーション専用の OAuth 認証が必要なため、ユーザーコンテキストではなくベアラートークンを使用してリクエストを行う必要があります。
### リソース URL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/subscriptions/count.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :------------------------------- | :----------------------- |
| レスポンス形式 | HTTP レスポンスコード |
| 認証が必要 | はい (App-only - ベアラートークン) |
| レート制限 | あり |
| リクエスト数 / 15 分間ウィンドウ (アプリケーション認証) | 15 |
### HTTP レスポンスコード[](#http-response-codes "Permalink to this headline")
| | |
| :--- | :------------------------------------------- |
| Code | Message |
| 200 | 成功。要求された webhook に対するサブスクリプション数が返されます。 |
| 401 | 指定された webhook のサブスクリプションを閲覧する権限が App にありません。 |
### リクエスト例[](#example-request "Permalink to this headline")
```bash theme={null}
$ curl --request GET
--url https://api.x.com/1.1/account_activity/subscriptions/count.json
--header 'authorization: Bearer TOKEN'
```
### 成功時のレスポンス例[](#example-response-success "Permalink to this headline")
*HTTP 200*
```bash theme={null}
{
"account_name":"my-account",
"subscriptions_count_all":"1",
"subscriptions_count_direct_messages":"0",
"provisioned_count":"50"
}
```
### エラーメッセージ[](#error-messages "この見出しへのパーマリンク")
| Code | Message |
| :--- | :--------- |
| 32 | 認証に失敗しました。 |
*HTTP 401*
```abash theme={null}
{
"errors": [
{
"code": 32,
"message": "Could not authenticate you."
}
]
}
```
#### GET account\_activity/webhooks/:webhook\_id/subscriptions/all[](#get-account-activity-webhooks-webhook-id-subscriptions-all "Permalink to this headline")
指定したユーザーのイベントに対して、ある webhook 設定がサブスクライブされているかどうかを判定する手段を提供します。指定したユーザーコンテキストが、指定したアプリケーションで有効なサブスクリプションを持っている場合は、204 OK を返します。レスポンスコードが 204 でない場合、そのユーザーには有効なサブスクリプションがありません。詳細については、以下の HTTP レスポンスコードおよびエラーメッセージを参照してください。
### リソースURL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks/:webhook_id/subscriptions/all.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :-------------------------- | :---------------------------------------------------------- |
| レスポンス形式 | JSON |
| 認証が必要 | はい (3-legged OAuth - ホワイトリスト登録済みコンシューマーキーと購読ユーザーのアクセス・トークン) |
| レート制限 | はい |
| リクエスト数 / 15分間ウィンドウ (ユーザー認証) | 500 |
### パラメーター[](#parameters "Permalink to this headline")
| | |
| :--------------------- | :------------------------ |
| webhook\_id (required) | Webhook ID。リソースパスで定義されます。 |
### リクエスト例[](#example-request "この見出しへのパーマリンク")
\$ curl --request GET
\--url [https://api.x.com/1.1/account\_activity/webhooks/:WEBHOOK\_ID/subscriptions/all.json](https://api.x.com/1.1/account\_activity/webhooks/:WEBHOOK\_ID/subscriptions/all.json)
\--header 'authorization: OAuth oauth\_consumer\_key="WHITELISTED\_CONSUMER\_KEY", oauth\_nonce="GENERATED", oauth\_signature="GENERATED", oauth\_signature\_method="HMAC-SHA1", oauth\_timestamp="GENERATED", oauth\_token="SUBSCRIBING\_USER'S\_ACCESS\_TOKEN", oauth\_version="1.0"'
### サンプルレスポンス - 成功時[](#example-response-success "Permalink to this headline")
*HTTP 204 NO CONTENT*
```
{ }
```
#### GET account\_activity/webhooks/:webhook\_id/subscriptions/all/list[](#get-account-activity-webhooks-webhook-id-subscriptions-all-list "Permalink to this headline")
指定された webhook に対する、現在有効な All Activity タイプのサブスクリプションのリストを返します。/list エンドポイントではアプリケーション専用の OAuth が必要なため、リクエストはユーザーコンテキストではなくベアラートークンを使用して行う必要があります。
### リソース URL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks/:webhook_id/subscriptions/all/list.json`
### リソース情報[](#resource-information "この見出しへのパーマリンク")
| | |
| :------------------------------- | :--------------------------- |
| レスポンス形式 | HTTP レスポンスコード |
| 認証が必要 | はい (アプリケーション認証のみ - ベアラートークン) |
| レート制限 | はい |
| リクエスト数 / 15 分間ウィンドウ (アプリケーション認証) | 50 |
### パラメーター[](#parameters "Permalink to this headline")
| | |
| :--------------------- | :-------------------------- |
| webhook\_id (required) | Webhook の ID。リソースパスで定義されます。 |
### HTTP Response Codes[](#http-response-codes "Permalink to this headline")
| Code | Message |
| :--- | :---------------------------------------------------- |
| 200 | 成功。指定された webhook のサブスクリプション リストが返されます。 |
| 401 | ご利用のアプリケーションには、指定された webhook のサブスクリプションを表示する権限がありません。 |
### リクエスト例[](#example-request "この見出しへのパーマリンク")
\$ curl --request GET
\--url [https://api.x.com/1.1/account\_activity/webhooks/:WEBHOOK\_ID/subscriptions/all/list.json](https://api.x.com/1.1/account\_activity/webhooks/:WEBHOOK\_ID/subscriptions/all/list.json)
\--header 'authorization: Bearer TOKEN'
### レスポンス例 - 成功時[](#example-response-success "Permalink to this headline")
*HTTP 200*
```bash theme={null}
{
"webhook_id": "1234567890",
"webhook_url": "https://your_domain.com/webhook/twitter/0",
"application_id": "11231812",
"subscriptions": [{
"user_id": "20212306"
}]
}
```
### エラーメッセージ[](#error-messages "Permalink to this headline")
| Code | Message |
| :--- | :--------- |
| 32 | 認証に失敗しました。 |
*HTTP 401*
```bash theme={null}
{
"errors": [
{
"code": 32,
"message": "Could not authenticate you."
}
]
}
```
#### DELETE account\_activity/webhooks/:webhook\_id[](#delete-account-activity-webhooks-webhook-id "この見出しへのパーマリンク")
指定されたアプリケーションの設定から Webhook を削除します。Webhook ID は、GET /1.1/account\_activity/webhooks エンドポイントを呼び出すことで取得できます。
### リソース URL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks/:webhook_id.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :--------------------------- | :--------------------------------------- |
| レスポンス形式 | JSON |
| 認証が必要 | はい (ユーザーコンテキスト - すべてのコンシューマーおよびアクセストークン) |
| レート制限 | あり |
| リクエスト数 / 15 分間ウィンドウ (ユーザー認証) | 15 |
### パラメータ[](#parameters "Permalink to this headline")
| | |
| :--------------------- | :-------------------------- |
| webhook\_id (required) | Webhook の識別子。リソースパスで定義されます。 |
### リクエスト例[](#example-request "Permalink to this headline")
```bash theme={null}
$ curl --request DELETE
--url https://api.x.com/1.1/account_activity/webhooks/:WEBHOOK_ID.json
--header 'authorization: OAuth oauth_consumer_key="CONSUMER_KEY", oauth_nonce="GENERATED", oauth_signature="GENERATED", oauth_signature_method="HMAC-SHA1", oauth_timestamp="GENERATED", oauth_token="ACCESS_TOKEN", oauth_version="1.0"'
```
### レスポンス[](#response "Permalink to this headline")
*HTTP 204 OK*
```
{ }
```
#### DELETE account\_activity/webhooks/:webhook\_id/subscriptions/all (非推奨)[](#delete-account-activity-webhooks-webhook-id-subscriptions-all-deprecated- "Permalink to this headline")
指定されたユーザーコンテキストとアプリケーションに対するサブスクリプションを無効化します。無効化後は、リクエスト元ユーザーに関するすべてのイベントは、webhook URL に送信されなくなります。
### リソース URL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks/:webhook_id/subscriptions/all.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :------------------------- | :---------------------------------------------------------- |
| レスポンス形式 | JSON |
| 認証が必要 | はい (3-legged OAuth - ホワイトリスト登録済みのコンシューマーキーと購読ユーザーのアクセストークン) |
| レート制限 | あり |
| リクエスト数 / 15分ウィンドウ (ユーザー認証) | 500 |
### パラメータ[](#parameters "Permalink to this headline")
| | |
| :--------------------- | :------------------------ |
| webhook\_id (required) | Webhook ID。リソースパスで定義されます。 |
### リクエスト例[](#example-request "Permalink to this headline")
```bash theme={null}
$ curl --request DELETE
--url https://api.x.com/1.1/account_activity/webhooks/:WEBHOOK_ID/subscriptions/all.json
--header 'authorization: OAuth oauth_consumer_key="WHITELISTED_CONSUMER_KEY", oauth_nonce="GENERATED", oauth_signature="GENERATED", oauth_signature_method="HMAC-SHA1", oauth_timestamp="GENERATED", oauth_token="SUBSCRIBED_USER'S_ACCESS_TOKEN", oauth_version="1.0"'
```
リクエスト例
```
{ }
```
#### DELETE /account\_activity/webhooks/:webhook\_id/subscriptions/:user\_id/all.json[](#delete-account-activity-webhooks-webhook-id-subscriptions-user-id-all-json "Permalink to this headline")
指定された webhook とユーザーidに対するサブスクリプションを無効化します。無効化後、リクエストを行ったユーザーに関するすべてのイベントは、webhook の URL には送信されなくなります。なお、このエンドポイントはアプリケーション専用 OAuth が必要となるため、リクエストはユーザーコンテキストではなくベアラートークンを使用して行う必要があります。
### リソース URL[](#resource-url "Permalink to this headline")
`https://api.x.com/1.1/account_activity/webhooks/:webhook_id/subscriptions/:user_id/all.json`
### リソース情報[](#resource-information "Permalink to this headline")
| | |
| :------------- | :------------------------- |
| レスポンス形式 | JSON |
| 認証が必要 | はい (アプリケーションのみ - ベアラートークン) |
| レート制限 | あり |
| 15分間あたりのリクエスト数 | 500 |
### リクエスト例[](#example-request "Permalink to this headline")
```bash theme={null}
$ curl --request DELETE
--url https://api.x.com/1.1/account_activity/webhooks/:webhook_id/subscriptions/:user_id/all.json
--header 'authorization: Bearer TOKEN'
```
### レスポンス[](#response "Permalink to this headline")
*HTTP 204 NO CONTENT*
### エラーメッセージ[](#error-messages "Permalink to this headline")
| Code | Message |
| :--- | :--------------------------------------------------------------- |
| 404 | 申し訳ありません。そのページは存在しません。- 指定されたユーザー id が実際には購読対象になっていない場合によく発生します。 |
### Replay API
**POST /1.1/account\_activity/replay/webhooks/:webhook\_id/subscriptions/all.json [¶](#post-1-1-account-activity-replay-webhooks-webhook-id-subscriptions-all-json- "Permalink to this headline")**
リクエストで指定された日時のウィンドウ内に存在していたすべてのサブスクリプションについて、過去最大5日分のアクティビティを取得するリクエストを送信します。Webhook にアクティブなユーザーサブスクリプションがある場合、それらのイベントも同時に受信します。注記: Replay イベントを配信する前に CRC を実行します。
| | |
| :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Request Method** | HTTP POST |
| **URL** | /1.1/account\_activity/replay/webhooks/:webhook\_id/subscriptions/all.json?from\_date=yyyymmddhhmm\&to\_date=yyyymmddhhmm |
| **Response Format** | JSON |
| **Requires Authentication** | Yes (application only - ベアラートークン) |
| **Rate Limit** | 15分あたり5リクエスト。現在、リクエスト可能な Replay ジョブ数の上限はありません。 |
| **from\_date** | イベントが提供される最も古い (開始) UTC タイムスタンプで、'yyyymmddhhmm' 形式で指定する必要があります。タイムスタンプは分単位の粒度で、包括的です (例: 12:00 は 00 分を含みます) 。有効な時刻は、過去5日以内の UTC 時刻であり、現在時刻より31分以上前である必要があります。from\_date と to\_date はおおよそ2時間以内に収まるようにすることを推奨します。 |
| **to\_date** | イベントが提供される最新 (終了) の UTC タイムスタンプで、'yyyymmddhhmm' 形式で指定する必要があります。タイムスタンプは分単位の粒度で、排他的です (例: 12:30 はその時間の30分を含みません) 。有効な時刻は、過去5日以内の UTC 時刻であり、現在時刻より10分以上前である必要があります。 |
#### レスポンス
API からは次のレスポンスが返される可能性があります。ほとんどのエラーコードでは、ボディに追加の詳細を含む文字列が返されます。200 以外のステータスコードのレスポンスの場合は、エラーを解消してから再試行してください。
| Status | Text | Error Code | Description | Message |
| :----- | :-------------------- | :--------- | :---------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |
| 202 | Accepted | N/A | リクエストは成功し、アクティビティが送信されます。 | N/A |
| 400 | Bad Request | 214 | Webhook が無効としてマークされています。 | Webhook は無効とマークされており、CRC チェックが必要です。 |
| 400 | Bad Request | 357 | クエリパラメーターが不足しています。 | : queryParam が必須です。 |
| 400 | Bad Request | 358 | ルートまたはクエリパラメーターの形式が正しくありません。 | パラメーターを解析できません。 |
| 400 | Bad Request | 360 | ルートパラメーターが負の値です。 | webhook\_id: \[] は 0 以上ではありません。 |
| 400 | Bad Request | 368 | from\_date または to\_date が過去の日付ではありません。 | : \[\] は過去の日付ではありません。 |
| 400 | Bad Request | 356 | from\_date は to\_date より前でなければなりません。 | from\_date は to\_date より前でなければなりません。 |
| 400 | Bad Request | 356 | from\_date は過去 5 日以内でなければなりません。 | from\_date は過去 5 日以内でなければなりません。 |
| 401 | Unauthorized | 32 | 3-legged 認証が提供されたため、HTTP 認証に失敗しました。 | 認証方法が無効です。application-only 認証を使用してください。 |
| 401 | Unauthorized | 61 | Client にはこのメソッドをリクエストする権限がありません。 | Client にはこのメソッドをリクエストする権限がありません。 |
| 403 | Forbidden | 200 | Client に Replay が有効なエンタープライズアカウントがありません。 | Replay が有効な Account Activity API エンタープライズアカウントが必要です。エンタープライズアカウントを保有し、Replay が有効になっていることを確認してください。 |
| 404 | Not Found | 34 | 存在しない webhook\_id、または webhook\_id と application\_id の不一致です。 | Webhook が存在しないか、別の X アプリケーションに関連付けられています。 |
| 409 | Conflict | 355 | 進行中のリクエストがあり、別のリクエストを行う前にその処理が完了する必要があります。 | この Webhook に対する Replay ジョブがすでに進行中です。 |
| 429 | Too Many Requests | 88 | レート制限に達しました (一定時間あたりのリクエスト数の上限に到達) 。 | リクエストが多すぎます。API リクエストレートを下げてください。 |
| 500 | Internal Server Error | 0 | 内部サーバーエラーです。 | 内部サーバーエラーです。 |
| 503 | Service Unavailable | 67 | X 上の 1 つ以上の依存サービスが利用できません。 | X サーバーエラーです。指数バックオフ方式で再試行してください。 |
#### "Job completed successfully” メッセージ
ジョブが正常に完了すると、Account Activity Replay API は次のジョブ完了イベントを送信します。このイベントを受信した時点で、そのジョブの実行は終了しており、新たに別のジョブを送信できます。
```json theme={null}
{
"replay\_job\_status": {
"webhook_id": "1234577122340233217",
"job_state": "Complete",
"job\_state\_description": "Job completed successfully"
"job_id": "1095098195724558337"
}
}
```
#### "ジョブが完了しませんでした" メッセージ
ジョブが正常に完了しなかった場合、Replay ジョブの再試行を促すために、次のメッセージを返します。このイベントを受信した時点で、そのジョブの実行は終了しており、別のジョブを送信できます。
```json theme={null}
{
"replay\_job\_status": {
"webhook_id": "123451374207332352",
"job_state": "Incomplete",
"job\_state\_description": "Job failed to deliver all events, please retry your replay job",
"job_id": "1093226942650736640"
}
}
```
#### curl のリクエスト例
```bash theme={null}
curl --request POST --url 'https://api.x.com/1.1/account_activity/replay/webhooks/:webhook_id/subscriptions/all.json?from_date=yyyymmddhhmm&to_date=yyyymmddhhmm'
--header 'authorization: Bearer TOKEN'
```
#### レスポンス例
HTTP 202
```bash theme={null}
{
"job_id": "1234567890",
"created_at": "2016-06-02T23:54:02Z"
}
```