こんにちは！カスタマーエンジニアの神谷です。今年の目標の1つは、ダンベルプレスで100kgを上げること。つまり、両手にそれぞれ50kgのダンベルを持って、それを持ち上げたいです。ちなみに、ベンチプレス100kgは余裕です。

さて今回は、Google Search Console（以下、サーチコンソール）の掲載順位が一定以上変動したら、Craft Functionsを使ってSlackに通知する方法をご紹介します。コンテンツマーケやSEOでは必須のツールであるサーチコンソールですが、あまり詳しくない方もいるかと思いますので、そもそもサーチコンソールって何なのか、掲載順位が変わったらSlackに通知することの利便性について、まずご説明します。

サーチコンソールの概要

一言でまとめると、サーチコンソールはLPや記事コンテンツの検索エンジンにおける掲載順位を可視化するツールです。掲載順位とは、検索エンジン上で何かしらのキーワードを入れて検索した際、上から何番目に出てくるかを示すもので、その数値が1に近いほどいい結果と言えます。なぜなら、一般的に検索した際に1番最初に出てくるものから、ユーザーは順番に見ていくため、クリック率及び流入数も当然高まるからです。そのため、コンテンツマーケやSEOに力を入れているところは、どの会社や組織も1番を狙っているはずです。

ちなみに私はコンテンツマーケターとして、かつて「札幌ラーメン」「京都ラーメン」のような、日本中のラーメンに関する検索の掲載順位でトップを独占していました。各種SNSでエゴサーチすると、またこいつの記事が1番に出てきたよって言われるぐらいにはなっていた記憶があります。その時はサーチコンソールの画面を見ると、ずらっと1位が並んでいて壮観だったことも覚えています。複数のWebメディアでラーメンに関する記事を執筆して、トップ10に自分の記事が3つランクインしている、なんてこともありました。

私の経験談はこれぐらいにして、実際のサーチコンソールの画面などについて見ていきましょう。

スクリーンショット2024-01-3011.14.19.png
これは弊社が運営するWebメディア、CX Clipのサーチコンソールの画面です。実際のデータはお見せできないため、マスクされている部分が多くて少しわかりづらいかもしれませんが、このような感じで、日付ごとにどれぐらい検索エンジンで検索されたか、そのうち何回クリックされたか、その日の掲載順位はどれぐらいだったのかを追うことができます。

スクリーンショット2024-01-3011.14.31.png
スクリーンショット2024-01-3011.14.46.png
ここもマスクされている部分ばかりで申し訳ないですが、このようにキーワードごとやページごと、あるいはその両者を掛け合わせて、クリック数や掲載順位などの推移を見ることが可能です。皆さんの会社で運営されているWebメディアのサーチコンソールを閲覧したい場合、管理者にお願いすれば権限をつけてもらえると思います。

コンテンツマーケやSEOの担当者は、これらの画面を見ながら、どのページが検索上位に来ているのか、どのキーワードでの流入が多いのかなどを分析し、今後のコンテンツ作成や改善策を考えていきます。

掲載順位の変動をSlackに通知する意義について

さて、サーチコンソールの概要について理解していただいたところで、ここではなぜサーチコンソールの掲載順位の変動をSlackに通知する必要があるのか、その意義を考えてみたいと思います。私の経験による主観を多分に含みますので、参考程度に軽く読んでいただければと思います。

掲載順位が変わっても、すぐにそのことに気づきにくい

サーチコンソールにも、通知機能自体はあります。ただしそれはメールなので、リアルタイム性に欠けるのと、埋もれやすい欠点があります。そういった場合に、Slackで通知が来ていれば、誰か1人でも気づきやすくなり、掲載順位が下がったりしたなどの場合に、素早く対応できると思います。加えて今回の場合は、Slack通知するかどうかの基準となる掲載順位の変動幅を自由に設定できることも、大きなメリットになるでしょう。

サーチコンソールの権限を持っていないと、そもそも気づかない

そもそもサーチコンソールの権限が付与されていない場合、掲載順位を確認することも、その変動を知ることもできません。関係者全員に権限付与できればいいですが、全員に権限付与しようとしても対象者の漏れが生じたり、インターン生など社員以外には付与できないといった事情もあるでしょう。そういう時に、特定のページに関する掲載順位の変動だけでも、Slackに情報を流せれば、関係者の皆で確認できるメリットがあります。

掲載順位の変動をSlackに通知したいケースについて

続いて、それなら具体的にどのような場合に掲載順位の変動がSlackに通知されたら嬉しいか、具体的なユースケースについても考えていきましょう。これも私の主観を多く含みますが、大きく分けて2つのケースがあると思います。

ある期間において掲載順位に一定以上の変化があった場合

純粋に、特定のページやキーワードにおける掲載順位が一定数変化したら、それは通知した方がいいでしょう。掲載順位は日々多少の上下をしますが、一気に上がり下がりする急激な変化の場合は、何か異変が起きていたりする場合があるので、素早く調査及び対応したいはずです。

特に出したばかりの新しい記事や、リライトしてもっと上位を狙う場合、それが検索エンジンにインデックスされていくと、短期間で急激に掲載順位が上がったりします。私としてはこのような、比較的新しめの記事や更新したばかりの記事に対して、通知する掲載順位の変動幅を大きめに設定しておくことで、その変化を素早くキャッチできると思います。

掲載順位が一定の数値を上回ったり下回ったりした場合

特定のページやキーワードにおける掲載順位が、一定の数値を上回ったり下回ったりした場合にも、通知されるといいと考えています。物凄い急激な掲載順位の変化ではなくても、今まで割と一定の掲載順位で安定していたのに、そこからずれる場合は、やはり何かが起きている可能性があるからです。

例えば、今までずっと掲載順位で1位や2位をキープしていたのに、突然下がって4位以下になったりといったことが、過去に私の経験でもありました。その原因は、検索エンジンのアルゴリズムの変更や、競合が頑張っていてそちらが検索エンジンにより良いコンテンツと認められた、など色々考えられますが、その場合も通知があった方が便利でしょう。ずっと上位だったのに、気づいたらいつの間にか下がってた、というのは結構焦った記憶があります。こちらの場合は、公開から時間が経って安定的に上位にランクインしている記事向けかと思います。

今回紹介するソリューションについて

さて、前置きが随分長くなってしまいましたが、サーチコンソールの概要やSlackに通知することの意義についてご理解いただいたところで、ここから今回のソリューションについて説明していきます。今回は例として、ある一定期間において掲載順位に一定以上の変化があった場合にSlackに通知する方法について書いていきます。

処理の流れとしては、上の図のようになります。Craft Functionsを実行して、サーチコンソールのAPIから掲載順位に関するデータを取得し、その変動幅が一定値を超えたらSlackに通知する、流れとしてはとてもシンプルなものです。Craft Functionsの実行頻度は、1日1回程度が妥当かと思います。

スクリーンショット2024-01-3022.46.49.png
具体的なアウトプットとしては、上のようなものを目指してみます。CX Clip内にある、カスタマージャーニーに関する記事の掲載順位が、一定期間でどれぐらい変化したのかが一目瞭然ですね。

手順

具体的な手順は、以下の通りです。

GCPプロジェクトでGoogle Search Console APIを有効化する
Googleサービスアカウントを作成してjsonキーを取得する
サービスアカウントにサーチコンソールの権限を付与する
Slackアプリを作成してチャンネルへ追加し、OAuthトークンを取得する
サービスアカウントのjsonキー及び、SlackアプリのOAuthトークンをCraft Secret Managerに登録する
掲載順位の取得及びSlackへ通知するためのCraft Functionsを作成する

1つずつ順番に見ていきましょう。

1. GCPプロジェクトでGoogle Search Console APIを有効化する

まず、Google Search Console APIを有効化します。その利用にあたっては、GCPプロジェクトを利用する必要があります。

スクリーンショット2024-01-3013.30.52.png
スクリーンショット2024-01-3013.31.24.png
適当なGCPプロジェクトを作成または選択し、[APIとサービス > 有効なAPIとサービス > APIとサービスの有効化またはライブラリ] からGoogle Search Console APIを検索し、有効化します。

2. Googleサービスアカウントを作成してjsonキーを取得する

次に、同一GCPプロジェクトでGoogleサービスアカウントを作成します。後にそのアカウントを使ってサーチコンソールの認証をします。

[IAMと管理 > サービスアカウント > サービスアカウントを作成] から適当な名称のアカウントを作成します。

スクリーンショット2023-08-1413.15.34.png

作成したサービスアカウントを選択し、[キー > 鍵を追加 > 新しい鍵を作成] からJSON形式のキーファイルをダウンロードします。

スクリーンショット2023-08-1413.16.12.png

このキーファイルの中身を、後でCraft Secret Managerに登録する必要があるので、取っておいてください。

3. サービスアカウントにサーチコンソールの権限を付与する

Google Search Console APIを有効化して、サービスアカウントのjsonキーを取得しても、それだけではGoogle Search Console APIは使えるようになりません。通常のGoogleアカウントにサーチコンソールの権限を付与するのと同様に、サービスアカウントにもサーチコンソールの権限付与が必要です。

スクリーンショット2024-01-3014.48.54.png

サーチコンソール左側のメニューから、設定を開きます
そこのユーザーと権限をクリックし、サービスアカウントのメールアドレスを入力し、フル権限を選択して追加します

もし皆さんが、サーチコンソールの管理者権限を持っている場合は、ご自身でサービスアカウントへの権限付与が可能なはずです。しかし上記の画面のようにユーザーと権限が設定の中になく、他者への権限付与ができない場合は、管理者に権限付与を依頼してください。

ここまでできたら、サーチコンソールのAPIを利用するための準備は完了です。

4. Slackアプリを作成してチャンネルへ追加し、OAuthトークンを取得する

他の記事でも同じことが何度も説明されていますが、Slackに通知をするための基本設定も改めて説明しておきます。Slackに通知をするには、まずそのためのアプリを作成する必要があります。

[slack api > Your Apps] からCreate New Appをクリックしてください
Create an appの画面でFrom scratchを選択してください
次の画面でSlackアプリの名前と、それを適用するSlackのワークスペースを指定してください

Slackアプリの名前は特に規則はないので、ご自身でわかりやすいものにすれば問題ないです。ワークスペースは、皆さんが所属している組織のものになるでしょう。アプリの作成が完了したら、次にSlack アプリに必要なスコープの設定とOAuth トークンを取得します。

スコープの設定

スクリーンショット2023-07-1812.57.49.png

作成したアプリを選択して、[Features > OAuth & Permissions]をクリックしてください
ページ内のScopesの項目のBot Token ScopesのAdd an OAuth Scopeをクリックしてください
プルダウンメニューからchat:writeを選択してください

OAuthトークンの取得

スクリーンショット2023-07-1813.01.11.png

OAuth & Permissions ページ内のOAuth Tokens for Your WorkspaceのInstall to Workspaceをクリックしてください
アプリがワークスペースにアクセスするための権限を許可するために、許可するをクリックしてください
自動的に生成されるOAuth トークン（Bot User OAuth Token）を控えておいてください

作成したSlackアプリを使って通知を実行するには、通知を飛ばしたいチャンネルに追加する必要があります。

通知を飛ばしたいチャンネルの詳細ページを表示します
[インテグレーション > App]のアプリを追加するをクリックしてください
今回作成したアプリを追加します

スクリーンショット2023-12-1913.01.28.png
通知を飛ばすSlackチャンネルのチャンネルIDも後で必要になるため、控えておいてください。チャンネルIDは、チャンネル情報タブの1番下にあります。Slack側の基本的な設定はここまでです。

5. サービスアカウントのjsonキー及び、SlackアプリのOAuthトークンをCraft Secret Managerに登録する

Craft Functions作成の前に、ここまでで取得したサービスアカウントのjsonキーや、SlackアプリのOAuthトークンを、Craft Secret Managerに登録しておきましょう。これらをCraft Secret Managerに登録しておくことで、中身を直接Craft Functionsに埋め込まなくても、使用できるようになります。

スクリーンショット2024-01-2219.11.47.png

[Craft > シークレット] からシークレットを新規作成します
サービスアカウントのjsonキーは、中身を丸ごとコピペして適当な名前をつけて保存してください
SlackアプリのOAuth トークンも、貼り付けたら適当な名前を付けて保存してください

ここでつけた名前を、Craft Functions作成時に変数として設定します。

6. 掲載順位の取得及びSlackへ通知するためのCraft Functionsを作成する

いよいよ本題となる、Craft Functionsの作成に入っていきます。サンプルコードは、下記URLで公開しています。

https://github.com/plaidev/craft-codes/tree/main/craft-functions/google-search-console-slack-notification

ソースコードの取得手順は、以下の通りです。

[Craft > ファンクション > 作成 > テンプレートから作成] を選択
Google Search Consoleの掲載順位が変動したら、Craft Functionsを使ってSlackに通知する方法というテンプレートを検索し「取得」ボタンをクリック
「反映」ボタンをクリック
Functionを有効化して保存

まずは、5で設定したシークレットやその他必要なものを、変数として指定しておきましょう。

スクリーンショット2024-01-3022.59.39.png

SERVICE_ACCOUNT_KEY_SECRETの値には、サービスアカウントのjsonキーを登録したシークレット名を入力します
SLACK_TOKEN_SECRETの値には、SlackアプリのOAuth トークンを登録したシークレット名を入力します
SLACK_CHANNEL_IDには、通知を流したいSlackのチャンネルIDを入力します
SITE_URLには、サーチコンソールを導入しているサイトのトップページのURLを入力します
PAGE_URLには、実際に掲載順位を取得したいページのURLを入力します
RANK_DIFFERENCE_TO_NOTIFYには、Slackへ通知する基準となる掲載順位の変動幅を指定します
DAY_BEFORE_END_DATEには、掲載順位の比較対象となる日付を取得するために、終了日から何日前の日付を使用するかを指定します

SlackのチャンネルIDや、サーチコンソールを導入しているサイトのURLなどは、Craft Functionsのコード内に直接埋め込むこともできますが、こうして変数として指定することで、コードをいじらずとも変更できます。Slackへ通知する基準となる掲載順位の変動幅も同様で、例えば5位上がったら通知するとしていたのを、10位上がったら通知するなどに、簡単に変更できます。

ここから、Craft Functionsのコードで重要な部分について、かいつまんでご説明します。

// 開始日と終了日の取得を行う関数
function getStartDateAndEndDate(dayBeforeEndDate) {
  const today = new Date();
  // 最新の掲載順位が入っている3日前の日付をendDateとして取得
  const endDate = format(subDays(today, 3), 'yyyy-MM-dd');
  // 掲載順位の比較対象とするstartDateを最新の日付から逆算して取得
  const startDate = format(subDays(new Date(endDate), dayBeforeEndDate), 'yyyy-MM-dd');

  return { startDate, endDate };
}

const { startDate, endDate } = getStartDateAndEndDate(DAY_BEFORE_END_DATE);

const startDatePageRanking = await getPageRankingOnDate(searchConsole, SITE_URL, PAGE_URL, startDate);
const endDatePageRanking = await getPageRankingOnDate(searchConsole, SITE_URL, PAGE_URL, endDate);

if (startDatePageRanking === null || endDatePageRanking === null) {
  logger.warn('開始日または終了日の掲載順位が取得できませんでした。');
  return;
}

上の方では、サーチコンソールから取得する掲載順位を比較する、期間の始まりと終わりの期日を設定しています。取得する期間を固定することもできますが、実際の運用に当たっては、Craft Functionsの実行日を基準に何日前から何日前までのようなパターンが多いと思うので、実行日から動的に期間を設定しています。

また、実際にサーチコンソールを使ったことのある方ならお分かりかもしれませんが、サーチコンソールの掲載順位は、昨日のものが即時反映されにくいです。サーチコンソールの画面上でも、大体3日前ぐらいの掲載順位が最新になっていることが多いので、ここでは便宜上、ほぼ最新のデータが入っていると見做せる3日前を基準とし、そこからどれだけ前の日の掲載順位と比較するかを、変数で指定できるようにしています。念の為に、APIから昨日と一昨日の掲載順位を取得しようとしたところ、やはりnullが返ってきました。

もし、どちらかの日付の掲載順位が反映されておらず、取得しようとしてもnullになってしまう場合も考慮して、その旨を通知する警告ログも入れています。ちなみにその日の掲載順位がnullになる理由として、まだ反映されていないのではなく、検索エンジン上でその記事に関する検索が全くなく、誰にも表示もクリックもされなかった場合も、nullになることがあります。

const changePageRanking = Math.abs(startDatePageRanking - endDatePageRanking).toFixed(1);

if (changePageRanking < RANK_DIFFERENCE_TO_NOTIFY) {
  return;
}

ここでは、期間の始まりと終わりで、どれぐらい掲載順位が変化したかを計算しています。実際にやってみればわかりますが、API経由で取得できる掲載順位は小数第15位ぐらいの非常に細かい数字が出てくるため、画面上で取得できる掲載順位と同じく、小数第1位までに丸め込んでいます。注意点として、サーチコンソールの掲載順位は、1に向かって数値が小さくなるほど良い結果なので、始まりの日を基準として終わりの日の掲載順位を引いていることに気をつけてください。この結果が正の数になれば掲載順位が上がり、負の数になれば掲載順位が下がっていることになります。ただ今回は例なので、計算結果の絶対値を取って、掲載順位の上昇と下降の双方に対応できるようにしています。

また、Craft Functionsを実行するための設定も必要になります。今回は、KARTEで閲覧や購入など何かイベントが発生した際に発動するのではなく、1日1回程度の定期実行が一般的かと思われるので、その設定方法をご紹介します。

スクリーンショット2024-01-3022.52.12.png

Craft Functionsの設定タブを開きます
スケジュールを有効化し、cron形式（JST）で実行時間を指定します

cron形式（JST）についてここで詳しくは説明しませんが、例えば毎日10時に実行したい場合は、0 1 * * *と入力して保存してください。とりあえずすぐ動かして実行結果を確認したい場合は、1分ごとに毎回実行される* * * * *を入力してみてください。

ここまでできたら、Craft Functionsを有効化して保存してください。

検証

実際にCraft Functionsを実行して、Slackに通知が来るかどうか確認してみましょう。設定した期間の始まりと終わりの日付における掲載順位を取得し、その変動幅が設定した値を上回っている場合は、Slackに通知が飛んでくることが確認できるはずです。もしテスト的にやるならば、事前に画面でその日の掲載順位を確認しつつ、変動幅の閾値を0.1や-0.1など非常に小さい値にしてみれば、確認しやすいと思います。

スクリーンショット2024-01-3022.46.49.png

余裕があれば、変動幅の閾値を100など非常に大きな値にした場合、Slackに通知が飛んでこないことも確かめてみてください。

終わりに

今回は、Google Search Consoleの掲載順位が変動したら、Craft Functionsを使ってSlackに通知する方法をご紹介しました！Craft Functionを使えば、KARTEとの連動だけでなく、外部ツールとの連携やそれを使った便利ツールも、このように簡単に作れちゃいます。今後も皆さんに、こんなのあったらいいなと思うものを制作してご紹介したいと思います。

プレイドでは、世の中にインパクトを与える新しいソリューションを一緒につくる仲間を募集しています！
ぜひ気軽にお問い合わせください。

↓ パートナー企業になりたい

CustomerData-Driven Solution を一緒に創りませんか？ | PLAID Ecosystem

↓ PLAIDで働きたい