GASでサーチコンソールのデータを取りたいが403エラーが出る

Question

実現したいこと

Googleサーチコンソールから、2日前のサイト全体の以下のデータを取得し、スプレッドシートに出力したい。

• 表示回数
• クリック数

発生している問題・分からないこと

54行目のthrow new Errorにてエラーが発生しました。
43行目の「response = UrlFetchApp.fetch(apiURL, options);」にて取得したresponseの中身に問題があるようです。

エラーメッセージによると、このサイトの権限を持っていないと書かれています。しかし、実際には、GASを実行しているGoogleアカウントがサーチコンソールのオーナーです。サーチコンソールの「ユーザーと権限」というページを見て確認しました。

エラーメッセージ

Error: API request failed with status 403: {
  "error": {
    "code": 403,
    "message": "User does not have sufficient permission for site 'https://hoge-hoge.com/'. See also: https://support.google.com/webmasters/answer/2451999.",
    "errors": [
      {
        "message": "User does not have sufficient permission for site 'https://hoge-hoge.com/'. See also: https://support.google.com/webmasters/answer/2451999.",
        "domain": "global",
        "reason": "forbidden"
      }
    ]
  }
}

該当のソースコード

function getSearchConsoleApi(){

  //GASスクリプトに紐づくスプレッドシートのアクティブなシート読み込み
  const mySheet = SpreadsheetApp.getActiveSheet();

  //サーチコンソールの取得する開始日・終了日を定義※取得したい期間を設定
  const startDate = "2024-10-01";
  const endDate = "2024-10-10";
  
  // サーチコンソールから取得するドメイン名を定義※書き換え必須
  const siteDomain = "https://hoge-hoge.com/";
  
  // ドメインを正しくエンコードする
  const encodedDomain = encodeURIComponent(siteDomain);
  
  // リクエストするAPIのURLを設定する
  const apiURL = `https://www.googleapis.com/webmasters/v3/sites/${encodedDomain}/searchAnalytics/query`;
  
  
  //サーチコンソールから取得する最大クエリ数を設定する
  const maxQuery = 1000;
  
  //APIリクエスト時にセットするペイロード値を設定する
  const payload = {
    'startDate': startDate,
    'endDate': endDate,
    "dimensions": ["page", "query"], // ディメンションの設定方法はまだわかっていない。
    "rowLimit": maxQuery
  };
  
  const options = {
    'payload': JSON.stringify(payload),
    'method': 'POST',
    'muteHttpExceptions': true,
    'headers': { "Authorization": "Bearer " + checkAndRefreshToken() },
    'contentType': 'application/json'
  };
  
  //APIリクエストを行った結果のJSONデータを変換する
  let response;

  try {
    response = UrlFetchApp.fetch(apiURL, options);
    const responseCode = response.getResponseCode();
    const responseBody = response.getContentText();
    console.log(`Response Code: ${responseCode}`);
    console.log(`Response Body: ${responseBody}`);

    // レスポンスの内容を確認
    let responseText = response.getContentText();
    Logger.log("API Response: " + responseText);  // デバッグ用ログ

    if (response.getResponseCode() !== 200) {
      throw new Error(`API request failed with status ${responseCode}: ${responseBody}`);
    }

    // json = JSON.parse(responseText);
    let json = JSON.parse(responseBody);

    if (!json.rows || json.rows.length === 0) {
      throw new Error("No data returned from the API");
    }
  } catch (error) {
    Logger.log("Error: " + error.message);
    return;  // エラーが発生した場合、ここで処理を終了
  }
  
  //JSONデータを処理してqueryを配列に保存する処理をforループで行う
  let queryData = [];
  for (i = 0; i < maxQuery; i++) {
    //queryDataを2次元配列に拡張する
    queryData[i] = [];
    //json変数のデータをqueryDataの配列に格納する
    queryData[i][0] = json["rows"][i]["keys"][1];
    queryData[i][1] = json["rows"][i]["keys"][0];
    queryData[i][2] = json["rows"][i]["clicks"];
    queryData[i][3] = json["rows"][i]["impressions"];
    queryData[i][4] = json["rows"][i]["position"];
    queryData[i][5] = json["rows"][i]["ctr"];
  }

  //スプレッドシートにqueryデータを書き込み
  mySheet.getRange(2, 1, queryData.length, queryData[0].length).setValues(queryData);
  //スプレッドシートのデータの順番を表示回数で降順で並び替え
  mySheet.getRange(2, 1, queryData.length, queryData[0].length).sort({ column: 4, ascending: false });
  //クリック率のCTRの数値フォーマットを％に設定
  mySheet.getRange(2, 6, queryData.length).setNumberFormat('0.00%');
}


function checkAndRefreshToken() {
  let token = ScriptApp.getOAuthToken();
  
  // トークンの有効性をテストする簡単なAPIコール
  const testUrl = "https://www.googleapis.com/oauth2/v1/tokeninfo?access_token=" + token;
  const response = UrlFetchApp.fetch(testUrl, {'muteHttpExceptions': true});
  
  if (response.getResponseCode() !== 200) {
    // トークンが無効な場合、新しいトークンを取得
    ScriptApp.invalidateAuth();
    token = ScriptApp.getOAuthToken();
  }
  
  return token;
}

{
  "timeZone": "Asia/Tokyo",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "dependencies": {
    "enabledAdvancedServices": [
      {
        "userSymbol": "AnalyticsData",
        "serviceId": "analyticsdata",
        "version": "v1beta"
      }
    ],
    "libraries": [
      {
        "userSymbol": "OAuth2",
        "version": "43",
        "libraryId": "1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF"
      }
    ]
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/spreadsheets", 
    "https://www.googleapis.com/auth/webmasters.readonly",
    "https://www.googleapis.com/auth/script.external_request"
  ]
}

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

このコード自体は、このページを参考にしました。
https://auto-worker.com/blog/?p=3294

このページの以下の箇所でエラー（内容は失念しました）が出たので、ChatGPTやClaudeに質問しつつコードを改善していきました。
json = JSON.parse(response);

補足

• GPCのGoogle Search Console APIは設定済み
• ライブラリから「OAuth2」を追加済み
• Apps Scriptエディターのプロジェクトの設定画面で、GCPのプロジェクト番号を設定済み
• Apps Scriptエディターのプロジェクトの設定画面で、以下の箇所にチェックマークを入れました。その結果、appsscript.jsonというスクリプトファイルが生成されました。そのスクリプトファイルには「oauthScopes」情報を追記しました。

「appsscript.json」マニフェスト ファイルをエディタで表示する

Answer 1

ちょっと実験してみました。
Google Search Consoleにプロパティ（情報を取得するURL）を追加し情報を確認できる状態の場合は提示されたコードを変更せず（当然情報を取得するURL部分は変更）エラーが出ずに実行できました。
そして登録したプロパティを削除し実行したところ提示されているエラー（403）が発生しました。

まずはGASではなくGoogle Search ConsoleにてそのURLの情報が見れるのかを確認してはどうでしょうか。

追記

追加で試したところドメイン プロパティの場合は
こちらにあるようにsc-domain:ドメイン名と指定しないと403エラーとなりました。
プロパティがドメインプロパティの場合は

    // 追加したドメインプロパティがhoge-hoge.comの場合
    const siteDomain = "sc-domain:hoge-hoge.com";

としてください。