ツールリファレンス

対象プランすべてのプラン

AIクライアントをCabinに接続すると、以下のツールが使えるようになります。どのツールを呼び出すかは、あなたの質問に応じてアシスタントが選びます。ツールは役割ごとに分類されています。

• 読み取りツールはデータを取得するだけなので、いつ実行しても安全です。
• 書き込みツールはレコードを作成または変更します。多くのクライアントは事前に確認を求めます。
• 破壊的ツールはデータを削除します。クライアントは実行前に必ず確認を求めます。

どのツールもあなた自身のアカウントにあるドメインだけを対象とし、ご利用のプランに従って動作します。お使いのプランにない機能が必要なツールは、一部のデータを返すのではなく、その旨をお知らせします。

読み取りツール

list_domains

アカウントにあるすべてのドメインを、それぞれの非公開ダッシュボードのURL（共有が有効な場合は公開ダッシュボードのURLも）とともに一覧表示します。パラメーターはありません。

get_analytics

指定した期間におけるドメインのアナリティクスです。ページビュー、ユニーク訪問者、セッション、上位ページ、参照元を返します。

• domain：照会するドメイン（例：example.com）
• date_from、date_to：期間（YYYY-MM-DD形式）
• scope：含める内容。core、pages、referrals、またはその組み合わせ（デフォルトはcore）
• limit_lists：各リストで返す項目数（デフォルトは50）

get_domain_settings

ドメインの現在の設定を返します。タイムゾーン、公開ダッシュボードの状態、週次レポートの受信者、カスタムスクリプトホスト、ブランドカラー、除外IPリストが含まれます。emailRecipientsとexcludeIpsはどちらもリスト全体を置き換えるため、変更する前にこのツールで現在の値を読み取ってください。

• domain：読み取るドメイン

validate_installation

Cabinのトラッキングスクリプトがドメインに正しくインストールされているかを確認します。

• domain：確認するドメイン

check_custom_domain_dns

カスタムサブドメインのCNAMEがcustom.withcabin.comを正しく指しているかを検証します。

• custom：確認するカスタムサブドメイン（例：stats.example.com）

analyse_page

1つのURLについて、CO₂・エネルギーとパフォーマンスの分析を実行します。過去の平均値も含まれます。Cabinがまだ分析したことのないURLは、20〜30秒かかることがあります。

• url：分析するURLの完全な形（例：https://example.com/about）
• force：最近の分析結果があっても再実行する（デフォルトはfalse）

書き込みツール

create_domain

アカウントに新しいドメインを追加します。ダッシュボードのURLと、インストールするトラッキングスクリプトのスニペットを返します。

• domain：追加するドメイン（プロトコルやパスは含めない）
• tz：アナリティクスに使うIANAタイムゾーン。例：Europe/London（デフォルトはUTC）

update_domain_settings

所有しているドメインの設定を1つ以上更新します。

• domain：更新するドメイン
• public：ダッシュボードを一般公開する
• publicPassword：公開ダッシュボードをパスワードで保護する。空文字列を渡すとパスワードを解除します（PlusとScale）
• privacypage：公開ダッシュボードにプライバシーに関する声明を表示する
• emailRecipients：このドメインの週次レポートを受け取るメールアドレスの配列（Plusは自分のアカウントのメールアドレスにのみ送信、Scaleは誰にでも送信できます）。リスト全体を置き換えるため、アドレスを1つ追加または削除するときは、まずlist_domainsで現在の受信者を読み取り、更新後のリストをすべて送ってください。空の配列を渡すと、週次メールはすべて停止します。
• tz：IANAタイムゾーン
• color：ダッシュボードのブランドカラー（16進数）
• excludeIps：訪問を取り込み時に破棄するIPアドレスまたはCIDR範囲（IPv4またはIPv6）の配列。最大30件。リスト全体を置き換えます。消去するには[]を渡してください。AIクライアント経由でこのリストを設定または読み取ると、そのアドレスがクライアントの提供元と共有されます。

add_custom_domain

カスタムサブドメインを追加し、トラッキングスクリプトを自分のホストから配信して広告ブロッカーを回避します。DNSの設定手順と、DNSの検証後にインストールする新しい<script>タグを返します（PlusとScale）。

• domain：サブドメインの向け先となるCabinのドメイン
• custom：使用するサブドメイン。例：stats.example.com（analytics、tracker、statsなど、広告ブロッカー自体が標的にしやすい名前は避けてください）

破壊的ツール

delete_domain

アカウントからドメインを完全に削除します。そのドメインのアナリティクスデータは削除が予定されます。この操作は元に戻せません。

• domain：削除するドメイン

remove_custom_domain

所有しているドメインからカスタムサブドメインを外し、サイトに戻すためのデフォルトホストのスクリプトタグを返します。

• domain：サブドメインが紐づいているCabinのドメイン
• custom：削除するサブドメイン