API で使用可能な設定

このドキュメントでは、Policy API がサポートする設定について説明します。

セキュリティ設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
アカウント復元 特権管理者アカウントの復元 security.super_admin_account_recovery 特権管理者が自分でアカウントを復元できるようにする enableAccountRecovery ブール値
ユーザー アカウントの復元 security.user_account_recovery ユーザーおよび特権管理者ではない管理者が自分でアカウントを復元できるようにする enableAccountRecovery ブール値
パスワードの管理 パスワードの管理 security.password 有効期限 expirationDuration 秒 （0 秒は期限なしを意味します）
再利用 allowReuse ブール値
長さと安全度の適用 enforceRequirementsAtLogin ブール値
長さ（最大長） maximumLength 整数
長さ（最小長） minimumLength 整数
長所 allowedStrength Enum: STRONG、 WEAK
Google セッションの管理 セッション管理 security.session_controls ウェブ セッション継続期間 webSessionDuration 数秒
安全性の低いアプリ 安全性の低いアプリ security.less_secure_apps 安全性の低いログイン技術を使用しているためアカウントの危険性を高めているアプリへのユーザー アクセスを制御します。 allowLessSecureApps ブール値
ログイン時の本人確認 ログイン時の本人確認 security.login_challenges ユーザーのセキュリティ強化のために従業員の ID を使用します enableEmployeeIdChallenge ブール値
高度な保護機能プログラム 登録 security.advanced_protection_program ユーザーのセキュリティ強化のために従業員の ID を使用します enableAdvancedProtectionSelfEnrollment ブール値
セキュリティ コード securityCodeOption 列挙型: ALLOWED_WITH_REMOTE_ACCESS、 ALLOWED_WITHOUT_REMOTE_ACCESS、 CODES_NOT_ALLOWED

UserTakeout の設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
データ [データのインポートとエクスポート] > [Google データ エクスポート] > [Google サービスでのデータ エクスポートへのユーザー アクセス] blogger.user_takeout books.user_takeout maps.user_takeout pay.user_takeout photos.user_takeout play.user_takeout play_console.user_takeout location_history.user_takeout youtube.user_takeout Google サービスにおけるデータ エクスポートへのユーザー アクセスを管理 takeout_status 列挙型: TAKEOUT_STATUS_UNSPECIFIED、 ENABLED、 DISABLED

Marketplace の設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
アプリのリスト アプリのリスト workspace_marketplace.apps_allowlist すべての組織部門のユーザーのアプリを表示しています アプリ application_id とアクセス ステータス（許可またはブロック）を含むアプリのリスト。
設定 [アプリへのアクセスを管理] > [Google Workspace Marketplace の許可リストへのアクセスを管理] workspace_marketplace.apps_access_options ユーザーに実行とインストールを許可する Marketplace アプリを選択します。 access_level 列挙型: ALLOW_ALL、 ALLOW_LISTED_APPS、 ALLOW_NONE

API レスポンスの設定 workspace_marketplace.apps_allowlist は、application_name ではなくマーケットプレイス application_id を公開します。次の Python スクリプトを使用すると、コマンドラインで指定された 1 つ以上の application_id を application_name に変換できます。

import re
import requests
import sys

output = {}
app_ids = sys.argv[1:]

for id in app_ids:
  url = f"https://workspace.google.com/marketplace/app/_/{id}"
  response = requests.get(url, allow_redirects=False)
  final_url = response.headers['Location']
  pattern = f"^https://workspace.google.com/marketplace/app/(.*)/{id}$"
  a = re.search(pattern, final_url)
  output[id] = a.group(1)

# Output application name captured from returned URL
print(output)

サービス ステータスの設定

service_status 設定には、特定の OrgUnit または Group でサービスが有効であることを示すブール値が含まれます。

Policy API は、管理コンソールの [アプリ] に表示される Workspace サービスとその他のサービスの両方のサービス ステータスの設定をサポートしています。

管理コンソールのサービス名 Policy API のサービス名
カレンダー カレンダー
Cloud Search cloud_search
ドライブとドキュメント drive_and_editors
Currents currents
ビジネス向け Google グループ groups_for_business
Jamboard jamboard
Keep keep
Google Chat チャット
Google Meet meet
Google Voice 音声
Google サイト Google サイト
ToDo リスト ToDo リスト
Vault Vault
ワーク インサイト work_insights
AppSheet appsheet
応用デジタルスキル applied_digital_skills
割り当て 割り当て
Blogger blogger
ブランド アカウント brand_accounts
キャンペーン マネージャー 360 campaign_manager
Chrome 描画キャンバス chrome_canvas
Chrome リモート デスクトップ chrome_remote_desktop
Chrome ウェブストア chrome_web_store
Classroom classroom
CS First cs_first
試験運用版アプリ experimental_apps
FeedBurner feedburner
Google アド マネージャー ad_manager
Google 広告 広告
Google AdSense adsense
Google アラート アラート
Google アナリティクス 分析
Google Arts & Culture arts_and_culture
Google ブックマーク bookmarks
Google ブックス ブックス
Google Chrome 同期 chrome_sync
Google Cloud cloud
Google クラウド プリント cloud_print
Google Colab colab
Google Developers デベロッパー
Google Domains ドメイン
Google Earth earth
Google Fi fi
Google グループ グループ
Google マップ マップ
Google メッセージ 新しいメッセージを投稿できます。
Google マイビジネス my_business
Google マイマップ my_maps
Google ニュース ニュース
Google Pay pay
Google フォト photos
Google Play play
Google Play Console play_console
Google 公共データ エクスプローラ public_data
Google Read Along read_along
Google Search Console search_console
Google データ エクスポート データ エクスポート
Google 翻訳 translate
Google Trips 旅行
ロケーション履歴 location_history
Looker Studio data_studio
managed Google Play managed_play
Material Gallery material_gallery
Merchant Center merchant_center
Partner Dash partner_dash
Pinpoint pinpoint
Google Play ブックス パートナー センター play_books_partner_center
プログラム可能検索エンジン programmable_search_engine
QuestionHub question_hub
Scholar プロフィール scholar_profiles
検索広告 360 search_ads_360
検索とアシスタント search_and_assistant
Socratic socratic
スタジオ スタジオ
サードパーティ製アプリのバックアップ third_party_app_backups
ツアー クリエイター tour_creator
YouTube youtube
追加サービス（個別のコントロールなし） enterprise_service_restrictions

Gmail の設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
Gmail [ユーザー設定] > [機密モデル] gmail.confidential_mode 情報保護モードを有効にする enable_confidential_mode ブール値
[ユーザー設定] > [S/MIME] gmail.enhanced_smime_encryption メール送受信で S/MIME 暗号化を有効にする enable_smime_encryption ブール値
独自証明書のアップロードをユーザーに許可する allow_user_to_upload_certificates ブール値
特定のドメインに関する追加のルート証明書を受け入れてください: custom_root_certificates ルート証明書のリスト、中間 CA 証明書のリスト、制限付きドメイン名のリスト、アドレスの不一致を許可するブール値、さまざまな検証レベルの列挙型を含む CustomRootCertificates のリスト。
[迷惑メール、フィッシング、マルウェア] > [メール配信前のスキャンの強化] gmail.enhanced_pre_delivery_message_scanning 配信前に不審なコンテンツを高い精度で検出できるようにします enable_improved_suspicious_content_detection ブール値
[迷惑メール、フィッシング、マルウェア] > [メールの許可リスト] gmail.email_spam_filter_ip_allowlist メールの許可リストに登録する IP アドレスを入力 allowed_ip_addresses 文字列のリスト
[安全性] > [なりすましと認証] gmail.spoofing_and_authentication 類似したドメイン名に基づくドメインのなりすましに対する保護機能 detect_domain_name_spoofing ブール値
操作を選択 domain_name_spoofing_consequence 列挙型: WARNING、 SPAM_FOLDER、 QUARANTINE、 NO_ACTION
従業員名のなりすましに対する保護機能 detect_employee_name_spoofing ブール値
操作を選択 employee_name_spoofing_consequences 列挙型: WARNING、 SPAM_FOLDER、 QUARANTINE、 NO_ACTION
受信メールによるドメインのなりすましに対する保護機能 detect_domain_spoofing_from_unauthenticated_senders ブール値
操作を選択 domain_spoofing_consequences 列挙型: WARNING、 SPAM_FOLDER、 QUARANTINE、 NO_ACTION
未認証メールに対する保護機能 detect_unauthenticated_emails ブール値
操作を選択 unauthenticated_email_consequences 列挙型: WARNING、 SPAM_FOLDER、 QUARANTINE、 NO_ACTION
受信メールによるドメインのなりすましから Google グループを保護 detect_groups_spoofing ブール値
この設定の適用対象 groups_spoofing_group_type 列挙型: PRIVATE_GROUPS_ONLY、 ALL_GROUPS
操作を選択 groups_spoofing_consequences 列挙型: WARNING、 SPAM_FOLDER、 QUARANTINE、 NO_ACTION
今後のおすすめの設定を自動的に適用 apply_future_settings_automatically ブール値
[安全性] > [リンクと外部画像] gmail.links_and_external_images 短縮 URL により隠されたリンクを特定 enable_shortener_scanning ブール値
リンク先の画像をスキャン enable_external_image_scanning ブール値
信頼できないドメインへのリンクをクリックした場合に警告メッセージを表示 enable_aggressive_warnings_on_untrusted_links ブール値
今後のおすすめの設定を自動的に適用 apply_future_settings_automatically ブール値
[安全性] > [アタッチメント] gmail.email_attachment_safety 信頼できない送信者から送られる暗号化された添付ファイルに対する保護機能 enable_encrypted_attachment_protection ブール値
操作を選択 encrypted_attachment_protection_consequence enum: WARNING、 SPAM_FOLDER、 QUARANTINE
信頼できない送信者から送られる、スクリプトを含む添付ファイルに対する保護機能 enable_attachment_with_scripts_protection ブール値
操作を選択 attachment_with_scripts_protection_consequence enum: WARNING、 SPAM_FOLDER、 QUARANTINE
異常な種類の添付ファイルに対する保護 enable_anomalous_attachment_protection ブール値
操作を選択 anomalous_attachment_protection_consequence enum: WARNING、 SPAM_FOLDER、 QUARANTINE
今後のおすすめの設定を自動的に適用 apply_future_recommended_settings_automatically ブール値

チャットの設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
Google Chat チャットの履歴 chat.chat_history 履歴がオンまたはオフになっている history_on_by_default ブール値
ユーザーに履歴設定の変更を許可する allow_user_modification ブール値
チャット内でのファイル共有 chat.chat_file_sharing 外部とのファイル共有 external_file_sharing 列挙型: ALL_FILES、 IMAGES_ONLY、 NO_FILES、 FILE_SHARING_OPTION_UNSPECIFIED
internal_file_sharing 同じ
スペースの履歴 chat.space_history スペースの会話履歴の設定 history_state 列挙型: DEFAULT_HISTORY_ON、 DEFAULT_HISTORY_OFF、 HISTORY_ALWAYS_ON、 HISTORY_ALWAYS_OFF、 HISTORY_STATE_UNSPECIFIED
外部チャットの設定 chat.external_chat_restriction ユーザーがチャットとスペースで組織外にメッセージを送信できるようにする allow_external_chat ブール値
external_chat_restriction 列挙型: NO_RESTRICTION、 TRUSTED_DOMAINS、 RESTRICTION_UNSPECIFIED
Chat 用アプリ chat.chat_apps_access ユーザーに Chat 用アプリのインストールを許可する enable_apps ブール値
ユーザーに着信 Webhook の追加と使用を許可する enable_webhooks ブール値

ドライブとドキュメントの設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
ドライブとドキュメント [共有設定] > [共有オプション] drive_and_docs.external_sharing $CUSTOMER_NAME の外部に許可する最大の共有レベルを選択する external_sharing_mode 列挙型: DISALLOWED、 ALLOWLISTED_DOMAINS、 ALLOWED
$ORG_UNIT_NAME のユーザーが $CUSTOMER_NAME 外のユーザーまたは共有ドライブからファイルを受信することを許可する allow_receiving_external_files ブール値
$ORG_UNIT_NAME のユーザーまたは共有ドライブがオーナーとなっているファイルが許可リスト登録済みドメインのユーザーと共有されたときに警告する warn_for_sharing_outside_allowlisted_domains ブール値
許可リスト登録済みドメイン外のユーザーまたは共有ドライブからのファイル受信を $ORG_UNIT_NAME のユーザーに許可する allow_receiving_files_outside_allowlisted_domains ブール値
$ORG_UNIT_NAME のユーザーまたは共有ドライブが、ビジターとの共有機能を使用して、信頼できるドメイン内の Google アカウントを持たないユーザーとアイテムを共有することを許可する allow_non_google_invites_in_allowlisted_domains ブール値
$ORG_UNIT_NAME のユーザーまたは共有ドライブがオーナーとなっているファイルが $CUSTOMER_NAME の外部で共有されたときに警告する warn_for_external_sharing ブール値
$ORG_UNIT_NAME のユーザーまたは共有ドライブが、Google アカウントを使用していない $CUSTOMER_NAME 外のユーザーとアイテムを共有することを許可する allow_non_google_invites ブール値
$CUSTOMER_NAME の外部との共有が許可されている場合、$ORG_UNIT_NAME 内のユーザーは、リンクを知っているすべてのユーザーに対して、ファイルおよび公開済みのウェブ コンテンツを公開することができます allow_publishing_files ブール値
ユーザーが Google ドキュメントや Google ドライブ以外の Google サービス経由でファイルを共有した場合（例: Gmail にリンクを貼り付ける）、共有相手にファイルへのアクセス権があるかどうかを確認できます。アクセス権が共有相手にない場合、次のユーザーとファイルを共有してよいかどうかの確認を求めるメッセージを表示します（可能な場合） access_checker_suggestions 列挙型: RECIPIENTS_OR_AUDIENCE_OR_PUBLIC、 RECIPIENTS_OR_AUDIENCE、 RECIPIENTS_ONLY
$ORG_UNIT_NAME のコンテンツを $CUSTOMER_NAME の外部に送信できるユーザーを選択します。この設定を行うことで、別の組織が所有する共有ドライブにコンテンツをアップロード、移動できるユーザーを制限できます allowed_parties_for_distributing_content 列挙型: ALL_ELIGIBLE_USERS、 ELIGIBLE_INTERNAL_USERS、 NONE
[共有設定] > [一般的なアクセスのデフォルト] drive_and_docs.general_access_default $ORG_UNIT_NAME 内のユーザーがアイテムを作成すると、デフォルトのアクセスは次のようになります default_file_access 列挙型: PRIVATE_TO_OWNER、 PRIMARY_AUDIENCE_WITH_LINK、 PRIMARY_AUDIENCE_WITH_LINK_OR_SEARCH
[共有設定] > [共有ドライブの作成] drive_and_docs.shared_drive_creation $ORG_UNIT_NAME のユーザーが新しい共有ドライブを作成できないようにする allow_shared_drive_creation ブール値（API レスポンスは UI 値の反対を返します）
$ORG_UNIT_NAME 内のユーザーが作成した共有ドライブは、以下の組織部門に割り当てられます org_unit_for_new_shared_drives Enum: CREATOR_ORG_UNIT、 CUSTOM_ORG_UNIT
選択した組織部門 custom_org_unit String（文字列）
管理者権限を持つユーザーが、以下の設定をオーバーライドできるようになります allow_managers_to_override_settings ブール値
$CUSTOMER_NAME 外のユーザーが共有ドライブ内のファイルにアクセスできるようにする allow_external_user_access ブール値
共有ドライブのメンバー以外のユーザーに、ファイルの追加を許可します allow_non_member_access ブール値
閲覧者およびコメント可の閲覧者がファイルをダウンロード、印刷、コピーできるようになります allowed_parties_for_download_print_copy 列挙型: ALL（UI のチェックボックスがオンの場合）、 EDITORS_ONLY（UI のチェックボックスがオフの場合）
コンテンツ管理者にフォルダの共有を許可する allow_content_managers_to_share_folders ブール値
[共有設定] > [ファイルのセキュリティ アップデート] drive_and_docs.file_security_update このアップデートを適用すると、ファイルリンクの安全性が強化されます。アップデート適用時に、ファイルへのアクセス リクエストがユーザーに届く場合があります security_update 列挙型: APPLY_TO_IMPACTED_FILES、 REMOVE_FROM_IMPACTED_FILES
所有または管理しているファイルに対して、ユーザー自身でセキュリティ アップデートを削除または適用できるようにする allow_users_to_manage_update ブール値
[機能とアプリケーション] > [ドライブ SDK] drive_and_docs.drive_sdk Drive SDK API 経由での Google ドライブへのアクセスをユーザーに許可する enable_drive_sdk_api_access ブール値
[パソコン版 Google ドライブ] > [パソコン版ドライブを有効にする] drive_and_docs.drive_for_desktop 組織内でのパソコン版 Google ドライブの使用を許可する allow_drive_for_desktop ブール値
承認されたデバイスでのみパソコン版 Google ドライブの使用を許可する restrict_to_authorized_devices ブール値
パソコン版 Google ドライブのダウンロード リンクを表示する show_download_link ブール値
ユーザーにパソコン版 Google ドライブからの Microsoft Office のリアルタイム プレゼンス機能の有効化を許可する allow_real_time_presence ブール値

Meet の設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
Google Meet [Meet の動画設定] > [録画] meet.video_recording ユーザーに会議の録画を許可します。 enable_recording ブール値
[Meet の安全性設定] > [ドメイン] meet.safety_domain 組織内で作成された会議に参加できるユーザー。 users_allowed_to_join 列挙型: SAME_ORGANIZATION_ONLY、 LOGGED_IN、 ALL
[Meet の安全性設定] > [アクセス] meet.safety_access 組織内のユーザーが参加できる会議または通話。[着信制限] を使うと、ユーザーによる通話の着信をより詳細に制限できます。 meetings_allowed_to_join 列挙型: SAME_ORGANIZATION_ONLY、 ANY_WORKSPACE_ORGANIZATION、 ALL
[Meet の安全性設定] > [主催者向けの管理機能] meet.safety_host_management 主催者向けのデフォルトの管理機能 enable_host_management ブール値
Meet の安全性設定 > [外部の参加者に関する警告] meet.safety_external_participants 「組織」の外部にいるか、身元が確認されていない参加者を示します。 enable_external_label ブール値

サイト設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
Google サイト [新しい Google サイト] > [サイトの作成と編集] sites.sites_creation_and_modification ユーザーに新しいサイトの作成を許可する allowSitesCreation ブール値
ユーザーがサイトを編集できる/できない allowSitesModification ブール値

ビジネス向け Google グループの設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
ビジネス向け Google グループ [共有設定] > [共有オプション] groups_for_business.groups_sharing グループの共有設定を変更する場合のポリシーを設定します collaborationCapability 列挙型: ANYONE_CAN_ACCESS、 DOMAIN_USERS_ONLY
グループの作成 createGroupsAccessLevel 列挙型: ADMIN_ONLY、 USERS_IN_DOMAIN、 ANYONE_CAN_CREATE
グループ オーナーは外部メンバーを許可できる ownersCanAllowExternalMembers ブール値
グループ オーナーは組織外からのメールの受信を許可できる ownersCanAllowIncomingMailFromPublic ブール値
スレッドのデフォルトの閲覧権限 viewTopicsDefaultAccessLevel 列挙型: OWNERS、 MANAGERS、 GROUP_MEMBERS、 DOMAIN_USERS、 ANYONE_CAN_VIEE_TOPICS
グループ オーナーはグループをディレクトリに表示しないようにできる ownersCanHideGroups ブール値
新たに作成されたグループをディレクトリに表示しない newGroupsAreHidden ブール値

Classroom の設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
Classroom [全般設定] > [教師の権限] classroom.teacher_permissions クラスを作成できるユーザー whoCanCreateClasses 列挙型: ANYONE_IN_DOMAIN、 ALL_PENDING_AND_VERIFIED_TEACHERS、 VERIFIED_TEACHERS_ONLY
[全般設定] > [保護者のアクセス] classroom.guardian_access 保護者に Classroom 情報へのアクセスを許可する allowAccess ブール値
保護者を管理できるユーザー whoCanManageGuardianAccess 列挙型: VERIFIED_TEACHERS_AND_DOMAIN_ADMINS、 DOMAIN_ADMINS_ONLY
[クラスの設定] > [クラスのメンバーについて] classroom.class_membership ドメインのクラスに参加できるユーザー whoCanJoinClasses 列挙型: ANYONE_IN_DOMAIN、 ANYONE_IN_ALLOWLISTED_DOMAINS、 ANY_GOOGLE_WORKSPACE_USER、 ANYONE
このドメインのユーザーが参加できるクラス whichClassesCanUsersJoin 列挙型: CLASSES_IN_DOMAIN、 CLASSES_IN_ALLOWLISTED_DOMAINS、 ANY_GOOGLE_WORKSPACE_CLASS
[データアクセス] > [Classroom API] classroom.api_data_access ユーザーは、Google Classroom データへのアクセスをアプリに許可することができます enableApiAccess ブール値
[独自性レポート] > [校内での一致] classroom.originality_reports 独自性レポートで校内での一致を有効にする enableOriginalityReportsSchoolMatches ブール値
[生徒の登録解除] > [登録解除の権限] classroom.student_unenrollment 生徒のクラス登録を解除できるユーザー whoCanUnenrollStudents 列挙型 STUDENTS_AND_TEACHERS、 TEACHERS_ONLY
[名簿のインポート] > [設定] classroom.roster_import 名簿のインポート rosterImportOption 列挙型: OFF、 ON_CLEVER

データ保護ルールの設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
データの保護 [セキュリティ] > [アクセスとデータ管理] > [データ保護] > [ルールを管理] rule.dlp 名前 display_name String（文字列）
説明 説明 String（文字列）
アプリ トリガー String[] - アプリ固有のトリガー文字列のリスト。使用可能なアプリ トリガーのリストについては、次の「トリガー」セクションをご覧ください。
条件 condition 文字列 - ルールがスキャンするデータ条件の Common Expression Language（CEL）式。CEL の構文と一般的な例については、次の条件セクションをご覧ください。
操作 action 構造体 - 条件が満たされたときに実行するアプリ固有のアクションを表すネストされたオブジェクト。アプリ トリガーごとに利用可能なアクションについては、次の「アクション」セクションをご覧ください。
状態 状態 列挙型: ACTIVE、 INACTIVE
作成済み create_time タイムスタンプ
最終更新 update_time タイムスタンプ
ルールタイプ固有のメタデータ rule_type_metadata 構造体 - ルールタイプ固有のメタデータを表すネストされたオブジェクト。データ保護ルールの場合、トリガーされたイベントの重大度レベルが含まれます。

トリガー

使用可能なアプリケーションとそのトリガーのリスト。

  • "google.workspace.chrome.file.v1.upload"
  • "google.workspace.chrome.file.v1.download"
  • "google.workspace.chrome.web_content.v1.upload"
  • "google.workspace.chrome.page.v1.print"
  • "google.workspace.chrome.url.v1.navigation"
  • "google.workspace.chromeos.file.v1.transfer"
  • "google.workspace.chat.message.v1.send"
  • "google.workspace.chat.attachment.v1.upload"
  • "google.workspace.drive.file.v1.share"
  • "google.workspace.gmail.email.v1.send"

条件

API は、データ条件を表すために Common Expressions Language（CEL）式を使用します。各条件は {content type}.{content to scan for}({additional scan parameters}) のパターンに従います。たとえば、all_content.contains('apple') は、スキャンされたコンテンツ（ドライブのドキュメント、チャット メッセージなど）のいずれかに部分文字列 apple が含まれている場合に一致するデータ条件を表します。

コンテンツ タイプ

管理コンソールで同じ名前の一致する設定に対応する、使用可能なコンテンツ タイプのリスト。

  • access_levels
  • all_content
  • all_headers
  • body
  • destination_type
  • destination_url
  • drive_enterprise_metadata
  • encryption_state
  • envelope_from
  • file_size_in_bytes
  • file_type
  • from_header
  • message_security_status
  • request_attributes
  • sender_header
  • source_chrome_context
  • source_url
  • source_url_category
  • 件名
  • 提案
  • target_user
  • タイトル
  • to_header_recipients
  • URL
  • url_category

スキャンするコンテンツ

管理コンソールで同じ名前の一致する設定に対応する、スキャン可能なコンテンツのリスト。

  • contains({string})
  • starts_with({string})
  • ends_with({string})
  • equals({string})
  • matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
    • 管理コンソールの [事前定義されたデータ型と一致する] オプションに対応しています。
    • {detector name} は、スキャンする事前定義されたデータ型を表します。これは、Cloud DLP でサポートされている組み込み infoType のいずれかです（https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference）。たとえば、CREDIT_CARD_NUMBER や、US_SOCIAL_SECURITY_NUMBER です
    • {likelihood} は、一致の確率しきい値を表します。たとえば、google.privacy.dlp.v2.Likelihood.LIKELY は、管理コンソールの [高] しきい値に対応しています。
  • matches_regex_detector({detector name}, {minimum_match_count: {count}})
    • 管理コンソールの [正規表現一致] オプションに対応しています。
    • {detector name} は、正規表現検出機能を表すポリシーのリソース名です。API で検出機能ポリシーをクエリする方法については、データ保護検出機能のセクションをご覧ください。
  • matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
    • 管理コンソールの [単語リスト内の単語に一致する] オプションに対応しています。
    • {detector name} は、単語リスト検出機能を表すポリシーのリソース名です。API で検出機能ポリシーをクエリする方法については、データ保護検出機能のセクションをご覧ください。
  • matches_web_category({category})
    • Chrome の [アクセスした URL] トリガーの管理コンソールの [URL カテゴリが一致する] オプションに対応しています。
    • {category} は、管理コンソールの設定でサポートされている URL カテゴリを表します。たとえば、ADULT や、ONLINE_COMMUNITIES__SOCIAL_NETWORKS です。

複合条件

複数の基本条件を AND（&&）、OR（||）、NOT（!）演算子で組み合わせて、複合条件を作成できます。たとえば、"all_content.contains('apple') && all_content.contains('banana')" は、スキャンされたコンテンツのいずれかに「apple」と「banana」の両方の部分文字列が含まれている場合に一致する条件を表します。

アクション

各アプリケーションは、ネストされたメッセージでデータ条件が一致した場合に実行するアクションを指定します。たとえば、{ "driveAction" { "warnUser" { } } } は、外部共有についてユーザーに警告するドライブのアクションを表します。利用可能なアプリケーション固有のアクションは次のとおりです。

アプリケーション アクションキー サブアクション 管理コンソールのキャプション
ドライブ driveAction blockAccess 外部共有をブロック
warnUser 外部との共有を警告する
auditOnly no action
restrictCopyPrintDownload ダウンロード、印刷、コピーの無効化
applyLabels 分類ラベルを適用
Gmail gmailAction blockContent メッセージをブロック
warnUser ユーザーに警告
auditOnly 監査のみ
quarantineMessage メールを検疫
チャット chatAction blockContent メッセージをブロック
warnUser ユーザーに警告
auditOnly 監査のみ
Chrome chromeAction blockContent ブロック
warnUser 許可して警告を表示

ルールタイプ固有のメタデータ

この属性には、ルールタイプに固有のメタデータが含まれます。データ保護ルールの場合、セキュリティ ダッシュボードとアラート センターでイベントが報告されたときのアラート イベントの重大度が含まれます。アラートの重大度が LOW を表すメタデータの値の例:

fields {
  key: "ruleTypeMetadata"
  value {
    struct_value {
      fields {
        key: "dlpRuleMetadata"
        value {
          struct_value {
            fields {
              key: "alertSeverity"
              value {
                string_value: "LOW"
              }
            }
          }
        }
      }
    }
  }
}

データ保護検出機能の設定

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
データの保護 [セキュリティ] > [アクセスとデータ管理] > [データ保護] > [検出機能を管理] detector.regular_expression detector.word_list 名前 display_name String（文字列）
説明 説明 String（文字列）
正規表現 regular_expression 構造体 - 正規表現文字列が含まれます。検出機能のタイプが detector.regular_expression の場合にのみ設定します。
単語リスト word_list 文字列 - 単語文字列のリストが含まれます。検出機能のタイプが detector.word_list の場合にのみ設定します。
作成済み create_time タイムスタンプ
最終更新 update_time タイムスタンプ

システム定義のアラートルール設定

ベータ版のリリースでは、admin-modified システム定義アラート（通知設定がデフォルト値から変更されているアラート）のみが API から返されます。

管理コンソールのページ 管理コンソールの特定の設定 Policy API の設定タイプ 管理コンソールのキャプション Policy API のフィールド名 Data Type
データの保護 ルール（「システム定義」ルールタイプの場合） rule.system_defined_alerts 名前 display_name String（文字列）
説明 説明 String（文字列）
操作 action 構造体 - システム定義のアラートがトリガーされたときの通知設定を表すネストされたオブジェクト。詳細については、次の「アクション」セクションを参照してください。
状態 状態 列挙型: ACTIVE、 INACTIVE
作成済み create_time タイムスタンプ
最終更新 update_time タイムスタンプ

アクション

システム定義のアラートルールには、アラートの通知設定を表す単一のアクションがあります。

アクションキー サブアクション 管理コンソールのキャプション
alertCenterAction alertCenterConfig アラート センターに送信する
受信者 メール通知を送信する