gsc-api は何をしますか?
Google Search Consoleのインデックスステータスを監視し、ライブログを追跡し、ローカルのSQLiteダッシュボードを使用してサイトURLの再インデックスをリクエストします。
概要
このスキルは、Google Search Console APIを利用して、WebサイトのURLがGoogleにどのようにインデックスされているかを監視および管理するためのツールです。
主な機能
- インデックスステータスの監視: サイトの各URLのインデックス状態(インデックス済み、未インデックス、エラーなど)を確認できます。
- ライブログの追跡: Google Search ConsoleでのURLの処理状況をリアルタイムに近い形で追跡します。
- 再インデックスリクエスト: 特定のURLに対して、Googleに再インデックスをリクエストできます。
- ローカルSQLiteダッシュボード: すべてのデータはローカルのSQLiteデータベースに保存され、高速かつプライベートにデータを処理します。
前提条件
- Node.js (v16以降)
- Google Cloud Consoleで有効化されたGoogle Search Console API
- Google Search Consoleにアクセス権のあるGoogleアカウント
インストール
npm install -g applebutterrhodymeniapalmata795/gsc-api
または、リポジトリをクローンしてローカルにインストールします。
git clone https://github.com/Applebutterrhodymeniapalmata795/gsc-api.git
cd gsc-api
npm install
セットアップ
- Google Cloud Consoleでプロジェクトを作成し、Search Console APIを有効にします。
- 認証情報(OAuth 2.0クライアントID)をダウンロードし、
credentials.jsonとしてプロジェクトのルートに配置します。 - アプリケーションを初めて実行するときに、OAuth認証フローが自動的に開始されます。
使用方法
インデックスステータスの確認
gsc-api status --site https://example.com
ライブログの表示
gsc-api logs --site https://example.com
再インデックスリクエスト
gsc-api reindex --site https://example.com --url https://example.com/page
ダッシュボードの起動
gsc-api dashboard
これにより、ブラウザでローカルダッシュボードが開きます(通常は http://localhost:3000)。
設定
環境変数または設定ファイルで以下のオプションを設定できます。
GSC_API_PORT: ダッシュボードサーバーのポート番号(デフォルト: 3000)GSC_API_DB_PATH: SQLiteデータベースの保存先パス(デフォルト:./gsc-data.sqlite)
データベース構造
SQLiteデータベースには以下のテーブルが含まれます。
sites: 監視対象サイトの情報urls: 各URLのインデックスステータスlogs: インデックス処理のログ
注意事項
- Google Search Console APIには利用制限(クォータ)があるため、頻繁なリクエストは避けてください。
- OAuth認証情報は安全に管理し、公開リポジトリにコミットしないでください。
- このツールは管理目的で使用され、Googleの利用規約に準拠してください。
ライセンス
MIT