Skip to main content

はじめに

Square Cloud で X (Twitter) ボット を開発してホストするには、構成と前提条件の体系的な手順に従うことが不可欠です。この技術ガイドでは、初期セットアップから本番環境へのデプロイまで、プロセス全体を解説します。

前提条件

  • Square Cloud アカウント: 登録ページからメールアドレスを使って登録します。
  • 有効なプラン: アプリケーションに専用リソースと最適化されたパフォーマンスを提供します。利用可能なプランを確認し、ニーズに最も適したものを選択してください。

プロジェクトの作成

認証とボットの動作には、アクティブな X (Twitter) アカウントが必要です。アカウントをお持ちでない場合は、X 公式サイトで登録してください。
API にアクセスするには、X Developer アカウントも必要です。X Developer Portal からアクセスをリクエストしてください。
X API は従量課金制です。メンションの読み取りや返信の投稿は、ボットによる定期的なメンションの確認も含めて、X の開発者アカウントに課金されます。デプロイする前に、X API の料金ページで最新の料金を確認してください。

X 上でのボットアプリケーション

1

Developer Portal へのアクセス

  1. X Developer Portal にアクセスします。
  2. X (Twitter) アカウントでログインします。
  3. 初めての場合は、開発者アクセスのリクエスト手続きを完了してください。
2

プロジェクトの作成

  1. ダッシュボードで「Create Project」をクリックします。
  2. プロジェクトの名前を選びます(例: 「Square Cloud Bot」)。
  3. 最も適切なユースケースを選択します(例: 「Making a bot」)。
  4. ボットの詳細な説明を入力します。
  5. プロジェクトの作成を確定します。
3

アプリケーションのセットアップ

  1. 作成したプロジェクト内で「Create App」をクリックします。
  2. アプリケーションに一意の名前を定義します。
  3. アプリケーションの作成を確定します。
  4. 生成された App ID を今後の参照用に記録しておきます。
4

API キーの生成

  1. アプリケーションの「Keys and tokens」セクションに移動します。
  2. 「Consumer Keys」セクションで「Regenerate」をクリックして、以下を生成します:
    • API Key (Consumer Key)
    • API Secret Key (Consumer Secret)
  3. 重要: これらのキーは再表示できないため、すぐにコピーして保存してください。
5

権限の設定

  1. 「App permissions」セクションに移動します。
  2. 「Edit」をクリックして権限を変更します。
  3. ボットがツイートを投稿できるように「Read and write」を選択します。
  4. 必要に応じて、DM 機能のために「Read and write and Direct message」を選択します。
  5. 変更を保存します。
6

アクセストークンの生成

  1. 「Keys and tokens」セクションに戻ります。
  2. 「Access Token and Secret」セクションで「Generate」をクリックします。
  3. トークンの生成を確定します。
  4. 以下をコピーして保存します:
    • Access Token
    • Access Token Secret
  5. 警告: これらのトークンはページを閉じた後は再表示できません。
7

認証情報の確認

  1. 必要な 4 つの認証情報がすべて揃っていることを確認します:
    • API Key (Consumer Key)
    • API Secret Key (Consumer Secret)
    • Access Token
    • Access Token Secret
  2. これらの認証情報を安全な場所に保管します
  3. 重要: これらの認証情報を公開したり共有したりしないでください

プロジェクトの開発

  1. Node.js の確認: Node.js がシステムにインストールされていることを確認してください。ない場合は、Node.js 公式サイトからダウンロードしてください。
  2. プロジェクトの初期化: 次のコマンドを実行して、新しい Node.js プロジェクトを作成します:
Terminal
  1. 依存関係のインストール: ボットに必要なライブラリをインストールします:
Terminal
  1. 認証情報: コードは 4 つの認証情報を環境変数から読み込むため、認証情報がコードに入ることはありません。手元のコンピューターでボットをテストするには、認証情報を .env ファイルに入れ、node --env-file=.env index.js でボットを起動します。
.env
Square Cloud はボットの実行時にこのファイルを読み込みません。同じ変数を、認証情報の設定でプラットフォームに設定します。
  1. メインファイルの作成: ボットの基本構造を含む index.js ファイルを作成します:
index.js

Square Cloud の設定

プロジェクトのルートに、index.js と並べて squarecloud.app ファイルを作成します。このファイルは、ボットの実行方法を Square Cloud に伝えます。
squarecloud.app
  • MEMORY はボットの RAM (MB) です。ボットには最低 256 MB が必要で、512 MB あれば成長の余地があります。
  • AUTORESTART=true を指定すると、ボットがクラッシュしたときに再起動します。自動再起動の仕組みを参照してください。
  • SUBDOMAIN はありません。ボットは X API を呼び出すだけで、ウェブページを配信しないためです。
ZIP には index.js、package.json、squarecloud.app を入れます。node_modules と .env ファイルは含めないでください。CLI がスキップするように、squarecloud.ignore ファイルに .env の行を追加します。すべてのフィールドについては設定ファイルのリファレンスを参照してください。

認証情報の設定

セキュリティ: API 認証情報をコードに直接記述しないでください。Square Cloud では必ず環境変数を使用してください。
ボットには 4 つの環境変数が必要です。
  • API_KEY: あなたの X API キー
  • API_SECRET_KEY: あなたの X API シークレットキー
  • ACCESS_TOKEN: あなたのアクセストークン
  • ACCESS_TOKEN_SECRET: あなたのアクセストークンシークレット
次のいずれかの方法で設定します。
  • ダッシュボード: アップロードページで Advanced configuration を開き、4 つの変数を追加します。すでにデプロイ済みのボットの場合は、アプリケーションの Environment Variables ページで追加し、ボットを再起動します。
  • CLI: ボットをアップロードした直後に (デプロイを参照)、squarecloud app env set でローカルの .env ファイルから読み込み、ボットを再起動します。
ボットは起動時に環境変数を読み込むため、変更のたびに再起動してください。その他の管理方法については環境変数を参照してください。

デプロイ

プロジェクトファイルの準備が完了したら、それらを Square Cloud にアップロードしてプロジェクトをホスティングできます。 そのためには、すべてのプロジェクトファイルを含む ZIP ファイルを作成してください。

ダッシュボード経由

1

アップロードページにアクセス

アップロードページにアクセスし、プロジェクトの zip ファイルをアップロードします。
2

環境を設定

zip をアップロードした後、プロジェクトの名前、メインファイルまたはランタイム環境、その他の設定を構成する必要があります。
ウェブプロジェクトをアップロードする場合は、必ず「Web Publication」を選択し、プロジェクトにサブドメインを設定してください。
3

プロジェクトをデプロイ

最後に「Deploy」ボタンをクリックして、プロジェクトを Square Cloud にホストします。
デプロイ後、ダッシュボードからプロジェクトのステータスとログを監視できます。
Square Cloud へのアプリケーションのアップロード
4

アプリが稼働していることを確認

最初のデプロイは、通常 1 分もかからずに完了します。ダッシュボードでアプリケーションのステータスが running になるのを待ち、起動時のエラーがないかログを確認してください。
ウェブサイトや API をデプロイした場合は、ブラウザで https://<your-subdomain>.squareweb.app を開き、アプリケーションが応答することを確認してください。ボットをデプロイした場合は、コマンドを送信してオンラインになっていることを確認してください。
アプリが起動しませんか?よくある原因と修正方法はトラブルシューティングガイドを参照してください。

CLI 経由

この方法を使用するには、プロジェクトのルートに squarecloud.app という名前の設定ファイルが必要です。このファイルは、アプリケーションの実行方法を Square Cloud に伝えます。

設定ファイルガイド

アプリケーションの環境を定義する squarecloud.app 設定ファイルの作成方法を学びます。
1

CLI をインストール

Square Cloud CLI をインストールします。すでにお持ちの場合は、同じコマンドを実行すると更新されます:
2

ログイン

次のコマンドを実行します。ブラウザが開くので、そこでログインを承認すれば CLI の準備は完了です。API キーをコピーする必要はありません。スクリプトや CI については、CLI の認証を参照してください。
3

プロジェクトをアップロード

プロジェクトのフォルダで次のコマンドを実行します。CLI は squarecloud.ignore に記載されたものを除いて現在のフォルダを zip にし、アップロードします:
自分で作成した zip をアップロードするには、--file で指定します:
4

アプリが稼働していることを確認

最初のデプロイは、通常 1 分もかからずに完了します。ターミナルから直接、アプリケーションのステータスとログを確認してください。
ウェブサイトや API をデプロイした場合は、ブラウザで https://<your-subdomain>.squareweb.app を開き、アプリケーションが応答することを確認してください。ボットをデプロイした場合は、コマンドを送信してオンラインになっていることを確認してください。
アプリが起動しませんか?よくある原因と修正方法はトラブルシューティングガイドを参照してください。

ボットのテスト

デプロイ後、Square Cloud ダッシュボードでアプリケーションのログを確認し、Bot successfully initialized! メッセージが表示されてボットが正しく認証されたことを確認してください。次に、別のアカウントから !ping を含めてボットをメンションするツイートを投稿し (例: @your_bot !ping)、数分以内に X 上で Pong! 🤖 X Bot working correctly! と返信されることを確認してください。ボットの起動前に投稿されたメンションはスキップされます。

さらに活用する

以下のスニペットは index.js を拡張するものです。ファイルに追加し、ボットで必要な場所から呼び出してください。

ハッシュタグの監視

投稿のスケジュール設定

レート制限

X (Twitter) には厳格なレート制限があります。これらの制限を超えないように制御を実装してください:

エラー処理

追加リソース

twitter-api-v2 を使用した X ボット開発についてさらに理解を深めるには、twitter-api-v2 公式ライブラリのドキュメントを確認してください。このドキュメントでは、詳細なガイド、高度なチュートリアル、そして実装を最大化するための完全な API リファレンスを提供しています。 以下も参照してください:

次のステップ

アプリが起動しない

モジュールの不足、メモリエラーなどの起動エラーを修正します。

環境変数

ボットの認証情報やその他のシークレットを管理します。

Node.js ランタイム

Square Cloud が Node.js アプリケーションを実行する仕組み。

お問い合わせ

技術的な問題が解決しない場合は、専門のサポートチームがお手伝いします。お問い合わせいただければ、どのような問題でも喜んで解決をサポートいたします。サポートの質の高さも、開発者が Google と Trustpilot で Square Cloud に402 件のレビューで 4.9/5という評価をつけている理由の 1 つです。