Gmail

Gmail は Google が開発した E メールクライアントで、添付ファイル付きのメールメッセージを送信できます。Gmail のメッセージは、フォルダやラベルを使用して E メールの受信トレイ内で分類して保存できます。Amazon Kendraを使用して、E メールメッセージとメッセージ添付ファイルのインデックスを作成できます。インデックス作成のために、特定の E メールメッセージ、メッセージの添付ファイル、ラベルを含めるか除外Amazon Kendraするようにを設定することもできます。

Amazon Kendraコンソールと TemplateConfiguration API を使用して Gmail データソースAmazon Kendraに接続できます。

Amazon KendraGmail データソースコネクタのトラブルシューティングについては、「」を参照してくださいデータソースのトラブルシューティング。

サポートされている機能

フィールドマッピング
ユーザーアクセスコントロール
包含/除外フィルター
完全および増分コンテンツ同期
Virtual Private Cloud (VPC)

前提条件

Amazon Kendraを使用して Gmail データソースのインデックスを作成する前に、Gmail とAWSアカウントでこれらの変更を行います。

Gmail で以下を確認してください。

Google Cloud Platform の管理者アカウントを作成し、Google Cloud プロジェクトを作成しました。
管理者アカウントで Gmail API と管理者 SDK API を有効にしました。
サービスアカウントを作成し、Gmail の JSON プライベートキーをダウンロードしました。プライベートキーを作成してアクセスする方法については、Google Cloud のドキュメントの「サービスアカウントキーの作成方法」と「サービスアカウントの認証情報」を参照してください。
認証情報として使用する管理者アカウントの E メール、サービスアカウントの E メール、プライベートキーをコピーしました。

注記
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。
ユーザーおよびインデックスを作成する共有ディレクトリに、次の OAuth スコープ (管理者ロールを使用) を追加しました。
- https://www.googleapis.com/auth/admin.directory.user.readonly
- https://www.googleapis.com/auth/gmail.readonly
各ドキュメントが Gmail および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。

でAWS アカウント、以下があることを確認します。

Amazon Kendraインデックスを作成し、API を使用している場合はインデックス ID を記録しました。
データソースの IAMロールを作成し、 API を使用している場合はロールの ARN を記録しましたIAM。

注記
認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。
Gmail の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。

注記
認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨しません。

既存のIAMロールまたはシークレットがない場合は、Gmail データソースを接続するときにコンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。

接続手順

Gmail データソースAmazon Kendraに接続するには、がデータAmazon Kendraにアクセスできるように、Gmail 認証情報の詳細を指定する必要があります。Gmail をまだ設定していない場合はAmazon Kendra、「」を参照してください前提条件。

Console

Gmail Amazon Kendraに接続するには

にサインインAWS マネジメントコンソールし、 Amazon Kendraコンソールを開きます。
左側のナビゲーションペインで、[インデックス] を選択し、インデックスのリストから使用するインデックスを選択します。

注記
[インデックスの設定] で、[ユーザーアクセスコントロール] 設定を設定または編集できます。
[使用開始] ページで、[データソースを追加] を選択します。
[データソースを追加] ページで [Gmail コネクタ] を選択し、[コネクタを追加] を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた [Gmail コネクタ] を選択します。
[データソースの詳細を指定] ページで、次の情報を入力します。
1. [名前と説明] の [データソース名] に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。
2. (オプション) [説明] - オプションで、データソースの説明を入力します。
3. [デフォルト言語] - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。
4. タグで新しいタグを追加する - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。
5. [次へ] を選択します。
[アクセスとセキュリティの定義] ページで、次の情報を入力します。
1. [承認] - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
2. シーAWSSecrets Managerクレットの認証 — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Gmail 認証情報を保存します。新しいシークレットを作成すると、AWSSecrets Managerシークレットウィンドウが開きます。
  1. [AWS Secrets Manager シークレットウィンドウを作成] に次の情報を入力します。
    1. [シークレット名] - シークレットの名前。
    2. [クライアント E メール] - Google サービスアカウントからコピーしたクライアント E メール。
    3. [管理者アカウント E メール] - 使用する管理者アカウントの E メールです。
    4. [プライベートキー] - Google サービスアカウントからコピーしたプライベートキー。
    5. シークレットを保存して追加します。
3. [仮想プライベートクラウド (VPC)] - VPC の使用を選択できます。選択する場合は、[サブネット] と [VPC セキュリティグループ] を追加する必要があります。
4. IAMrole — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。
  
  注記
  IAMインデックスに使用されるロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、[新しいロールを作成] を選択してください。
5. [次へ] を選択します。
[同期設定の構成] ページで、次の情報を入力します。
1. [エンティティタイプ] - メッセージの添付ファイルを同期する場合に選択します。
2. (オプション) [追加設定] で、以下の情報を入力します。
  1. [期間] - クロールする E メールの開始日と終了日を指定するための期間を入力します。
  2. [E メールドメイン] — 「to」、「from」、「cc」、「bcc」の E メールドメインに基づいて、特定の E メールを含める、または除外します。
  3. [件名のキーワード] - E メールの件名のキーワードに基づいて、メールを含める、または除外します。
    
    注記
    また、入力した件名のキーワードすべてに一致するドキュメントを含めることもできます。
  4. [ラベル] - 特定の E メールラベルを含める、または除外するための正規表現パターンを追加します。
  5. [添付ファイル] - 特定の E メールの添付ファイルを含める、または除外するための正規表現パターンを追加します。
3. [同期モード] - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。
  - 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。
  - 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。
  重要
  完全に削除された Gmail メッセージを更新する API がないため、新規作成、変更、削除されたコンテンツの同期は以下のようになります。
  Gmail から完全に削除されたメッセージは、Amazon Kendra インデックスから削除されません
  
  Gmail のメールラベルの変更は同期されません。
  Gmail のデータソースラベルの変更や完全に削除されたメールメッセージを Amazon Kendra インデックスに同期するには、定期的にフルクロールを実行する必要があります。
4. [同期実行スケジュール] の [頻度] - データソースコンテンツを同期してインデックスを更新する頻度を選択します。
5. [次へ] を選択します。
[フィールドマッピングを設定] ページで、次の情報を入力します。
1. デフォルトのデータソースフィールド — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。
  
  注記
  Amazon KendraGmail データソースコネクタは、API の制限により、カスタムインデックスフィールドの作成をサポートしていません。
2. [次へ] を選択します。
[確認と作成] ページで、入力した情報が正しいことを確認し、[データソースを追加] を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが [データソース] ページに表示されます。

API

Gmail Amazon Kendraに接続するには

TemplateConfiguration API を使用してデータソーススキーマの JSON を指定する必要があります。これには、以下の情報を入力する必要があります。

[データソース] — TemplateConfiguration JSON スキーマを使用する場合は、データソースタイプを GMAIL と指定します。また、CreateDataSource API を呼び出す場合は、データソースを TEMPLATE と指定します。
同期モード — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。
- FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。
- FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
重要
完全に削除された Gmail メッセージを更新する API がないため、新規作成、変更、削除されたコンテンツの同期は以下のようになります。
- Gmail から完全に削除されたメッセージは、Amazon Kendra インデックスから削除されません
- Gmail のメールラベルの変更は同期されません。
Gmail データソースラベルの変更と完全に削除された E メールメッセージをAmazon Kendraインデックスに同期するには、定期的にフルクロールを実行する必要があります。
Secret Amazon Resource Name (ARN) — Gmail アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。
```
{
    "adminAccountEmailId": "service account email",
    "clientEmailId": "user account email",
    "privateKey": "private key"
}
```
IAMrole — を呼び出しCreateDataSourceて IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Gmail コネクタとに必要なパブリック APIsを呼び出すRoleArnタイミングを指定しますAmazon Kendra。詳細については、「IAM roles for Gmail data sources」を参照してください。

オプションで、次の機能を追加することもできます。

[仮想プライベートクラウド (VPC)] - VpcConfiguration で CreateDataSource を呼び出すタイミングを指定します。詳細については、「を使用するAmazon Kendraようにを設定するAmazon VPC」を参照してください。
[包含フィルターと除外フィルター] - 特定の「to」、「from」、「cc」、「bcc」の E メールを含める、または除外するかどうかを指定します。

注記
ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。
[ユーザーコンテキストのフィルタリングとアクセスコントロール] — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
フィールドマッピング - 選択すると、Gmail データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「データソースフィールドのマッピング」を参照してください。

注記
がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 _document_body にマッピングする必要があります。その他のすべてのフィールドはオプションです。

注記
Amazon KendraGmail データソースコネクタは、API の制限により、カスタムインデックスフィールドの作成をサポートしていません。

設定が必要なその他の重要な JSON キーのリストについては、「Gmail template schema」を参照してください。

詳細はこちら

Gmail データソースAmazon Kendraとの統合の詳細については、以下を参照してください。

Amazon Kendra の Gmail コネクタを使用して、Google ワークスペース内のメール全体でインテリジェントな検索を実行します。

注意事項

完全に削除された Gmail メッセージを更新する API がないため、FULL_CRAWL/[新規、変更、削除したコンテンツの同期] は以下のようになります。
- Gmail から完全に削除されたメッセージをAmazon Kendraインデックスから削除しない
- Gmail のメールラベルの変更は同期されません。
Gmail データソースラベルの変更と完全に削除された E メールメッセージをAmazon Kendraインデックスに同期するには、定期的にフルクロールを実行する必要があります。
Amazon KendraGmail データソースコネクタは、API の制限により、カスタムインデックスフィールドの作成をサポートしていません。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

GitHub

Google ドライブ