> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# クイックスタート

> フィルター済みストリームに接続して、リアルタイムで投稿を受信する

export const Button = ({href, children}) => {
  return <div className="not-prose group">
    <a href={href}>
      <button className="flex items-center space-x-2.5 py-1 px-4 bg-primary-dark dark:bg-white text-white dark:text-gray-950 rounded-full group-hover:opacity-[0.9] font-medium">
        <span>
          {children}
        </span>
        <svg width="3" height="24" viewBox="0 -9 3 24" class="h-6 rotate-0 overflow-visible"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg>
      </button>
    </a>
  </div>;
};

このガイドでは、フィルタリングされたストリームに接続し、フィルタルールに一致する投稿をリアルタイムで受信する方法を説明します。

<Note>
  **前提条件**

  作業を始める前に、次のものを用意してください。

  * [開発者アカウント](https://developer.x.com/en/portal/petition/essential/basic-info)
  * App のベアラートークン (開発者コンソールの「Keys and tokens」で確認できます)
</Note>

***

<Steps>
  <Step title="フィルタールールを作成する" icon="filter">
    ルールは、どの投稿を受信するかを決めます。演算子を使用して、キーワード、ハッシュタグ、ユーザーなどにマッチさせます。

    **ルールの例:** 「cat」を含み、画像付きの投稿にマッチさせる:

    ```
    cat has:images
    ```

    <Card title="ルールを作成する" icon="filter" href="/ja/x-api/posts/filtered-stream/integrate/build-a-rule">
      ルールの構文と演算子を学ぶ
    </Card>
  </Step>

  <Step title="ストリームにルールを追加する" icon="plus">
    ルールエンドポイントを使用してルールを追加します。どのルールが各ポストに一致したかを特定できるように、`tag` を含めてください。

    <CodeGroup dropdown>
      ```bash cURL theme={null}
      curl -X POST "https://api.x.com/2/tweets/search/stream/rules" \
        -H "Authorization: Bearer $BEARER_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
          "add": [
            {"value": "cat has:images", "tag": "cats with images"}
          ]
        }'
      ```

      ```python Python SDK theme={null}
      from xdk import Client

      client = Client(bearer_token="YOUR_BEARER_TOKEN")

      # フィルタリングされたストリームにルールを追加
      response = client.filtered_stream.add_rules(
          add=[{"value": "cat has:images", "tag": "cats with images"}]
      )

      for rule in response.data:
          print(f"Rule added: {rule.id} - {rule.value}")
      ```

      ```javascript JavaScript SDK theme={null}
      import { Client } from "@xdevplatform/xdk";

      const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

      # フィルタリングされたストリームにルールを追加
      const response = await client.filteredStream.addRules({
        add: [{ value: "cat has:images", tag: "cats with images" }],
      });

      response.data?.forEach((rule) => {
        console.log(`Rule added: ${rule.id} - ${rule.value}`);
      });
      ```
    </CodeGroup>

    **レスポンス:**

    ```json theme={null}
    {
      "data": [
        {
          "id": "1273026480692322304",
          "value": "cat has:images",
          "tag": "cats with images"
        }
      ],
      "meta": {
        "sent": "2024-01-15T10:30:00.000Z",
        "summary": {
          "created": 1,
          "not_created": 0,
          "valid": 1,
          "invalid": 0
        }
      }
    }
    ```
  </Step>

  <Step title="ルールを検証する" icon="check">
    追加したルールを確認するため、すべてのアクティブなルールを一覧表示します：

    <CodeGroup dropdown>
      ```bash cURL theme={null}
      curl "https://api.x.com/2/tweets/search/stream/rules" \
        -H "Authorization: Bearer $BEARER_TOKEN"
      ```

      ```python Python SDK theme={null}
      from xdk import Client

      client = Client(bearer_token="YOUR_BEARER_TOKEN")

      # すべてのアクティブなルールを取得
      response = client.filtered_stream.get_rules()

      for rule in response.data:
          print(f"Active rule: {rule.id} - {rule.value}")
      ```

      ```javascript JavaScript SDK theme={null}
      import { Client } from "@xdevplatform/xdk";

      const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

      // すべてのアクティブなルールを取得
      const response = await client.filteredStream.getRules();

      response.data?.forEach((rule) => {
        console.log(`Active rule: ${rule.id} - ${rule.value}`);
      });
      ```
    </CodeGroup>
  </Step>

  <Step title="ストリームに接続する" icon="plug">
    マッチする投稿を受信するための永続的な接続を確立します:

    <CodeGroup dropdown>
      ```bash cURL theme={null}
      curl "https://api.x.com/2/tweets/search/stream?\
      tweet.fields=created_at,author_id&\
      expansions=author_id&\
      user.fields=username" \
        -H "Authorization: Bearer $BEARER_TOKEN"
      ```

      ```python Python SDK theme={null}
      from xdk import Client

      client = Client(bearer_token="YOUR_BEARER_TOKEN")

      # フィルタ済みストリームに接続
      for post in client.filtered_stream.stream(
          tweet_fields=["created_at", "author_id"],
          expansions=["author_id"],
          user_fields=["username"]
      ):
          print(f"New post: {post.data.text}")
          print(f"Matching rules: {post.matching_rules}")
      ```

      ```javascript JavaScript SDK theme={null}
      import { Client } from "@xdevplatform/xdk";

      const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

      # フィルタ済みストリームに接続
      const stream = client.filteredStream.stream({
        tweetFields: ["created_at", "author_id"],
        expansions: ["author_id"],
        userFields: ["username"],
      });

      for await (const post of stream) {
        console.log(`New post: ${post.data?.text}`);
        console.log(`Matching rules: ${post.matching_rules}`);
      }
      ```
    </CodeGroup>
  </Step>

  <Step title="受信した投稿の処理" icon="message">
    一致した投稿ストリーム (JSONオブジェクト) :

    ```json theme={null}
    {
      "data": {
        "id": "1234567890",
        "text": "Look at this cute cat! 🐱",
        "author_id": "9876543210",
        "created_at": "2024-01-15T10:35:00.000Z",
        "edit_history_tweet_ids": ["1234567890"]
      },
      "includes": {
        "users": [
          {
            "id": "9876543210",
            "username": "catperson"
          }
        ]
      },
      "matching_rules": [
        {
          "id": "1273026480692322304",
          "tag": "cats with images"
        }
      ]
    }
    ```

    <Tip>
      `matching_rules` 配列には、定義したタグに基づいて、どのルールがそのポストにマッチしたかが示されます。
    </Tip>
  </Step>

  <Step title="ルールを削除（任意）" icon="trash">
    ID を指定してルールを削除します：

    <CodeGroup dropdown>
      ```bash cURL theme={null}
      curl -X POST "https://api.x.com/2/tweets/search/stream/rules" \
        -H "Authorization: Bearer $BEARER_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
          "delete": {
            "ids": ["1273026480692322304"]
          }
        }'
      ```

      ```python Python SDK theme={null}
      from xdk import Client

      client = Client(bearer_token="YOUR_BEARER_TOKEN")

      # ID を指定してルールを削除
      response = client.filtered_stream.delete_rules(
          delete={"ids": ["1273026480692322304"]}
      )
      print(f"Deleted: {response.meta.summary.deleted}")
      ```

      ```javascript JavaScript SDK theme={null}
      import { Client } from "@xdevplatform/xdk";

      const client = new Client({ bearerToken: "YOUR_BEARER_TOKEN" });

      # ID を指定してルールを削除
      const response = await client.filteredStream.deleteRules({
        delete: { ids: ["1273026480692322304"] },
      });
      console.log(`Deleted: ${response.meta?.summary?.deleted}`);
      ```
    </CodeGroup>
  </Step>
</Steps>

***

<div id="managing-your-connection">
  ## 接続の管理
</div>

<AccordionGroup>
  <Accordion title="キープアライブ信号">
    ストリームは 20 秒ごとに空行 (`\r\n`) を送信します。20 秒間、データまたはキープアライブ信号を受信しない場合は、再接続してください。
  </Accordion>

  <Accordion title="切断">
    接続を閉じるには、`Ctrl+C` を押すか、ターミナル ウィンドウを閉じてください。
  </Accordion>

  <Accordion title="接続制限">
    1 つの App につき接続は 1 つだけ許可されます。新しい接続を開くと、既存の接続は閉じられます。
  </Accordion>
</AccordionGroup>

***

<div id="next-steps">
  ## 次のステップ
</div>

<CardGroup cols={2}>
  <Card title="ルールを作成" icon="filter" href="/ja/x-api/posts/filtered-stream/integrate/build-a-rule">
    ルール構文について学ぶ
  </Card>

  <Card title="オペレーターリファレンス" icon="list-check" href="/ja/x-api/posts/filtered-stream/integrate/operators">
    利用可能なすべてのオペレーター
  </Card>

  <Card title="切断時の対応" icon="plug" href="/ja/x-api/posts/filtered-stream/integrate/handling-disconnections">
    スムーズに再接続する
  </Card>

  <Card title="APIリファレンス" icon="code" href="/ja/x-api/posts/filtered-stream">
    エンドポイントの詳細なドキュメント
  </Card>
</CardGroup>