先日、社内から
「サーチコンソールの結果を全て見られない！APIで何とかならない？」
と要望を受け、Search Console API(Webmaster Tools API)を使って取得できるような社内ツールをPHPで開発することになりました。その際に作成したコードのサンプルと共に使い方を紹介したいと思います。

サーチコンソール上では最大999行(999件)の結果までしか見ることが出来ず、CSVのダウンロードを行っても結果は同じ。APIを利用すれば1000件以上の結果を取得することが出来ます。

載せてあるサンプルコードを使用する前提の記事なので、自前でコードを書かれる方は適宜置き換えて読んで下さい。

ライブラリを利用すると簡単！

GoogleのAPIを利用するにあたって様々な言語を使用することが想定されますが、Googleがいくつかの言語に関してライブラリを用意してくれています。

Google APIs Client Librariesを開くと分かりますが、Java、JavaScript、.NET、Objective-C、PHP、Python、Dart、Go、Node.js、Ruby…あなたの使える言語はありましたか？各言語向けにライブラリが用意されています。

今回はPHPなのでPHP版をこちらからDLします。もしくはComposerで。APIを利用するにはOAuthを使った認証が必要になり、とくにこのあたりは1から書くととてもめんどくさい感じになりますが、用意されてるライブラリを使えば楽勝ですね。ありがたく使わせていただきましょう。

適当にディレクトリを作って展開しておきます。ここではsearch_consoleという名前で作成したとします。

認証情報を作成

次にGoogle API Consoleで認証情報を作成します。
あらかじめGoogleアカウントは用意しておいてください。

新規や新たにプロジェクトを作る場合は左上のロゴにある「プロジェクトを作成」、もしくは既存のプロジェクトを選択します。

まだSearch Console APIを有効にしていない場合は、左メニューにあるライブラリを選択、Search Consoleで検索してGoogle Search Console APIを選択、有効にします。

左メニューにある認証情報から「認証情報を作成」→「OAuthクライアントID」を選択します。

アプリケーションの種類をウェブアプリケーション、承認済みのリダイレクトURIにプログラム設置箇所のURI(例として http://localhost/search_console/ とします。認証が完了するとこのURIへリダイレクトされます)を入力し「作成」ボタンを押します。

これで認証情報が作成されました。いま作成したアプリケーション名を選択するとそこからjsonをダウンロード出来るのでclient_id.jsonという名前で保存します。

このjsonを先ほど作成したディレクトリ内に置いて認証情報の作成は終わりです。

プログラムを設置

あとはサンプルコードを設置します。
こちらからダウンロードしてください。

ファイル名は認証情報でリダイレクトURIを設定したURIでアクセス出来るようなファイル名(今回はindex.php)とします。

変更が必須なのはGoogle APIs Client Libraryのautoload.phpへのパスです。適宜変更してください。

勝手に結果のcsvをoutputディレクトリ内に生成してますので、不要な場合やうまく管理したい場合はその辺を適当に調整してください。(そのまま使っても古いものは自動で削除する仕組みにはなっています。)

調整が完了したら設置したURIへアクセスします。Googleの認証画面が開くはずです。

サーチコンソールでサイトを登録しているGoogleアカウントで許可すれば、そのアカウントで登録しているサイトの一覧が表示されます。

サイトのURIと期間とクエリベースかURIベースか選択するとAPIの出力結果を整形して出力します。

これで結果を取得出来るようになりました！PHPでGoogle APIでサーチコンソールを利用するときの参考になれば幸いです。