Configurações disponíveis na API

Visualização

Este produto ou recurso está sujeito aos "Termos das ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos do serviço. Os produtos e recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Este documento descreve as configurações compatíveis com a API Policy.

Configurações de segurança

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Recuperação de conta	Recuperação de conta de superadministrador	security.super_admin_account_recovery	Permitir que os superadministradores recuperem a conta	enableAccountRecovery	Booleano
	Recuperação de conta de usuário	security.user_account_recovery	Permitir que usuários e administradores (exceto superadministradores) recuperem as contas	enableAccountRecovery	Booleano
Gerenciamento de senhas	Gerenciamento de senhas	security.password	Expiração	expirationDuration	Segundos (0 segundo significa Nunca expirar)
			Reutilização	allowReuse	Booleano
			Aplicação de força e tamanho	enforceRequirementsAtLogin	Booleano
			Comprimento (comprimento máximo)	maximumLength	Número inteiro
			Comprimento (comprimento mínimo)	minimumLength	Número inteiro
			Ponto forte	allowedStrength	Enum: STRONG, WEAK
Google Session Control	Controle da sessão	security.session_controls	Duração da sessão da Web	webSessionDuration	Segundos
Apps menos seguros	Apps menos seguros	security.less_secure_apps	Controle o acesso dos usuários a apps que usam tecnologias de login menos seguras e deixam as contas mais vulneráveis.	allowLessSecureApps	Booleano
Desafios de login	Desafios de login	security.login_challenges	Usar o ID de funcionário para aumentar a proteção dos meus usuários	enableEmployeeIdChallenge	Booleano
Programa Proteção Avançada	Inscrição	security.advanced_protection_program	Usar o ID de funcionário para aumentar a proteção dos meus usuários	enableAdvancedProtectionSelfEnrollment	Booleano
			Códigos de segurança	securityCodeOption	Enumeração: ALLOWED_WITH_REMOTE_ACCESS, ALLOWED_WITHOUT_REMOTE_ACCESS, CODES_NOT_ALLOWED

Configurações do UserTakeout

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Dados	Importação de dados e exportar > Google Takeout > Acesso do usuário ao Takeout para Serviços do 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	Gerenciar o acesso do usuário ao Takeout para Serviços do Google	takeout_status	enumeração: TAKEOUT_STATUS_UNSPECIFIED, ENABLED, DISABLED

Configurações do Google Apps Marketplace

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Lista de apps	Lista de apps	workspace_marketplace.apps_allowlist	Mostrar apps para usuários em todas as unidades organizacionais	apps	Lista de apps que contêm application_id e status de acesso como ALLOWED ou BLOCKED.
Configurações	Gerenciar o acesso a apps > Gerenciar o acesso à lista de permissões do Google Workspace Marketplace	workspace_marketplace.apps_access_options	Selecione os apps do Marketplace que os usuários podem executar e instalar.	access_level	Enum: ALLOW_ALL, ALLOW_LISTED_APPS, ALLOW_NONE

A configuração workspace_marketplace.apps_allowlist na resposta da API expõe o application_id do Marketplace em vez do application_name. O script Python a seguir pode ser usado para converter um ou mais application_id especificados na linha de comando para 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)

Configurações de status do serviço

A configuração service_status contém um valor booleano que implica que um serviço está ativado para um determinado OrgUnit ou Group.

A API Policy oferece suporte a configurações de status de serviço para serviços do Workspace e serviços adicionais listados no Admin Console em Apps.

Nome do serviço no Admin Console	Nome do serviço da API Policy
Agenda	calendário
Cloud Search	cloud_search
Drive e Documentos	drive_and_editors
Currents	currents
Grupos para empresas	groups_for_business
Jamboard	jamboard
Keep	keep
Google Chat	chat
Google Meet	meet
Google Voice	voz
Google Sites	sites
Tarefas	tarefas
Vault	vault
Work Insights	work_insights
AppSheet	AppSheet
Habilidades digitais aplicadas	applied_digital_skills
Atividades	atividades
Blogger	blogger
Contas de marca	brand_accounts
Campaign Manager 360	campaign_manager
Chrome Canvas	chrome_canvas
Área de trabalho remota do Google Chrome	chrome_remote_desktop
Chrome Web Store	chrome_web_store
Google Sala de Aula	classroom
CS First	cs_first
Apps experimentais	experimental_apps
FeedBurner	feedburner
Google Ad Manager	ad_manager
Google Ads	anúncios
Google AdSense	adsense
Alertas do Google	alertas
Google Analytics	analytics
Google Arts & Culture	arts_and_culture
Favoritos do Google	bookmarks
Google Livros	livros
Sincronização do Google Chrome	chrome_sync
Google Cloud	nuvem
Google Cloud Print	cloud_print
Google Colab	colab
Google Developers	desenvolvedores
Google Domains	domínios
Google Earth	terra
Google Fi	fi
Grupos do Google	grupos
Google Maps	mapas
Google Mensagens	mensagens
Google Meu Negócio	my_business
Google My Maps	my_maps
Google Notícias	notícias
Google Pay	pagar
Google Fotos	photos
Google Play	reproduzir
Google Play Console	play_console
Pesquisa de Dados Públicos do Google	public_data
Google Leitura Guiada	read_along
Google Search Console	search_console
Google Takeout	para viagem
Google Tradutor	translate
Google Trips	trips
Histórico de localização	location_history
Looker Studio	data_studio
Google Play gerenciado	managed_play
Material Gallery	material_gallery
Merchant Center	merchant_center
Partner Dash	partner_dash
Pinpoint	apontar
Central de parceiros do Play Livros	play_books_partner_center
Mecanismo de Pesquisa Programável	programmable_search_engine
Question Hub	question_hub
Perfis do Google Acadêmico	scholar_profiles
Search Ads 360	search_ads_360
Pesquisa e Assistente	search_and_assistant
Socratic	socratic
Studio	studio
Backups de apps de terceiros	third_party_app_backups
Criador de Tours Virtuais	tour_creator
YouTube	youtube
Serviços adicionais sem controle individual	enterprise_service_restrictions

Configurações do Gmail

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Gmail	Configurações do usuário > Modelo confidencial	gmail.confidential_mode	Ativar o modo confidencial	enable_confidential_mode	booleano
	Configurações do usuário > S/MIME	gmail.enhanced_smime_encryption	Ativar a criptografia S/MIME para enviar e receber e-mails	enable_smime_encryption	booleano
			Permitir que os usuários façam upload dos próprios certificados	allow_user_to_upload_certificates	booleano
			Aceite estes certificados raiz adicionais para domínios específicos:	custom_root_certificates	Uma lista de CustomRootCertificates que contém uma lista de certificados raiz, uma lista de certificados de AC intermediários, uma lista de nomes de domínio restritos, um booleano para permitir incompatibilidade de endereço e um tipo enumerado com diferentes níveis de validação.
	Spam, phishing e malware > Verificação aprimorada de mensagens de pré-entrega	gmail.enhanced_pre_delivery_message_scanning	Melhora a detecção de conteúdo suspeito antes da entrega	enable_improved_suspicious_content_detection	booleano
	Spam, phishing e malware > Lista de e-mails permitidos	gmail.email_spam_filter_ip_allowlist	Digite os endereços IP da sua lista de e-mails permitidos	allowed_ip_addresses	Uma lista de strings
	Segurança > Spoofing e autenticação	gmail.spoofing_and_authentication	Proteger contra spoofing de domínio com base em nomes de domínio semelhantes	detect_domain_name_spoofing	booleano
			Escolha uma ação	domain_name_spoofing_consequence	Enumeração: WARNING, SPAM_FOLDER, QUARANTINE, NO_ACTION
			Proteger contra spoofing de nomes de funcionários	detect_employee_name_spoofing	booleano
			Escolha uma ação	employee_name_spoofing_consequences	Enum: WARNING, SPAM_FOLDER, QUARANTINE, NO_ACTION
			Proteger contra o recebimento de e-mails que façam spoofing do seu domínio	detect_domain_spoofing_from_unauthenticated_senders	booleano
			Escolha uma ação	domain_spoofing_consequences	Enumeração: WARNING, SPAM_FOLDER, QUARANTINE, NO_ACTION
			Proteger contra e-mails não autenticados	detect_unauthenticated_emails	booleano
			Escolha uma ação	unauthenticated_email_consequences	Enumeração: WARNING, SPAM_FOLDER, QUARANTINE, NO_ACTION
			Proteger seus Grupos contra o recebimento de e-mails que façam spoofing do domínio	detect_groups_spoofing	booleano
			Aplicar esta configuração a	groups_spoofing_group_type	Enum: PRIVATE_GROUPS_ONLY, ALL_GROUPS
			Escolha uma ação	groups_spoofing_consequences	Enumeração: WARNING, SPAM_FOLDER, QUARANTINE, NO_ACTION
			Aplicar automaticamente as futuras configurações recomendadas	apply_future_settings_automatically	booleano
	Segurança > Links e imagens externas	gmail.links_and_external_images	Identificar links em URLs abreviados	enable_shortener_scanning	booleano
			Verificar imagens de links	enable_external_image_scanning	booleano
			Mostrar avisos quando alguém clicar em qualquer link de domínios não confiáveis	enable_aggressive_warnings_on_untrusted_links	booleano
			Aplicar automaticamente as futuras configurações recomendadas	apply_future_settings_automatically	booleano
	Segurança > Anexos	gmail.email_attachment_safety	Proteger contra anexos criptografados de remetentes não confiáveis	enable_encrypted_attachment_protection	booleano
			Escolha uma ação	encrypted_attachment_protection_consequence	enumeração: WARNING, SPAM_FOLDER, QUARANTINE
			Proteger contra anexos com scripts de remetentes não confiáveis	enable_attachment_with_scripts_protection	booleano
			Escolha uma ação	attachment_with_scripts_protection_consequence	enum: WARNING, SPAM_FOLDER, QUARANTINE
			Proteger contra tipos de anexo anômalos em e-mails	enable_anomalous_attachment_protection	booleano
			Escolha uma ação	anomalous_attachment_protection_consequence	enumeração: WARNING, SPAM_FOLDER, QUARANTINE
			Aplicar automaticamente as futuras configurações recomendadas	apply_future_recommended_settings_automatically	booleano

Configurações de bate-papo

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Google Chat	Histórico de chats	chat.chat_history	O histórico está ATIVADO/DESATIVADO	history_on_by_default	booleano
			Permitir que os usuários mudem a configuração do histórico	allow_user_modification	booleano
	Compartilhamento de arquivos do Chat	chat.chat_file_sharing	Compartilhamento externo de arquivos	external_file_sharing	enumeração: ALL_FILES, IMAGES_ONLY, NO_FILES, FILE_SHARING_OPTION_UNSPECIFIED
				internal_file_sharing	mesma
	Histórico de espaços	chat.space_history	Configurações do histórico de conversas dos espaços	history_state	tipo enumerado: DEFAULT_HISTORY_ON, DEFAULT_HISTORY_OFF, HISTORY_ALWAYS_ON, HISTORY_ALWAYS_OFF, HISTORY_STATE_UNSPECIFIED
	Configurações externas do Chat	chat.external_chat_restriction	Permitir que os usuários enviem mensagens fora da organização em chats e espaços	allow_external_chat	booleano
				external_chat_restriction	enum: NO_RESTRICTION, TRUSTED_DOMAINS, RESTRICTION_UNSPECIFIED
	Apps de chat	chat.chat_apps_access	Permitir que os usuários instalem apps de chat	enable_apps	booleano
			Permitir que os usuários adicionem e usem webhooks de entrada	enable_webhooks	booleano

Configurações do Drive e do Documentos

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Google Drive e Documentos Google	Configurações de compartilhamento > Opções de compartilhamento	drive_and_docs.external_sharing	Selecione o nível mais alto de compartilhamento fora de $CUSTOMER_NAME que você quer permitir	external_sharing_mode	Enum: DISALLOWED, ALLOWLISTED_DOMAINS, ALLOWED
			Permitir que os usuários em $ORG_UNIT_NAME recebam arquivos de usuários ou drives compartilhados fora de $CUSTOMER_NAME	allow_receiving_external_files	Booleano
			Avisar quando arquivos de usuários ou drives compartilhados em $ORG_UNIT_NAME forem compartilhados com usuários em domínios permitidos	warn_for_sharing_outside_allowlisted_domains	Booleano
			Permitir que os usuários em $ORG_UNIT_NAME recebam arquivos de usuários ou drives compartilhados fora dos domínios na lista de permissões	allow_receiving_files_outside_allowlisted_domains	Booleano
			Permitir que usuários ou drives compartilhados em $ORG_UNIT_NAME compartilhem itens com usuários que não são do Google em domínios confiáveis usando o compartilhamento com visitantes	allow_non_google_invites_in_allowlisted_domains	Booleano
			Avisar quando arquivos de usuários ou drives compartilhados em $ORG_UNIT_NAME forem compartilhados fora de $CUSTOMER_NAME	warn_for_external_sharing	Booleano
			Permitir que usuários ou drives compartilhados em $ORG_UNIT_NAME compartilhem itens com pessoas fora de $CUSTOMER_NAME que não usam uma Conta do Google	allow_non_google_invites	Booleano
			Quando o compartilhamento fora de $CUSTOMER_NAME é permitido, os usuários em $ORG_UNIT_NAME podem tornar os arquivos e o conteúdo da Web publicado visível para qualquer pessoa com o link	allow_publishing_files	Booleano
			Quando um usuário compartilha um arquivo por meio de um produto do Google que não seja o Documentos nem o Drive (por exemplo, colando um link no Gmail), o Google verifica se os destinatários têm acesso. Se eles não tiverem acesso, quando for possível, o Google perguntará se o usuário quer compartilhar o arquivo com:	access_checker_suggestions	Enum: RECIPIENTS_OR_AUDIENCE_OR_PUBLIC, RECIPIENTS_OR_AUDIENCE, RECIPIENTS_ONLY
			Selecione quem terá permissão para distribuir o conteúdo na unidade organizacional $ORG_UNIT_NAME fora do cliente $CUSTOMER_NAME. Isso restringe quem pode fazer upload ou mover conteúdo para drives compartilhados de outra organização	allowed_parties_for_distributing_content	Enum: ALL_ELIGIBLE_USERS, ELIGIBLE_INTERNAL_USERS, NONE
	Configurações de compartilhamento > Padrão de acesso geral	drive_and_docs.general_access_default	Quando os usuários em $ORG_UNIT_NAME criarem itens, o acesso padrão será	default_file_access	Enum: PRIVATE_TO_OWNER, PRIMARY_AUDIENCE_WITH_LINK, PRIMARY_AUDIENCE_WITH_LINK_OR_SEARCH
	Configurações de compartilhamento > Criação do drive compartilhado	drive_and_docs.shared_drive_creation	Impedir que os usuários na unidade organizacional $ORG_UNIT_NAME criem drives compartilhados	allow_shared_drive_creation	Booleano (a resposta da API retorna o oposto do valor da interface)
			Quando os usuários em $ORG_UNIT_NAME criarem um drive compartilhado, ele será atribuído à unidade organizacional a seguir	org_unit_for_new_shared_drives	Enum: CREATOR_ORG_UNIT, CUSTOM_ORG_UNIT
			Unidade organizacional selecionada	custom_org_unit	String
			Permitir que os participantes com acesso de administrador substituam as configurações abaixo	allow_managers_to_override_settings	Booleano
			Permitir que usuários fora de $CUSTOMER_NAME acessem arquivos em drives compartilhados	allow_external_user_access	Booleano
			Permitir que pessoas que não são participantes do drive compartilhado sejam adicionadas a arquivos	allow_non_member_access	Booleano
			Permitir que leitores e comentaristas façam o download, a impressão e a cópia de arquivos	allowed_parties_for_download_print_copy	Enumeração: ALL (quando a caixa de seleção na interface está marcada), EDITORS_ONLY (quando a caixa de seleção na interface está desmarcada)
			Permitir que administradores de conteúdo compartilhem pastas	allow_content_managers_to_share_folders	Booleano
	Configurações de compartilhamento > Atualização de segurança para arquivos	drive_and_docs.file_security_update	A atualização vai tornar os links de arquivos mais seguros. Isso pode fazer com que os usuários recebam solicitações de acesso a arquivos	security_update	Enumeração: APPLY_TO_IMPACTED_FILES, REMOVE_FROM_IMPACTED_FILES
			Permitir que os usuários removam/apliquem a atualização de segurança nos arquivos deles ou gerenciados por eles	allow_users_to_manage_update	Booleano
	Recursos e aplicativos > SDK do Drive	drive_and_docs.drive_sdk	Permitir que os usuários acessem o Google Drive com a API Drive SDK	enable_drive_sdk_api_access	Booleano
	Google Drive para computador > Ativar o Drive para computador	drive_and_docs.drive_for_desktop	Permitir o Google Drive para computador na sua organização	allow_drive_for_desktop	Booleano
			Permitir o Google Drive para computador apenas em dispositivos autorizados	restrict_to_authorized_devices	Booleano
			Mostrar o link de download do Google Drive para computador	show_download_link	Booleano
			Permitir que os usuários ativem o acesso em tempo real no Microsoft Office usando o Google Drive para computador	allow_real_time_presence	Booleano

Configurações do Meet

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Google Meet	Configurações de vídeo do Meet > Gravação	meet.video_recording	Permitir que as pessoas gravem as reuniões.	enable_recording	booleano
	Configurações de segurança do Meet > Domínio	meet.safety_domain	Quem pode participar de reuniões criadas pela sua organização.	users_allowed_to_join	Enum: SAME_ORGANIZATION_ONLY, LOGGED_IN, ALL
	Configurações de segurança do Meet > Acesso	meet.safety_access	As reuniões ou ligações de que os usuários na organização podem participar. As "Restrições de chamadas recebidas" podem limitar ainda mais as chamadas que os usuários podem receber.	meetings_allowed_to_join	Enumeração: SAME_ORGANIZATION_ONLY, ANY_WORKSPACE_ORGANIZATION, ALL
	Configurações de segurança do Meet > Gerenciamento de organizadores	meet.safety_host_management	Gerenciamento de organizadores padrão	enable_host_management	Booleano
	Configurações de segurança do Meet > Aviso para identificar participantes externos	meet.safety_external_participants	Indica quem não faz parte da "Organização" ou não teve a identidade confirmada.	enable_external_label	Booleano

Configurações de sites

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Sites	Novo Sites > Criação e edição de sites	sites.sites_creation_and_modification	Permitir que os usuários criem novos sites	allowSitesCreation	Booleano
			Os usuários podem/não podem editar sites	allowSitesModification	Booleano

Configurações do Grupos para empresas

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Grupos para empresas	Configurações de compartilhamento > Opções de compartilhamento	groups_for_business.groups_sharing	Definir políticas para alterar as configurações de compartilhamento de grupos	collaborationCapability	Enumeração: ANYONE_CAN_ACCESS, DOMAIN_USERS_ONLY
			Criar grupos	createGroupsAccessLevel	Enumeração: ADMIN_ONLY, USERS_IN_DOMAIN, ANYONE_CAN_CREATE
			Os proprietários de grupos podem permitir participantes externos	ownersCanAllowExternalMembers	Booleano
			Os proprietários de grupos podem permitir o recebimento de e-mails de fora da organização	ownersCanAllowIncomingMailFromPublic	Booleano
			Padrão de permissão para ver conversas	viewTopicsDefaultAccessLevel	Enum: OWNERS, MANAGERS, GROUP_MEMBERS, DOMAIN_USERS, ANYONE_CAN_VIEE_TOPICS
			Os proprietários de grupos podem ocultar grupos do diretório	ownersCanHideGroups	Booleano
			Ocultar grupos recém-criados do diretório	newGroupsAreHidden	Booleano

Configurações da Sala de Aula

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Google Sala de Aula	Configurações gerais > Permissões para professores	classroom.teacher_permissions	Quem pode criar turmas	whoCanCreateClasses	Enumeração: ANYONE_IN_DOMAIN, ALL_PENDING_AND_VERIFIED_TEACHERS, VERIFIED_TEACHERS_ONLY
	Configurações gerais > Acesso dos responsáveis	classroom.guardian_access	Permitir que familiares e responsáveis acessem informações do Google Sala de Aula	allowAccess	Booleano
			Quem pode gerenciar familiares e responsáveis	whoCanManageGuardianAccess	Enumeração: VERIFIED_TEACHERS_AND_DOMAIN_ADMINS, DOMAIN_ADMINS_ONLY
	Configurações da turma > Sobre a participação em turmas	classroom.class_membership	Quem pode participar de turmas no seu domínio	whoCanJoinClasses	Enumeração: ANYONE_IN_DOMAIN, ANYONE_IN_ALLOWLISTED_DOMAINS, ANY_GOOGLE_WORKSPACE_USER, ANYONE
			Turmas das quais os usuários no seu domínio podem participar	whichClassesCanUsersJoin	Enum: CLASSES_IN_DOMAIN, CLASSES_IN_ALLOWLISTED_DOMAINS, ANY_GOOGLE_WORKSPACE_CLASS
	Acesso aos dados > API Classroom	classroom.api_data_access	Os usuários podem autorizar apps a acessar os dados deles no Google Sala de Aula	enableApiAccess	Booleano
	Relatórios de originalidade > Correspondências na escola	classroom.originality_reports	Ativar correspondências na escola dos relatórios de originalidade	enableOriginalityReportsSchoolMatches	Booleano
	Cancelamento de inscrição do estudante > Permissões de cancelamento de inscrição	classroom.student_unenrollment	Quem pode cancelar a inscrição de estudantes em turmas	whoCanUnenrollStudents	Enum STUDENTS_AND_TEACHERS, TEACHERS_ONLY
	Importação da lista de estudantes > Configurações	classroom.roster_import	Importação de listas de estudantes	rosterImportOption	Enumeração: OFF, ON_CLEVER

Observação :a importação de listas de estudantes só está disponível para usuários do Education Plus.

Configurações de regras de proteção de dados

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Proteção de dados	Segurança > Controle de dados e acesso > Proteção de dados > Gerenciar regras	rule.dlp	Nome	display_name	String
			Descrição	description	String
			Apps	gatilhos	String[]: lista de strings de acionadores específicas do app. A lista de acionadores de app disponíveis está disponível na seção "Acionadores" a seguir.
			Condições	transição	String: expressão de Common Expression Language (CEL) das condições de dados que a regra verifica. A sintaxe do CEL e alguns exemplos comuns são fornecidos na seção "Condições" a seguir.
			Ações	ação	Struct: objeto aninhado que representa ações específicas do aplicativo a serem realizadas quando as condições forem atendidas. As ações disponíveis por acionador de app são fornecidas na seção "Ações" a seguir.
			Estado	estado	Enumeração: ACTIVE, INACTIVE
			Criado em	create_time	Carimbo de data/hora
			Última modificação	update_time	Carimbo de data/hora
			Metadados específicos do tipo de regra	rule_type_metadata	Struct - objeto aninhado que representa metadados específicos do tipo de regra. Para as regras de proteção de dados, ele contém o nível de gravidade dos eventos acionados.

Gatilhos

A lista de aplicativos disponíveis e seus gatilhos.

• "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.nexo.v1.upload"
• "google.workspace.drive.file.v1.share"
• "google.workspace.gmail.email.v1.send"

Condições

Para representar condições de dados, a API usa expressões Common Expressions Language (CEL). Cada condição segue o padrão de "{content type}.{content to scan for}({additional scan parameters})". Por exemplo, **"all_content.contains('apple')" **representa uma condição de dados que corresponde se algum conteúdo verificado (por exemplo, documento do Drive, mensagem de chat etc.) tiver a substring "maçã".

Tipo de conteúdo

A lista de tipos de conteúdo disponíveis, correspondente às configurações correspondentes de nomes iguais no Admin Console.

• 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
• subject
• suggestion
• target_user
• título
• to_header_recipients
• url
• url_category

Conteúdo a ser verificado

Lista de conteúdo disponível para verificação, correspondente às configurações correspondentes de nomes iguais no Admin Console.

• 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}})
  • Corresponde à opção corresponde a um tipo de dados predefinido no Admin Console.
  • {detector name} indica o tipo de dados predefinido a ser verificado, que pode ser um dos tipos de informações integrados compatíveis com o Cloud DLP: https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference. Por exemplo, CREDIT_CARD_NUMBER ou US_SOCIAL_SECURITY_NUMBER
  • {likelihood} indica o limite de probabilidade da correspondência. Por exemplo, google.privacy.dlp.v2.Likelihood.LIKELY corresponde ao limite High no Admin Console.
• matches_regex_detector({detector name}, {minimum_match_count: {count}})
  • Corresponde à opção corresponde à expressão regular no Admin Console.
  • {detector name} é o nome do recurso da política que representa o detector de expressões regulares. Consulte a seção Detector de proteção de dados para saber como consultar políticas de detector na API.
• matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
  • Corresponde à opção corresponde às palavras da lista de palavras no Admin Console.
  • {detector name} é o nome do recurso da política que representa o detector da lista de palavras. Consulte a seção Detector de proteção de dados para saber como consultar políticas de detector na API.
• matches_web_category({category})
  • Corresponde à opção Correspondências de categoria de URL no Admin Console do acionador de URL visitado do Chrome.
  • {category} indica a categoria de URL compatível com a configuração do Admin Console. Por exemplo, ADULT ou ONLINE_COMMUNITIES__SOCIAL_NETWORKS.

Condições compostas

Várias condições de base podem ser misturadas com os operadores AND (&&), OR (||) ou NOT (!) para formar uma condição composta. Por exemplo, "all_content.contains('apple') && all_content.contains('banana')" representa uma condição que corresponde se algum do conteúdo digitalizado contém as substrings "maçã" e "banana".

Ações

Cada aplicativo especifica a ação a ser realizada quando a condição de dados corresponder a uma mensagem aninhada. Por exemplo, { "driveAction" { "warnUser" { } } } representa uma ação do Drive que avisa os usuários sobre compartilhamentos externos. As ações específicas do aplicativo disponíveis são as seguintes:

Aplicativo	Chave de ação	Subação	Legenda do Admin Console
Drive	driveAction	blockAccess	Bloquear compartilhamento externo
		warnUser	Avisar sobre compartilhamento externo
		auditOnly	Nenhuma ação
		restrictCopyPrintDownload	Desativar o download, a impressão e a cópia
		applyLabels	Aplicar rótulos de classificação
Gmail	gmailAction	blockContent	Bloquear mensagem
		warnUser	Avisar aos usuários
		auditOnly	Somente auditoria
		quarantineMessage	Colocar mensagem em quarentena
Chat	chatAction	blockContent	Bloquear mensagem
		warnUser	Avisar aos usuários
		auditOnly	Somente auditoria
Chrome	chromeAction	blockContent	Bloquear
		warnUser	Permitir com alerta

Metadados específicos do tipo de regra

Esse atributo contém os metadados específicos do tipo de regra. Para regras de proteção de dados, ele contém a gravidade do evento de alerta quando o evento é informado no painel de segurança e na Central de alertas. Um valor de exemplo dos metadados que representam a gravidade de alerta BAIXA:

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

Configurações dos detectores de proteção de dados

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Proteção de dados	Segurança > Controle de dados e acesso > Proteção de dados > Gerenciar detectores	detector.regular_expression detector.word_list	Nome	display_name	String
			Descrição	description	String
			Expressão regular	regular_expression	Struct - contém a string da expressão regular. Defina apenas se o tipo de detector for detector.regular_expression.
			Lista de palavras	word_list	String - contém a lista de strings de palavras. Defina apenas se o tipo de detector for detector.word_list.
			Criado em	create_time	Carimbo de data/hora
			Última modificação	update_time	Carimbo de data/hora

Configurações de regras de alerta definidas pelo sistema

Para o lançamento da versão Beta, apenas alertas admin-modified definidos pelo sistema (com mudanças nas configurações de notificação do valor padrão) são retornados da API.

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Proteção de dados	Regras (para o tipo de regra "definida pelo sistema")	rule.system_defined_alerts	Nome	display_name	String
			Descrição	description	String
			Ações	ação	Struct - objeto aninhado que representa as configurações de notificação quando o alerta definido pelo sistema é acionado. Os detalhes estão na seção "Ações" a seguir.
			Estado	estado	Enumeração: ACTIVE, INACTIVE
			Criado em	create_time	Carimbo de data/hora
			Última modificação	update_time	Carimbo de data/hora

Ações

As regras de alerta definidas pelo sistema têm uma única ação que indica as configurações de notificação do alerta.

Tecla de ação	Subação	Legenda do Admin Console
alertCenterAction	alertCenterConfig	Enviar para a Central de alertas
	destinatários	Enviar notificações por e-mail