> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-report-settings.md).

# Runbook レポート設定

レポート用 runbook のための中央集約型メールおよびストレージ配信設定を構成します。

## 概要

いくつかの RealmJoin ランブックには、レポート、通知、アラートを管理者へ直接配信する自動レポート機能が含まれています。構成によって、レポートは次のいずれかの方法で配信できます:

* **メールで送信** — 構成済みの送信者アドレスに代わって Microsoft Graph API を使用して
* **Azure Storage Account にアップロード** — そして、期限付きの SAS ダウンロード リンクとして利用可能にされます

今後は、両方の配信チャネルをサポートすることが、すべてのレポート用ランブックの標準となる想定です。まだ両方のチャネルをサポートしていないレポート用ランブックもありますが、対応済みランブックは継続的に増えています。両方のチャネルは、個別にも組み合わせても有効化できます。

すべての共有設定は、次の 1 か所で構成します: [RealmJoin Runbook Customization](https://portal.realmjoin.com/settings/runbooks-customizations) そして、それぞれの機能を使用するすべてのランブックに自動的に適用されます。ランブックごとに異なる設定（ターゲット コンテナー名など）はこの中央構成には含まれず、各ランブックで直接設定します。

これらの設定を利用する関数は —  [`Send-RjRbReportEmail`](https://docs.realmjoin.com/ja/dev-reference/report-functions/send-rjrbreportemail.md) と [`Publish-RjRbFilesToStorageContainer`](https://docs.realmjoin.com/ja/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md) — は次のものによって提供されます: **RealmJoin.RunbookHelper** PowerShell モジュールです。詳細な使用方法については [Report Functions](https://docs.realmjoin.com/ja/dev-reference/report-functions.md) を参照してください。

## メール配信

### 前提条件

専用の共有メールボックスの使用を推奨します。たとえば `realmjoin-report@contoso.com`。このメールボックスは、すべてのレポートの送信者アドレスとして使用されます。自動レポートには受信者からの応答は想定されないため、no-reply アドレスを使用できます。

> **注:** 送信者アドレスはユーザーまたは共有メールボックスである必要があります — Microsoft 365 グループは Graph API 経由でメールを送信できません。レポートの受信先としてのグループ アドレスは **受信者として** 技術的には機能しますが、推奨されません。メンバーが実際にメールを受信するかどうかはグループのフォロー/購読設定に依存し、配信失敗は送信者メールボックス内の不達レポートとしてしか確認できません。

### 構成

次で詳しく説明されているとおり [JSON Based Customizing](https://docs.realmjoin.com/automation/runbooks/runbook-customization#json-based-customizing) のドキュメントを参照し、次に移動します: [RealmJoin Runbook Customization](https://portal.realmjoin.com/settings/runbooks-customizations) RealmJoin Portal の（Settings > Runbook Customizations）内。

次の `Settings` ブロックで、次を追加または変更します: `RJReport` セクションに次を含めます: `EmailSender` プロパティに、希望する送信者メール アドレスを指定します:

```json
{
    "Settings": {
        "RJReport": {
            "EmailSender": "realmjoin-report@contoso.com"
        }
    }
}
```

置き換えます `realmjoin-report@contoso.com` 実際の共有メールボックスのアドレスに。

### Service Desk の連絡先情報（任意）

この中央構成では、すべてのランブック向けに統一された Service Desk の値のみを提供します。連絡先情報が実際に通知メールへ含まれるかどうかは、各ランブック自体によって決まります — 対応する Service Desk パラメーターを実装しているランブック（例: `ServiceDeskDisplayName`, `ServiceDeskPortalUrl`）がこれらの値を読み取り、メールに表示します。

これらのランブックに Service Desk の連絡先情報を提供するには、次のプロパティを `RJReport` セクションに追加します:

```json
{
    "Settings": {
        "RJReport": {
            "EmailSender": "realmjoin-report@contoso.com",
            "ServiceDesk_DisplayName": "IT Service Desk",
            "ServiceDesk_EMail": "servicedesk@domain.com",
            "ServiceDesk_Phone": "+49123456789",
            "ServiceDesk_PortalUrl": "https://servicedesk.domain.com"
        }
    }
}
```

**パラメーター:**

* `ServiceDesk_DisplayName` — Service Desk の表示名（例: "IT Support", "Help Desk"）
* `ServiceDesk_EMail` — Service Desk のメール アドレス（クリック可能な `mailto:` リンクとして表示されます）
* `ServiceDesk_Phone` — Service Desk の電話番号（国際形式、クリック可能な `tel:` リンクとして表示されます）
* `ServiceDesk_PortalUrl` — Service Desk ポータルまたは Web サイトの URL（クリック可能なリンクとして表示されます）

すべてのパラメーターは任意です。構成すると、メールフッターにクリック可能なリンクとして表示されます。

> **注:** 一部のランブックでは、実行ごとのチケット リンク（例: `ServiceDeskTicketUrl`）を追加で受け取り、要求を引き起こした特定のチケットを参照します。これはランブックのパラメーターであり、この中央構成の一部ではありません。

### メールのブランディング（任意）

レポートメールには Tenant 固有のブランディングを適用できます。既定の RealmJoin のヘッダー画像とフッター画像は独自の画像に置き換えられ、フッター画像はカスタム先（たとえば社内イントラネットや IT ポータル）にリンクでき、テンプレートの色は企業デザインに合わせて調整できます。

ブランディングを構成するには、 `Branding` のサブセクションを `RJReport` ブロックに追加します（次のようにネストします: `StorageAccount`):

```json
{
    "Settings": {
        "RJReport": {
            "Branding": {
                "HeaderImageUrl": "https://cdn.contoso.com/branding/email-header.png",
                "FooterImageUrl": "https://cdn.contoso.com/branding/email-footer.png",
                "FooterLink": "https://intranet.contoso.com",
                "AccentColor": "#0052cc",
                "TextColor": "#1a1a2e"
            }
        }
    }
}
```

**パラメーター:**

| 設定項目             | 必須  | 既定値                         | 説明                                                      |
| ---------------- | --- | --------------------------- | ------------------------------------------------------- |
| `HeaderImageUrl` | いいえ | RealmJoin のヘッダー画像           | 既定の RealmJoin のヘッダー画像を置き換えるカスタム ヘッダー画像の公開 HTTPS URL     |
| `FooterImageUrl` | いいえ | RealmJoin のフッター画像           | 既定の RealmJoin のフッター画像を置き換えるカスタム フッター画像の公開 HTTPS URL     |
| `FooterLink`     | いいえ | `https://www.realmjoin.com` | フッター画像のリンク先 URL                                         |
| `AccentColor`    | いいえ | `#f8842c` （RealmJoin オレンジ）  | メール テンプレートのアクセント カラー: 表のヘッダー行、アクション ボタン、情報ボックスのアクセント境界線 |
| `TextColor`      | いいえ | `#011e33` （RealmJoin ネイビー）  | メール テンプレートの主要テキスト色: 本文、見出し、リスト項目、コード                    |

**画像要件:**

* 画像は次を通じてアクセス可能である必要があります: **公開 HTTPS URL** — たとえば、匿名読み取りアクセスを持つ Azure Blob Storage コンテナー、CDN、または会社の Web サイトです。SAS Token を含む URL でも機能し、コンテナーを非公開のままにできます。
* 対応形式: **PNG、JPEG、GIF**。形式はファイル拡張子ではなく、ファイル シグネチャから検出されます。
* 画像は次の幅でレンダリングされます: **幅 750 px**。推奨サイズは **750×200 px** （既定のバナーに合わせたサイズ）または **1500×400 px** 高 DPI ディスプレイ向けです。
* 最大 **200 KB** 画像ごとに; **100 KB 以下** が推奨されます。ブランディング画像は、レポートの添付ファイルと約 4 MB のメール合計サイズ上限を共有します（参考までに、既定の RealmJoin 画像は 52 KB と 15 KB です）。

**色の要件:**

* 値は、先頭の `#` を含む 6 桁の 16 進カラーである必要があります。たとえば `#0052cc`。短縮形式（`#05c`）および色名（`red`）はサポートされていません。
* メールと添付ファイルはライト **と** ダークモードで表示されます: 白いコンテンツ カード上で判読可能なテキスト色を選び、白いボタン テキストに対して十分なコントラストを持つアクセント カラーを選択してください。
* ステータス カラー（成功、エラー、警告の状態を表す緑/赤/黄）と中立系のグレーは、意図的に構成変更できません。これらは Tenant ごとに変わるべきではない意味を持っているためです。

画像は、実行ごとにランブックによってダウンロードおよび検証されます。設定が空のままの場合は、既定の RealmJoin 画像、色、およびフッター リンクが使用されます。ダウンロードに失敗した場合、画像が無効な場合、または色が有効な 16 進値でない場合は、警告がログに記録され、代わりに対応する既定値が使用されます。ブランディング構成に問題があっても、レポートメールの送信は決して妨げられません。

すべての設定は任意であり、レポートメールを送信するすべてのランブックに適用されます。

> **注:** 色の設定には **RealmJoin.RunbookHelper 0.8.9** 以降が Automation Account に必要です。古いモジュール バージョンでは、画像設定は引き続き適用され、色は無視されます。

## Storage Account 配信

この配信チャネルをサポートするレポート用ランブックは、出力を Azure Blob Storage コンテナーにアップロードできます。アップロードが成功すると、ランブックはファイルを直接ダウンロードするために使用できる期限付きの SAS リンクを返します。このチャネルは、メール配信とは独立して、または併用して使用できます。

### 前提条件

既存の Azure Storage Account が必要です。Automation Account のマネージド ID（またはランブックで使用される Service Principal ）には、組み込みの Azure RBAC ロール **Reader and Data Access**を、Storage Account に直接割り当てる必要があります。

アップロードでは、storage account キーを次の方法で取得します: `listKeys` そして、それを使用してコンテナーを作成し、ファイルをアップロードし、SAS ダウンロード リンクに署名します。 **Reader and Data Access** は、このアクションを含む最小の組み込みロールです。 **Storage Account Contributor** でも機能しますが、Storage Account の管理と削除も許可されます。 **Storage Blob Data Contributor** では不十分です。これは `listKeys`.

> **注:** アカウント キーは Storage Account 内のすべてのデータへのアクセスを許可します。レポート専用の Storage Account を使用し、ロールはそのリソース グループではなく Storage Account に割り当ててください。共有キー アクセスは Storage Account で許可されている必要があります（`allowSharedKeyAccess` は無効にしては `false`なりません。たとえば Azure Policy「Storage accounts should prevent shared key access」によって無効化されている場合などです。そうでないと、アップロードは失敗します。

### 構成

次に移動します [RealmJoin Runbook Customization](https://portal.realmjoin.com/settings/runbooks-customizations) そして、次を追加します `StorageAccount` のサブセクションを `RJReport` ブロック:

```json
{
    "Settings": {
        "RJReport": {
            "StorageAccount": {
                "ResourceGroup": "rg-reports",
                "StorageAccountName": "stcontosoreports",
                "SubscriptionId": "00000000-0000-0000-0000-000000000000",
                "LinkExpiryDays": 6
            }
        }
    }
}
```

**パラメーター:**

| 設定項目                 | 必須     | 既定値                   | 説明                                                                                                             |
| -------------------- | ------ | --------------------- | -------------------------------------------------------------------------------------------------------------- |
| `ResourceGroup`      | はい     | —                     | Storage Account を含むリソース グループ                                                                                   |
| `StorageAccountName` | はい     | —                     | Azure Storage Account の名前                                                                                      |
| `SubscriptionId`     | いいえ、推奨 | サインイン時に選択されたサブスクリプション | Storage Account を含む Azure サブスクリプションの ID。参照: [Storage Account のサブスクリプション](#subscription-of-the-storage-account) |
| `LinkExpiryDays`     | いいえ    | `6`                   | 生成された SAS ダウンロード リンクの有効期限までの日数                                                                                 |

> **注:** 個々のランブックに固有の設定 — たとえばターゲット コンテナー名やカスタム blob 名 — は、そのランブックで直接構成され、意図的にこの中央構成には含まれません。blob 名のプレフィックス付けにも同じことが当てはまります。タイムスタンプ プレフィックス（`yyyyMMdd-HHmmss`）を blob 名の先頭に付けて上書きを防ぐかどうかは、次で制御されます: `AddBlobNamePrefix` のパラメーター [`Publish-RjRbFilesToStorageContainer`](https://docs.realmjoin.com/ja/dev-reference/report-functions/publish-rjrbfilestostoragecontainer.md) （既定 `$false`）で、各ランブックが明示的に渡します。

### Storage Account のサブスクリプション

設定項目 `SubscriptionId` は任意ですが、推奨されます。ランブックはサブスクリプションを指定せずにマネージド ID で Azure にサインインするため、Azure はそのマネージド ID にロール割り当てがあるサブスクリプションの 1 つを選択します。どれが選ばれるかは文書化されておらず、Automation Account のサブスクリプションとは限りません。設定なしでは `SubscriptionId`、アップロードはこの選択されたサブスクリプション内の Storage Account を検索します。

マネージド ID が 1 つのサブスクリプションでのみロール割り当てを持っている限り、Storage Account が Automation Account とは異なるサブスクリプションにあってもこれは機能します。マネージド ID が別のサブスクリプションでもロールを持つようになると、たとえば他のランブックがそこでリソースを管理している場合、Azure は代わりにそのサブスクリプションを選択する可能性があります。その場合、Storage Account がそこで見つからないため、アップロードは失敗します。レポート用ランブックやその設定に変更がなくても、このロール割り当ての後であればいつでも発生し得ます。

次の場合は `SubscriptionId` を設定すると、アップロードは常に Storage Account を含むサブスクリプションを使用します。ID は、Azure Portal の **概要** Storage Account のページで確認できます。個々のランブックに別のサブスクリプションの Storage Account を使用する場合は、その `SubscriptionId` そのオーバーライドでも設定します。参照: [個々のランブックに別の Storage Account を使用する](#use-a-different-storage-account-for-individual-runbooks).

### 個々のランブックに別の Storage Account を使用する

次の `RJReport.StorageAccount` の設定は、すべてのレポート用ランブックに適用されます。1 つ以上のランブックで別の Storage Account またはリソース グループにアップロードする必要がある場合、または別のリンク有効期間を使用する必要がある場合は、これらの各ランブックに対するオーバーライドを次の `Runbooks` セクションに追加します:

```json
{
    "Settings": {
        "RJReport": {
            "StorageAccount": {
                "ResourceGroup": "rg-reports",
                "StorageAccountName": "stcontosoreports",
                "SubscriptionId": "00000000-0000-0000-0000-000000000000"
            }
        }
    },
    "Runbooks": {
        "rjgit-org_general_report-license-assignment_scheduled": {
            "Settings": {
                "RJReport": {
                    "StorageAccount": {
                        "ResourceGroup": "rg-licensing",
                        "StorageAccountName": "stcontosolicensing",
                        "LinkExpiryDays": 1
                    }
                }
            }
        }
    }
}
```

この例では、Report License Assignment (Scheduled) は次にアップロードします: `stcontosolicensing` そして、そのダウンロード リンクは 1 日後に期限切れになります。その他すべてのレポート用ランブックは引き続き次を使用します: `stcontosoreports`.

* **ランブック名:** 以下のキーは `Runbooks` 完全なランブック名であり、ランブックの参照ページの下に表示されます **場所** → **完全な Runbook 名**。大文字小文字を含めて完全に一致している必要があります。ランブックごとに 1 つのブロックを追加してください。
* **継承:** 各設定について、ランブック固有の `Settings` が最初に確認され、その後グローバルな `Settings`が確認されます。上書きされるのは設定したキーのみで、他はすべて継承されます。単一のランブックのリンク有効期間を短くするには、 `LinkExpiryDays` だけで十分です。Storage Account が別のリソース グループにある場合は、必ず `ResourceGroup` と `StorageAccountName` と一緒に設定してください。別のサブスクリプションにある場合は、 `SubscriptionId`.
* **権限:** マネージド ID にはさらに **Reader and Data Access** 上記の前提条件で説明されているとおり、オーバーライドで使用されるすべての Storage Account に対する権限も必要です。
* **スケジュール実行:** 設定は、実行が開始またはスケジュールされた時点で適用されます。既存のスケジュールは作成時の Storage Account を保持するため、オーバーライドを使用するには再作成してください。
* **コンテナー:** コンテナーは `RJReport.StorageAccount`に含まれません。単一のランブックで変更するには、ランブックのコンテナー パラメーターの既定値（通常は `ContainerName`）を同じブロックで設定します。たとえば `"Default": { "ContainerName": "license-reports" }`.

## 組み合わせ例

次のスニペットは、完全な `RJReport` 機能有効時の構成を示しています:

```json
{
    "Settings": {
        "RJReport": {
            "EmailSender": "realmjoin-report@contoso.com",
            "ServiceDesk_DisplayName": "IT Service Desk",
            "ServiceDesk_EMail": "servicedesk@domain.com",
            "ServiceDesk_Phone": "+49123456789",
            "ServiceDesk_PortalUrl": "https://servicedesk.domain.com",
            "Branding": {
                "HeaderImageUrl": "https://cdn.contoso.com/branding/email-header.png",
                "FooterImageUrl": "https://cdn.contoso.com/branding/email-footer.png",
                "FooterLink": "https://intranet.contoso.com",
                "AccentColor": "#0052cc",
                "TextColor": "#1a1a2e"
            },
            "StorageAccount": {
                "ResourceGroup": "rg-reports",
                "StorageAccountName": "stcontosoreports",
                "SubscriptionId": "00000000-0000-0000-0000-000000000000",
                "LinkExpiryDays": 6
            }
        }
    }
}
```

## ランブック固有のストレージ設定（非推奨）

いくつかの古いレポート用ランブックは、独自の設定ブロックから Storage Account を読み取ります。現在は次も使用します: `RJReport.StorageAccount`、ただし既存の構成が引き続き機能するように、独自のブロックの読み取りは継続します:

| Settings ブロック           | Runbooks                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `IntuneDevicesReport`   | [Intune Devices をすべてエクスポート](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/general/export-all-intune-devices.md), [Autopilot デバイスをすべてエクスポート](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/general/export-all-autopilot-devices.md), [非準拠デバイスをエクスポート](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/general/export-non-compliant-devices.md) |
| `EnrolledDevicesReport` | [Enrolled Devices レポート（スケジュール）](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/general/enrolled-devices-report_scheduled.md)                                                                                                                                                                                                                                                                         |
| `TenantPolicyReport`    | [ポリシー レポートをエクスポート](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/general/export-policy-report.md)                                                                                                                                                                                                                                                                                                   |
| `OfficeLicensingReport` | [Microsoft 365 ライセンス レポート](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/general/office365-license-report.md)                                                                                                                                                                                                                                                                                       |
| `CaPoliciesExport`      | [Conditional Access ポリシーをバックアップ](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/security/backup-conditional-access-policies.md)                                                                                                                                                                                                                                                                      |
| `ListAdminsReport`      | [管理者ユーザーを一覧表示](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/security/list-admin-users.md)                                                                                                                                                                                                                                                                                                          |
| `InactiveDevices`       | [非アクティブ デバイスを一覧表示](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/security/list-inactive-devices.md)                                                                                                                                                                                                                                                                                                 |
| `VulnAppRegExport`      | [脆弱なアプリ登録を一覧表示](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/security/list-vulnerable-app-regs.md)                                                                                                                                                                                                                                                                                                 |
| `EntAppsReport`         | [エンタープライズ アプリケーション ユーザーをエクスポート](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-references/org/applications/export-enterprise-application-users.md)                                                                                                                                                                                                                                                                  |

これらのブロックのストレージ キーは次に対応します: `RJReport.StorageAccount` 次のとおりです:

| ランブック固有のキー                                                            | `RJReport.StorageAccount` キー                                                                                                       |
| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `ResourceGroup`                                                       | `ResourceGroup`                                                                                                                    |
| `StorageAccount.Name`                                                 | `StorageAccountName`                                                                                                               |
| `LinkExpiryDays` （のみ `EntAppsReport`)                                 | `LinkExpiryDays`                                                                                                                   |
| `StorageAccount.Location`, `StorageAccount.Sku`                       | なし: Storage Account がもはや自動作成されないため、無視されます                                                                                          |
| `SubscriptionId` （のみ `IntuneDevicesReport` と `OfficeLicensingReport`) | `SubscriptionId`                                                                                                                   |
| `Container`                                                           | なし: 次で説明されているように、ランブックごとにコンテナーを設定します [個々のランブックに別の Storage Account を使用する](#use-a-different-storage-account-for-individual-runbooks) |

これらのブロック内のその他のキー、たとえば `CreateLinks` または次のレポート オプション `OfficeLicensingReport`は影響を受けず、引き続き機能します。

### 優先順位

これらのランブックは、リソース グループと Storage Account 名を、次の情報源のうち最初に提供されたものから取得します:

1. ランブックに直接渡された値。たとえば、スケジュール実行、API 呼び出し、またはランブック カスタマイズ内のパラメーター既定値
2. ランブック固有の設定ブロック
3. Automation 変数 `SettingsExports` （Export All Autopilot Devices、Backup Conditional Access Policies、List Inactive Devices、Export Enterprise Application Users のみ）
4. `RJReport.StorageAccount`、個々のランブックのオーバーライドを含む

`RJReport.StorageAccount` は、上記の情報源がリソース グループと Storage Account 名の両方を提供しない場合にのみ使用されます。その場合、その `SubscriptionId`. `RJReport.StorageAccount.LinkExpiryDays` はすべての場合に適用されます。ただし `EntAppsReport.LinkExpiryDays` は Export Enterprise Application Users で優先されます。

### RJReport.StorageAccount への移行

1. 構成します `RJReport.StorageAccount` 次で説明されているとおり [Storage Account 配信](#storage-account-delivery)。あるランブックで他と異なる Storage Account を使用していた場合は、そのランブックのオーバーライドを追加し、その `SubscriptionId` アカウントが別のサブスクリプションにある場合は、次で説明されているように [個々のランブックに別の Storage Account を使用する](#use-a-different-storage-account-for-individual-runbooks).
2. 割り当てます **Reader and Data Access** 前提条件で説明されているとおり、各 Storage Account に対してマネージド ID に [Storage Account 配信](#storage-account-delivery).
3. カスタマイズからランブック固有のブロックを削除します。ブロックが次を設定している場合は `Container`, `CreateLinks` 、保持したい設定やレポート オプションがあれば、これらのキーだけを残すか、ランブックのパラメーター既定値として設定してください。
4. これらのランブックのスケジュール実行を再作成します。スケジュール実行は、以前の Storage Account を含め、作成時点の値を保持します。

> **注:** パラメーター `StorageAccountLocation` と `StorageAccountSku` は非推奨であり、無視されます。以前のバージョンで作成されたスケジュール済み実行では、引き続きそれらが渡されます。これらの実行は動作し続け、警告をログに記録します。後のバージョンでは両方のパラメーターが削除されるため、それまでにそのようなスケジュール済み実行を再作成してください。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-report-settings.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
