Configurações disponíveis na API

Neste documento, descrevemos as configurações compatíveis com a API Policy.

Se as configurações compatíveis não estiverem na resposta da API Cloud Identity Policy, consulte Valores de campo padrão. Se a configuração ausente não for mencionada em Valores de campo padrão, entre em contato com o Cloud Customer Care.

Controles de API

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Controles de API	Configurações > Mensagem personalizada para o usuário	api_controls.custom_user_message	Não	Personalize a mensagem a ser exibida aos usuários quando não for permitido acessar um app devido a configurações de acesso.	error_text	string
	Configurações > Apps de terceiros não configurados	api_controls.unconfigured_third_party_apps	Não	Os apps de terceiros não configurados são aqueles que não definiram uma configuração de acesso (como confiável, limitado ou bloqueado). Selecione o que acontece quando os usuários tentam acessar apps de terceiros não configurados com as contas deles.	access_level	enum: ACCESS_LEVEL_UNSPECIFIED BLOCK_ALL ALLOW_SIGN_IN_ONLY
	Configurações > Apps de terceiros não configurados	api_controls.unconfigured_third_party_apps	Não	Os apps de terceiros não configurados são aqueles que não definiram uma configuração de acesso (como confiável, limitado ou bloqueado). Selecione o que acontece quando usuários menores de 18 anos tentam acessar apps de terceiros não configurados com as contas deles.	access_level_under18	enum: ACCESS_LEVEL_UNSPECIFIED ALLOW_SIGN_IN_ONLY
	Configurações > Apps internos	api_controls.internal_apps	Não	Os apps internos da sua organização são configurados automaticamente como acesso confiável. Esses apps podem solicitar acesso à API para todos os dados do Google para os usuários.	trust_internal_apps	booleano
	Configurações > Solicitações de acesso dos usuários a apps não configurados	api_controls.app_approval_requests	Não	Permitir que os usuários solicitem acesso a apps de terceiros não configurados	allowed_for_all	enum: OPTION_UNSPECIFIED ENABLED DISABLED
	Controle de acesso de apps > Gerenciar serviços do Google > Serviços do Google	api_controls.google_services	Não	Selecione as configurações de acesso para as APIs do Serviço do Google e controle quais tipos de apps de terceiros podem pedir acesso a esses serviços.	serviços	Serviço[]

Observação: o campo access_level_under18 na configuração api_controls.unconfigured_third_party_apps é NO-OP para clientes do Workspace que não são do setor de educação.

Subconfigurações dos controles de API

Esta tabela mostra as subconfigurações de controles de API que são referenciadas por outras configurações de controles de API.

Nome da subconfiguração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Serviço	Acesso	scopes_group	enum: UNSPECIFIED DRIVE_ALL DRIVE_HIGH_RISK GMAIL_ALL GMAIL_HIGH_RISK CALENDAR_ALL CONTACTS_ALL GSUITE_ADMIN_ALL VAULT_ALL CLOUD_PLATFORM CLOUD_BILLING CLOUD_ML APPS_SCRIPT_RUNTIME APPS_SCRIPT_API CLASSROOM_ALL CLASSROOM_HIGH_RISK COMMUNICATIONS TASKS GROUPS KEEP CLOUD_SEARCH CHAT SIGN_IN CHAT_HIGH_RISK MEET WORKSPACE_STUDIO VOICE GEMINI_NOTEBOOK
	Restrito/Irrestrito	is_enabled	booleano

Configurações da agenda

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Agenda	Configurações avançadas > Agendamento de horários com pagamentos	calendar.appointment_schedules	Não	Permissão para que os usuários do agendamento de horários solicitem pagamento por agendamentos usando as contas do provedor de pagamento.	enable_payments	booleano
	Configurações de compartilhamento > Convites externos	calendar.external_invitations	Não	Avisar aos usuários quando estiverem convidando pessoas fora do domínio ORGANIZATION_UNIT_NAME	warn_on_invite	booleano
	Gerenciamento do Calendar Interop > Disponibilidade do Exchange na Agenda	calendar.interoperability	Não	Permitir que o Google Agenda mostre a disponibilidade dos usuários do Exchange	enable_interoperability	booleano
				Mostrar detalhes do evento	enable_full_event_details	booleano
	Gerenciamento do Calendar Interop > Reserva de recursos do Exchange	calendar.interoperability	Não	Ativar o Google Agenda para reservar salas do Microsoft Exchange	enable_exchange_room_booking	booleano
	Configurações de compartilhamento > Opções de compartilhamento externo para agendas principais	calendar.primary_calendar_max_allowed_external_sharing	Não	Fora de ORGANIZATION_UNIT_NAME: definir o que o usuário pode fazer nas agendas principais	max_allowed_external_sharing	enum: EXTERNAL_FREE_BUSY_ONLY EXTERNAL_ALL_INFO_READ_ONLY EXTERNAL_ALL_INFO_READ_WRITE EXTERNAL_ALL_INFO_READ_WRITE_MANAGE
	Configurações de compartilhamento > Opções de compartilhamento externo das agendas secundárias	calendar.secondary_calendar_max_allowed_external_sharing	Não	Fora de <nome da organização>: definir o que o usuário pode fazer nas agendas secundárias	max_allowed_external_sharing	enum: EXTERNAL_FREE_BUSY_ONLY EXTERNAL_ALL_INFO_READ_ONLY EXTERNAL_ALL_INFO_READ_WRITE EXTERNAL_ALL_INFO_READ_WRITE_MANAGE

Configurações de bate-papo

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Google Chat	Histórico de chats	chat.chat_history	Não	O histórico está ATIVADO/DESATIVADO	history_on_by_default	booleano
				Permitir que os usuários alterem a configuração do histórico	allow_user_modification	booleano
	Compartilhamento de arquivos do Chat	chat.chat_file_sharing	Não	Compartilhamento externo de arquivos	external_file_sharing	enum: ALL_FILES IMAGES_ONLY NO_FILES FILE_SHARING_OPTION_UNSPECIFIED
					internal_file_sharing	mesmo
	Histórico de espaços	chat.space_history	Não	Configurações do histórico de conversas dos espaços	history_state	enum: DEFAULT_HISTORY_ON DEFAULT_HISTORY_OFF HISTORY_ALWAYS_ON HISTORY_ALWAYS_OFF HISTORY_STATE_UNSPECIFIED
	Configurações externas do Chat	chat.external_chat_restriction	Não	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	Não	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
	Arquivamento de terceiros	chat.third_party_archiving	Não	Ativar o arquivamento de terceiros	ativado	booleano
				Especifique um endereço de e-mail para a entrega do conteúdo do Chat	destination_email_address	string
				Especifique com que frequência as mensagens de arquivamento do Chat serão enviadas (de 1 a 24 horas)	archival_frequency	Duração
				Lista separada por vírgulas dos cabeçalhos personalizados exigidos pelo endereço de destino	custom_headers	string
	Espaços externos	chat.external_spaces	Não	Permitir que os usuários criem e participem de espaços com pessoas de fora da organização	ativado	booleano
				Só permitir que os usuários adicionem pessoas de domínios na lista de permissões	domain_allowlist_mode	enum: DOMAIN_ALLOWLIST_MODE_UNSPECIFIED TRUSTED_DOMAINS ALL_DOMAINS
	Configurações de compartilhamento > Acesso padrão ao espaço	chat.space_access_default	Não	Acesso padrão ao espaço quando os usuários criam novos espaços.	access_type	enum: ACCESS_TYPE_UNSPECIFIED RESTRICTED PRIMARY_TARGET_AUDIENCE
	Denúncia de conteúdo	chat.content_reporting	Não	Permitir que os usuários denunciem conteúdo em mensagens diretas individuais	one_on_one_direct_messages_reporting	enum: CONTENT_REPORTING_STATE_UNSPECIFIED ENABLED DISABLED
				Permitir que os usuários denunciem conteúdo em mensagens diretas no grupo	group_direct_messages_reporting	mesmo
				Permitir que os usuários denunciem conteúdo em espaços específicos	spaces_reporting	mesmo
					spaces_reporting_type	enum: SPACES_REPORTING_TYPE_UNSPECIFIED ALL_SPACES DISCOVERABLE_SPACES_ONLY
				Especifique as categorias que os usuários podem escolher ao denunciar conteúdo	reporting_categories	objeto repetido: category (tipo enumerado): CATEGORY_UNSPECIFIED HARASSMENT DISCRIMINATION EXPLICIT_CONTENT SPAM CONFIDENTIAL_INFO SENSITIVE_INFO OTHER
				Especificar um título e uma descrição personalizados para o formulário de denúncia	reporting_form_customization_enabled	booleano
					custom_reporting_form_title	string
					custom_reporting_form_description	string
	Restrições de chats e espaços	chat.chat_and_space_restrictions	Não	Restringir a criação de mensagens, mensagens em grupo e espaços. Os usuários com esta restrição não podem gerenciar participantes.	restriction_level	enum: RESTRICTION_LEVEL_UNSPECIFIED UNRESTRICTED RESTRICTED

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	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Sala de Aula	Configurações gerais > Permissões para professores	classroom.teacher_permissions	Não	Quem pode criar turmas	whoCanCreateClasses	enum: ANYONE_IN_DOMAIN ALL_PENDING_AND_VERIFIED_TEACHERS VERIFIED_TEACHERS_ONLY
	Configurações gerais > Acesso dos responsáveis	classroom.guardian_access	Não	Permitir que familiares e responsáveis acessem informações do Google Sala de Aula	allowAccess	booleano
				Quem pode gerenciar familiares e responsáveis	whoCanManageGuardianAccess	enum: VERIFIED_TEACHERS_AND_DOMAIN_ADMINS DOMAIN_ADMINS_ONLY
	Configurações da turma > Sobre a participação em turmas	classroom.class_membership	Não	Quem pode participar de turmas no seu domínio	whoCanJoinClasses	enum: 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	Não	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	Não	Ativar correspondências na escola dos relatórios de originalidade	enableOriginalityReportsSchoolMatches	booleano
	Cancelamento da inscrição de estudantes > Permissões de cancelamento	classroom.student_unenrollment	Não	Quem pode cancelar a inscrição de estudantes em turmas	whoCanUnenrollStudents	enum STUDENTS_AND_TEACHERS TEACHERS_ONLY
	Importação de lista de estudantes > Configurações	classroom.roster_import	Não	Importação de listas de estudantes	rosterImportOption	enum: OFF ON_CLEVER
Gemini nos apps do Workspace	Gemini para Workspace > Acesso aos recursos no Google Sala de Aula > Google Sala de Aula	classroom.gemini_access	Não	Defina se os usuários podem acessar o Gemini na Sala de Aula	ativado	booleano

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

Configurações de compliance de dados

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Gerenciamento de acesso	Gerenciamento de acesso > Política de gerenciamento de acesso	access_management.user_scoping	Não	Escolha uma política do Gerenciamento de acesso para os dados cobertos	allowed_audience	enum: PREFERENCE_UNSPECIFIED CJIS_IRS_1075_GOOGLE_STAFF US_GOOGLE_STAFF EU_GOOGLE_STAFF
Regiões de dados	Região > Dados em repouso	data_regions.data_at_rest_region	Não	Região para armazenar dados em repouso	região	enum: REGION_UNSPECIFIED ANY_REGION US EUROPE
	Região > Tratamento de dados	data_regions.data_processing_region	Não	Política de região de dados para tratamento de dados	limit_to_storage_region	booleano
Aprovações de acesso	Aprovações de acesso > Política de aprovações de acesso	access_approval.axa_user_scoping	Não	Exigir que a equipe do Google solicite aprovação antes de visualizar os dados necessários para os serviços de suporte	requires_customer_approval	booleano

Configurações do dispositivo

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível com v1beta1	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Configurações universais	Acesso aos dados > Android Sync	devices.android_work_data_sync	Não	Permitir que os dados de trabalho sejam sincronizados em dispositivos Android	permitido	booleano
	Segurança > Criptografia	devices.encryption	Não	Exigir criptografia do dispositivo	device_encryption_option	enum: ENCRYPTION_OPTION_UNSPECIFIED NOT_REQUIRED REQUIRED
	Segurança > Dispositivos comprometidos	devices.compromised_devices	Não	Bloquear dispositivos Android comprometidos	compromised_android_devices_blocked	booleano
				Bloquear dispositivos iOS com jailbreak	jailbroken_ios_devices_blocked	booleano
	Segurança > Aprovações de dispositivos	devices.activation_approval	Não	Requer aprovação do administrador	admin_approval_required	booleano
				Enviar e-mails com pedidos de aprovação para	approver_email_address	string
Configurações do Android	Compartilhamento de apps e dados pessoais > Compartilhamento com outros perfis	devices.android_work_profile_sharing	Não	Permitir o compartilhamento de conteúdo do perfil de trabalho no espaço pessoal (somente dispositivos com perfil de trabalho)	permitido	booleano
	Compartilhamento de apps e dados pessoais > Cópia entre perfis	devices.android_cross_profile_copy_paste	Não	Permitir colar entre o perfil de trabalho e o espaço pessoal (somente dispositivos com perfil de trabalho)	ativado	booleano
	Compartilhamento de apps e dados pessoais > Apps particulares do Google Play	devices.android_google_play_private_apps	Não	Permitir que os usuários acessem os apps particulares do Google Play	access_allowed	booleano
				Permitir que os usuários publiquem e atualizem apps particulares do Google Play	publish_and_update_allowed	booleano
	Compartilhamento de apps e dados > Captura de tela	devices.android_screen_capture	Não	Permitir captura de tela	permitido	booleano
	Compartilhamento de apps e dados pessoais > Android Beam	devices.android_beam	Não	Permitir envio externo	outgoing_beam_allowed	booleano
	Compartilhamento de apps e dados pessoais > Compartilhamento de local	devices.android_location_sharing	Não	Permita o compartilhamento de local.	permitido	booleano
	Compartilhamento de apps e dados pessoais > Apps disponíveis	devices.android_available_apps	Não	Definir quais apps da Google Play Store os usuários podem instalar	playstore_installable_apps	enum: PLAYSTORE_INSTALLABLE_APPS_UNSPECIFIED ALL ALLOWLISTED
	Compartilhamento de apps e dados pessoais > Verificar apps	devices.android_verify_apps	Não	Permitir que os usuários desativem o Google Play Protect (somente dispositivos da empresa)	turnoff_google_play_protect_allowed	booleano
	Compartilhamento de apps e dados pessoais > Opções do desenvolvedor	devices.android_developer_options	Não	Permitir opções do desenvolvedor	permitido	booleano
	Recursos da tela de bloqueio > Autenticação periódica com PIN, senha ou padrão de desbloqueio	devices.android_periodic_secure_authentication	Não	Exige que os usuários do desbloqueio facial ou por impressão digital façam a autenticação periódica com métodos mais seguros, como PIN, senha ou padrão de desbloqueio	obrigatório	booleano
				Após o período definido abaixo, os usuários precisarão usar uma autenticação mais segura na próxima vez que desbloquearem o dispositivo	expiration_period	enum: EXPIRATION_PERIOD_UNSPECIFIED ONE_HOUR THREE_HOURS SIX_HOURS EIGHT_HOURS TWELVE_HOURS TWENTY_FOUR_HOURS FORTY_EIGHT_HOURS SEVENTY_TWO_HOURS
	Compartilhamento de apps e dados pessoais > Fontes desconhecidas	devices.android_unknown_source_apps	Não	Impedir que os usuários instalem apps de fontes desconhecidas no perfil de trabalho.	work_profile_installation_allowed	booleano
				Impedir que os usuários instalem apps de fontes desconhecidas no perfil pessoal.	personal_profile_installation_allowed	booleano
	Compartilhamento de apps e dados pessoais > Configurações de apps	devices.android_apps_settings	Não	Permitir que os usuários alterem as configurações dos apps (somente dispositivos da empresa).	modification_allowed	booleano
	Compartilhamento de apps e dados pessoais > Recursos da tela de bloqueio	devices.android_trust_agents	Não	Permitir que o Smart Lock mantenha um dispositivo desbloqueado.	smart_lock_allowed	booleano
	Compartilhamento de apps e dados pessoais > Recursos da tela de bloqueio	devices.android_lock_screen_notifications	Não	Permitir notificações na tela de bloqueio.	permitido	booleano
	Compartilhamento de apps e dados pessoais > Recursos da tela de bloqueio	devices.android_lock_screen_notification_details	Não	Permitir detalhes da notificação.	permitido	booleano
Nas configurações do iOS, você pode fazer o seguinte:	Segurança avançada > Apple Watch	devices.ios_apple_watch	Não	Permitir o uso do Apple Watch sem detecção de pulso	no_wrist_detection_usage_allowed	booleano
	Segurança avançada > Siri	devices.ios_siri	Não	Permitir a Siri	permitido	booleano
				Permitir a Siri na tela de bloqueio	allowed_on_lock_screen	booleano
	Segurança avançada > Transferência	devices.ios_handoff	Não	Permitir transferência (somente dispositivos supervisionados e registrados)	permitido	booleano
	Compartilhamento de dados pessoais > Armazenamento do iCloud	devices.ios_icloud_storage	Não	Permitir que apps gerenciados armazenem dados no iCloud	managed_apps_sync_allowed	booleano
	Segurança avançada > Captura de tela	devices.ios_screen_capture	Não	Permitir capturas e gravações de tela	permitido	booleano
	Backup e sincronização com o iCloud > Backup do iCloud	devices.ios_icloud_backup	Não	Permitir que o usuário faça o backup do dispositivo com o iCloud (somente dispositivos supervisionados)	permitido	booleano
	Backup e sincronização com o iCloud > Backup criptografado	devices.ios_backup_encryption	Não	Exigir criptografia para backups	obrigatório	booleano
	Tela de bloqueio > Central de controle	devices.ios_lock_screen_control_center	Não	Permitir Central de controle na tela de bloqueio	permitido	booleano
	Apps e serviços > App Arquivos	devices.ios_files_app	Não	Permitir que os usuários se conectem a drives USB no app Arquivos (iOS 13.1 ou mais recente, somente dispositivos supervisionados)	usb_drives_connection_allowed	booleano
				Permitir que os usuários se conectem a drives de rede no app Arquivos (iOS 13.1 ou mais recente, somente dispositivos supervisionados)	network_drives_connection_allowed	booleano
	Recursos do dispositivo > Data e hora	devices.ios_date_time	Não	Forçar a data e a hora automáticas (iOS 12 ou mais recente, somente dispositivos supervisionados)	automatic_date_time_enforced	booleano
	Tela de bloqueio > Visualização de notificações	devices.ios_lock_screen_notifications_view	Não	Permitir a visualização "Notificações" na tela de bloqueio	permitido	booleano
	Compartilhamento de dados pessoais > Ações de dados	devices.ios_data_actions	Não	Selecione as ações que os usuários podem realizar com os dados do Google Workspace em dispositivos iOS	external_data_sharing_allowed	booleano
				Permitir o recurso de copiar e colar dados de trabalho em apps e contas pessoais	work_data_operation_type.non_workspace_apps_copy_paste_allowed	booleano
				Permitir o envio de dados de trabalho para apps pessoais na página de compartilhamento do iOS, incluindo todos os apps que não são do Google Workspace	work_data_operation_type.non_workspace_apps_sharing_allowed	booleano
				Permitir o compartilhamento de dados de trabalho com contas pessoais ou com o Mail do iOS na planilha de compartilhamento do iOS	work_data_operation_type.personal_accounts_sharing_allowed	booleano
				Permitir o compartilhamento de dados de trabalho com o AirDrop na planilha de compartilhamento do iOS	work_data_operation_type.airdrop_sharing_allowed	booleano
				Permitir a impressão de arquivos de trabalho	work_data_operation_type.files_printing_allowed	booleano
				Permitir que os usuários salvem dados de trabalho nos Arquivos usando a planilha de compartilhamento do iOS e acessem esses dados diretamente no app	work_data_operation_type.files_access_allowed	booleano
				Permitir o salvamento de imagens e vídeos do trabalho nas fotos do iOS	work_data_operation_type.images_videos_saving_allowed	booleano
				Permitir a atribuição de itens a "Contatos" usando a planilha de compartilhamento do iOS	work_data_operation_type.contacts_items_assignment_allowed	booleano
	Safari > Navegação segura	devices.ios_safari_secure_browsing	Não	Aplicar o aviso de site fraudulento do Safari	fraudulent_website_warning_enforced	booleano
	Compartilhamento de dados pessoais > Apple Intelligence	devices.ios_apple_intelligence	Não	Permitir o uso das Ferramentas de Escrita da Apple Intelligence nos apps do Google Workspace em dispositivos iOS	writing_tools_allowed	booleano
	Backup e sincronização com o iCloud > Sincronização de chaves	devices.ios_keychain_sync	Não	Permitir que os usuários sincronizem conjuntos de chaves com o iCloud (somente dispositivos supervisionados).	icloud_sync_allowed	booleano
	Backup e sincronização com o iCloud > Sincronização de documentos	devices.ios_document_sync	Não	Permitir que os usuários sincronizem documentos e dados com o iCloud.	icloud_data_sync_allowed	booleano

Configurações do diretório

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Configurações do Diretório	Configurações de compartilhamento > Compartilhamento externo do Diretório	directory.external_directory_sharing	Não	N/A	sharing_option	enum: SHARING_OPTION_UNSPECIFIED REQUESTER_BASIC_PROFILE_ONLY ORGANIZATION_DIRECTORY_DATA

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	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Google Drive e Google Docs	Configurações de compartilhamento > Opções de compartilhamento	drive_and_docs.external_sharing	Não	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 ORGANIZATION_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 ORGANIZATION_UNIT_NAME forem compartilhados com usuários em domínios na lista de permissões	warn_for_sharing_outside_allowlisted_domains	booleano
				Permitir que os usuários em ORGANIZATION_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 ORGANIZATION_UNIT_NAME compartilhem itens com usuários externos ao Google em domínios de confiança usando o compartilhamento com visitantes	allow_non_google_invites_in_allowlisted_domains	booleano
				Avisar quando arquivos de usuários ou drives compartilhados em ORGANIZATION_UNIT_NAME forem compartilhados fora de CUSTOMER_NAME	warn_for_external_sharing	booleano
				Permitir que os usuários ou os drives compartilhados em ORGANIZATION_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 de ORGANIZATION_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 Google Drive nem o Google Docs (por exemplo, colando um link no Gmail), o Google verifica se o destinatário tem 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 em ORGANIZATION_UNIT_NAME fora de 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 > Acesso geral padrão	drive_and_docs.general_access_default	Não	Quando os usuários em ORGANIZATION_UNIT_NAME criarem itens, o acesso padrão vai 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	Não	Impedir que os usuários em ORGANIZATION_UNIT_NAME criem drives compartilhados	allow_shared_drive_creation	booleano (a resposta da API retorna o oposto do valor da UI)
				Quando os usuários em ORGANIZATION_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
				As opções de download, impressão e cópia estão ativadas para	allowed_parties_for_download_print_copy	enum: ALL EDITORS_ONLY (administradores, colaboradores e administradores de conteúdo) MANAGERS_ONLY
				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	Não	Quando aplicada, esta atualização torna os links de arquivo mais seguros. Isso talvez faça com que os usuários recebam solicitações de acesso aos arquivos	security_update	enum: APPLY_TO_IMPACTED_FILES REMOVE_FROM_IMPACTED_FILES
				Permitir que os usuários removam/apliquem a atualização de segurança para os próprios arquivos ou arquivos que eles gerenciam	allow_users_to_manage_update	booleano
	Recursos e aplicativos > SDK do Drive	drive_and_docs.drive_sdk	Não	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	Não	Permitir o Google Drive para computador na sua organização	allow_drive_for_desktop	booleano
				Só permitir o Google Drive para computador 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 de compartilhamento > Destacar arquivos externos	drive_and_docs.external_file_warning	Não	Marque os arquivos compartilhados ou de propriedade externa como "externo" para indicar que o conteúdo pode ser acessado fora da sua organização. Aplicável ao Drive, aos Documentos, às Planilhas, às Apresentações, aos Desenhos e ao Google Vids.	highlighting_enabled	booleano

Configurações do app do Gemini

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
App Gemini	Acesso do usuário	gemini_app.unlicensed_user_access	Não	Permitir que todos os usuários acessem o app do Gemini, independentemente da licença	ativado	booleano

Configurações do Gemini no Workspace

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Gemini no Workspace	Recursos Beta do Gemini > Recursos Beta	gemini_for_workspace.beta_features	Não	Ativar o acesso aos recursos Beta no Gemini para Google Workspace	ativado	booleano
				Permita que o Google convide usuários na unidade organizacional ou grupo selecionado para participar de pesquisas e estudos de feedback de UX com o objetivo de melhorar o Gemini para Google Workspace	feedback_and_testing_enabled	booleano

Configurações do Gmail

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Gmail	Configurações do usuário > Modo confidencial	gmail.confidential_mode	Não	Ativar o modo confidencial	enable_confidential_mode	booleano
	Configurações do usuário > S/MIME	gmail.smime_encryption	Não	Ativar a criptografia S/MIME para enviar e receber e-mails	enable_smime_encryption	enum: STATUS_UNSPECIFIED STATUS_DISABLED STATUS_ENABLED
				Permitir SHA-1 globalmente (não recomendado)	allow_sha1_globally_in_smime_signature	booleano
		gmail.enhanced_smime_encryption	Não	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 CA 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 de mensagem de pré-entrega aprimorada	gmail.enhanced_pre_delivery_message_scanning	Não	Melhora a detecção de conteúdo suspeito antes da entrega	enable_improved_suspicious_content_detection	booleano
	Spam, phishing e malware > Lista de permissões de e-mail	gmail.email_spam_filter_ip_allowlist	Não	Digite os endereços IP da sua lista de permissões de e-mail	allowed_ip_addresses	Uma lista de strings
	Segurança > Spoofing e autenticação	gmail.spoofing_and_authentication	Não	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	enum: WARNING SPAM_FOLDER QUARANTINE NO_ACTION
				Escolher uma quarentena	domain_name_spoofing_quarantine_id	integer
				Proteger contra spoofing de nomes de funcionários	detect_employee_name_spoofing	booleano
				Escolha uma ação	employee_name_spoofing_consequence	enum: WARNING SPAM_FOLDER QUARANTINE NO_ACTION
				Escolher uma quarentena	employee_name_spoofing_quarantine_id	integer
				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_consequence	enum: WARNING SPAM_FOLDER QUARANTINE NO_ACTION
				Escolher uma quarentena	domain_spoofing_quarantine_id	integer
				Proteger contra e-mails não autenticados	detect_unauthenticated_emails	booleano
				Escolha uma ação	unauthenticated_email_consequence	enum: WARNING SPAM_FOLDER QUARANTINE NO_ACTION
				Escolher uma quarentena	unauthenticated_email_quarantine_id	integer
				Proteja 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_visibility_type	enum: PRIVATE_GROUPS_ONLY ALL_GROUPS
				Escolha uma ação	groups_spoofing_consequence	enum: WARNING SPAM_FOLDER QUARANTINE NO_ACTION
				Escolher uma quarentena	groups_spoofing_quarantine_id	integer
				Aplicar automaticamente as futuras configurações recomendadas	apply_future_settings_automatically	booleano
	Segurança > Links e imagens externas	gmail.links_and_external_images	Não	Identificar links em URLs abreviados	enable_shortener_scanning	booleano
				Verificar imagens de links	enable_external_image_scanning	booleano
				Exibir 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	Não	Proteger contra anexos criptografados de remetentes não confiáveis	enable_encrypted_attachment_protection	booleano
				Escolha uma ação	encrypted_attachment_protection_consequence	enum: WARNING SPAM_FOLDER QUARANTINE
				Escolher uma quarentena	encrypted_attachment_protection_quarantine_id	integer
				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
				Escolher uma quarentena	attachment_with_scripts_protection_quarantine_id	integer
				Proteger contra tipos de anexo anômalos em e-mails	enable_anomalous_attachment_protection	booleano
				Escolha uma ação	anomalous_attachment_protection_consequence	enum: WARNING SPAM_FOLDER QUARANTINE
				Escolher uma quarentena	anomalous_attachment_protection_quarantine_id	integer
				Adicionar à lista de permissões os seguintes tipos incomuns de arquivo	allowed_anomalous_attachment_filetypes	string[]
				Aplicar automaticamente as futuras configurações recomendadas	apply_future_recommended_settings_automatically	booleano
	Roteamento > Gerenciar listas de endereços	gmail.email_address_lists	Não	Gerenciar listas de endereços	email_address_list	EmailAddressList[]
	Spam, phishing e malware > Remetentes bloqueados	gmail.blocked_sender_lists	Não	Bloquear ou aprovar remetentes específicos com base nos endereços de e-mail ou domínios	blocked_senders	BlockedSender[]
	Spam, phishing e malware > Spam	gmail.spam_override_lists	Não	Crie listas de remetentes aprovados que ignoram a caixa de spam.	spam_override	SpamOverride[]
	Compliance > Compliance de conteúdo	gmail.content_compliance	Não	Configurar filtros de conteúdo avançados com base em palavras, frases ou padrões	content_compliance_rules	ContentComplianceRule[]
	Compliance > Restringir entrega	gmail.restrict_delivery	Não	Restrinja os domínios com os quais os usuários podem trocar e-mails.	restrict_delivery_rules	RestrictDeliveryRule[]
	Compliance > Conteúdo censurável	gmail.objectionable_content	Não	Configurar filtros de conteúdo com base em listas de palavras	objectionable_content_rules	ObjectionableContentRule[]
	Compliance > Compliance para anexos	gmail.attachment_compliance	Não	Configurar filtros de anexos com base no tipo de arquivo, no nome do arquivo e no tamanho da mensagem	attachment_compliance_rules	AttachmentComplianceRule[]
	Compliance > Armazenamento de e-mails abrangente	gmail.comprehensive_mail_storage	Não	Garantir que uma cópia de todos os e-mails enviados e recebidos seja armazenada nas caixas de e-mails dos usuários associados	rule_id	string
	N/A (para todas as regras)	gmail.rule_states	Não	N/A	rule_states	RuleState[]
	Gerenciar quarentenas	gmail.email_quarantines	Não	Adicionar quarentena	email_quarantines	EmailQuarantine[]
	Configuração > Uploads de e-mail de usuários	gmail.user_email_uploads	Não	Mostrar para os usuários a opção de importar e-mails e contatos do Yahoo!, Hotmail, AOL ou de outras contas de webmail ou POP3 na página de configurações do Gmail	enable_mail_and_contacts_import	booleano
	Acesso do usuário final > Acesso POP e IMAP	gmail.pop_access	Não	Ativar acesso POP para todos os usuários	enable_pop_access	booleano
		gmail.imap_access	Não	Ativar acesso IMAP para todos os usuários	enable_imap_access	booleano
				Permitir qualquer cliente de e-mail	imap_access_restriction.allow_all_mail_clients	booleano
				Restringir os clientes de e-mail permitidos (somente OAuth)	imap_access_restriction.allowed_oauth_mail_client_list	OAuthMailClientList
	Acesso do usuário final > Sincronização do Google Workspace	gmail.workspace_sync_for_outlook	Não	Ativar o Google Workspace Sync for Microsoft Outlook para meus usuários	enable_google_workspace_sync_for_microsoft_outlook	booleano
	Acesso do usuário final > Encaminhamento automático	gmail.auto_forwarding	Não	Permitir que os usuários encaminhem automaticamente os e-mails recebidos para outro endereço	enable_auto_forwarding	booleano
				Destino de encaminhamento permitido	allowed_forwarding_destination	enum: ANY_ADDRESS INTERNAL_ADDRESSES
	Configurações do usuário > Formato do nome	gmail.name_format	Não	Permitir que os usuários personalizem essa configuração	allow_custom_display_names	booleano
				Nome Sobrenome ou Sobrenome, Nome	default_display_name_format	enum: FIRSTNAME_LASTNAME LASTNAME_COMMA_FIRSTNAME
	Acesso do usuário final > Permitir gateways de saída por usuário	gmail.per_user_outbound_gateway	Não	Permitir que os usuários enviem e-mails por um servidor SMTP externo ao configurar um endereço "De" hospedado fora do seu domínio de e-mail	allow_users_to_use_external_smtp_servers	booleano
	Acesso do usuário final > Alertar sobre destinatários externos	gmail.external_recipient_warning	Não	Destacar todos os destinatários externos em uma conversa. Avisar os usuários antes que eles respondam a e-mails com destinatários externos que não estão nos contatos.	ativado	booleano
	Acesso do usuário final > Lista de permissões de proxy de URL de imagem	gmail.email_image_proxy_bypass	Não	Digite padrões de URL de imagem. Os URLs correspondentes ignoram o proxy de imagem.	image_proxy_bypass_pattern	string[]
				N/A	enable_image_proxy	booleano
	Configurações do usuário > Delegação de e-mail	gmail.mail_delegation	Não	Permitir que os usuários deleguem o acesso às caixas de correio a outros usuários no domínio	enable_mail_delegation	booleano
Permitir que os usuários personalizem essa configuração				allow_custom_delegate_attribution	booleano
Mostrar o proprietário da conta e o delegado que enviou o e-mail				enable_delegate_attribution	booleano
Mostrar apenas o proprietário da conta
Os usuários podem permitir que um grupo do Google acesse a caixa de e-mails				enable_mailbox_group_delegation	booleano
Configurações do usuário > Gmail Web Off-line	gmail.web_offline	Não	Ativar o Gmail na Web off-line	ativado	booleano
			Forçar a exclusão de dados off-line ao sair da Conta do Google	signout_data_deletion_enforced	booleano

Subconfigurações do Gmail

Esta tabela mostra as subconfigurações do Gmail que são referenciadas por outras configurações do Gmail.

Nome da subconfiguração da API Policy	Legenda do Admin Console		Nome do campo da API Policy	Tipo de dado
EmailAddressList	N/A		ID	string
	Nome		nome	string
	ADICIONAR LISTA DE ENDEREÇOS		address_list	AddressList
	ADICIONAR LISTA BLOQUEADA		blocked_address_list	AddressList
AddressList	Adicionar lista de endereços		address	AddressListEntry[]
AddressListEntry	Endereço		address	string
	Autenticação obrigatória (somente e-mails recebidos)		require_address_verification	booleano
BlockedSender	Digite uma breve descrição que vai aparecer no resumo da configuração.		descrição	string
	Adicione endereços ou domínios cujas mensagens você quer rejeitar automaticamente		sender_blocklist	StringValue[]
	Inserir aviso de rejeição personalizado		rejection_response	string
	Ignorar esta configuração para mensagens recebidas de endereços ou domínios dentro destas listas de remetentes aprovados.		bypass_approved_sender	booleano
	N/A		bypass_approved_sender_allowlist	StringValue[]
	N/A		rule_id	string
SpamOverride	Digite uma breve descrição que vai aparecer no resumo da configuração.		descrição	string
	Ser mais rigoroso ao filtrar spam.		enable_aggressive_filtering	booleano
	Colocar spam na quarentena administrativa		add_to_quarantine	booleano
	N/A		quarantine_id	integer
	Ignorar filtros de spam para remetentes internos.		bypass_internal_senders	booleano
	Ignorar filtros de spam para mensagens de remetentes ou domínios nas listas selecionadas.		bypass_selected_senders	booleano
	N/A		bypass_sender_allowlist	StringValue[]
	Ignorar filtros de spam e ocultar alertas para mensagens de remetentes ou domínios nas listas selecionadas.		hide_warning_banner_from_selected_senders	booleano
	N/A		hide_warning_banner_sender_allowlist	StringValue[]
	Ignorar filtros de spam e ocultar alertas para todas as mensagens de remetentes internos e externos (não recomendado).		hide_warning_banner_for_all	booleano
	N/A		rule_id	string
ContentComplianceRule	Digite uma breve descrição que vai aparecer no resumo da configuração.		descrição	string
	Mensagens de e-mail afetadas		transição	RuleConditions
	Adicionar as expressões que descrevem o conteúdo que você quer pesquisar em cada mensagem		match_expressions	MatchExpression[]
	Se QUALQUER uma das seguintes opções corresponder à mensagem		match_any_expression	booleano
	O que fazer se as expressões acima corresponderem		consequence	RuleConsequences
	N/A		rule_id	string
RestrictDeliveryRule	Obrigatório: digite uma breve descrição que vai aparecer no resumo da configuração.		descrição	string
	Adicionar os endereços ou domínios que você quer permitir		allowed_addresses	StringValue[]
	Todas as mensagens enviadas ou recebidas de outros endereços e domínios serão rejeitadas. Edite o aviso de rejeição padrão para essas mensagens.		rejection_notice_message	string
	Ignorar esta configuração para mensagens internas		internal_messages_rule_bypass_allowed	booleano
	N/A		rule_id	string
ObjectionableContentRule	Digite uma breve descrição que vai aparecer no resumo da configuração.		descrição	string
	Mensagens de e-mail afetadas		transição	RuleConditions
	Palavras questionáveis personalizadas		objectionable_content_defined	booleano
	Digite as palavras		objectionable_words	string[]
	O que fazer se as expressões acima corresponderem		consequence	RuleConsequences
	N/A		rule_id	string
AttachmentComplianceRule	Digite uma breve descrição que vai aparecer no resumo da configuração.		descrição	string
	Mensagens de e-mail afetadas		transição	RuleConditions
	Adicionar as expressões que descrevem o conteúdo que você quer pesquisar em cada mensagem		match_expressions	MatchExpression[]
	Se QUALQUER uma das seguintes opções corresponder à mensagem		match_any_expression	booleano
	O que fazer se as expressões acima corresponderem		consequence	RuleConsequences
	N/A		rule_id	string
RuleState	N/A (para todas as regras)		ativado	booleano
			rule_id	string
RuleConditions	Mensagens de e-mail afetadas	Mensagens recebidas	affect_inbound_messages	booleano
		Mensagens enviadas	affect_outbound_messages	booleano
		Mensagens internas enviadas	affect_internal_sending_messages	booleano
		Mensagens internas recebidas	affect_internal_receiving_messages	booleano
	Listas de endereços	Usar listas de endereços para ignorar ou controlar a aplicação desta configuração	address_list_option	enum: NO_EFFECT EXCLUDED REQUIRED
		Ignorar esta configuração para endereços / domínios específicos
		Aplicar esta configuração apenas a endereços / domínios específicos
		Usar lista existente / Criar ou editar lista	address_lists	StringValue[]
	Tipos de contas afetadas	Usuários	account_type_user	booleano
		Grupos	account_type_group	booleano
		Não reconhecido / Pega-tudo	account_type_unrecognized	booleano
	Filtro de envelope	Afetar apenas remetentes de envelopes específicos	envelope_sender_filter	AddressMatcher
		Afetar apenas destinatários de envelopes específicos	envelope_recipient_filter	AddressMatcher
AddressMatcher	Afetar apenas remetentes de envelopes específicos / Afetar apenas destinatários de envelopes específicos		ativado	booleano
	Endereço de e-mail único	N/A	address_match_type	enum: EXACT
		Endereço de e-mail	exact_address_match_value	string
	Correspondência de padrão	N/A	address_match_type	enum: REGEXP
		Regexp	regexp_match_value	string
	Associação a grupos (somente e-mails enviados) / Associação a grupos (somente e-mails recebidos)	N/A	address_match_type	enum: GROUP_MEMBERSHIP
		Selecionar grupos	group_ids	string[]
MatchExpression	Correspondência de conteúdo simples	N/A	match_expression_type	enum: SIMPLE_CONTENT
		Conteúdo	match_content	string
	Correspondência de conteúdo avançada	N/A	match_expression_type	enum: ADVANCED_CONTENT
		Conteúdo / Regex	match_content	string
		N/A	advanced_content_match	AdvancedContentMatch
	Correspondência de metadados		match_expression_type	enum: METADATA
			metadata_match	MetadataMatch
	Correspondência de conteúdo predefinida		match_expression_type	enum: PREDEFINED_CONTENT
			predefined_content_match	PredefinedContentMatch
	Tipo de arquivo		match_expression_type	enum: FILE_TYPE
			file_type_match	FileTypeMatch
	Nome do arquivo	N/A	match_expression_type	enum: FILE_NAME
		O nome do arquivo anexado contém	file_name	string
	Tamanho da mensagem	N/A	match_expression_type	enum: MESSAGE_SIZE
		A mensagem geral (corpo + anexo) é maior que o seguinte (MB)	message_size_threshold_in_megabytes	integer
AdvancedContentMatch	Local	Cabeçalhos + corpo	advanced_content_match_location	enum: HEADERS_AND_BODY
		Cabeçalhos completos		enum: FULL_HEADERS
		Body		enum: BODY
		Assunto		enum: SUBJECT
		Cabeçalho do remetente		enum: SENDER_HEADER
		Cabeçalho de destinatários		enum: RECIPIENTS_HEADER
		Remetente do envelope		enum: ENVELOPE_SENDER
		Qualquer destinatário do envelope		enum: ANY_ENVELOPE_RECIPIENT
		Mensagem bruta		enum: RAW_MESSAGE
	Tipo de correspondência	Começa com	advanced_content_match_type	enum: STARTS_WITH
		Termina com		enum: ENDS_WITH
		Contém texto		enum: CONTAINS_TEXT
		Não contém texto		enum: NOT_CONTAINS_TEXT
		Igual a		enum: <code< code="" dir="ltr" translate="no">EQUALS </code<>
		Está vazio		enum: IS_EMPTY
		Corresponde à regex		enum: MATCHES_REGEXP
		Não corresponde ao regex		enum: NOT_MATCHES_REGEXP
		Corresponde a qualquer palavra		enum: MATCH_ANY_WORD
		Corresponde a todas as palavras		enum: MATCH_ALL_WORDS
	N/A		regexp_match	RegexpMatch
RegexpMatch	Descrição do regex		descrição	string
	Número mínimo de correspondências		min_match_count	integer
MetadataMatch	Atributo	Autenticação de mensagens	metadata_match_attribute	enum: MESSAGE_AUTHENTICATION
		IP de origem		enum: SOURCE_IP
		Transporte seguro (TLS)		enum: TLS
		Tamanho da mensagem		enum: MESSAGE_SIZE
		Criptografado com S/MIME		enum: SMIME_ENCRYPTED
		Assinado com S/MIME		enum: SMIME_SIGNED
		Modo confidencial do Gmail		enum: CONFIDENTIAL_MODE
		Spam		enum: SPAM
	Tipo de correspondência	o seguinte intervalo	source_ip_range	string
		o seguinte (MB)	message_size_in_megabytes	integer
		A mensagem é autenticada	metadata_match_type	enum: MESSAGE_AUTHENTICATED
		A mensagem não foi autenticada		enum: MESSAGE_NOT_AUTHENTICATED
		O IP de origem está em		enum: SOURCE_IP_IN_RANGE
		O IP de origem não está em		enum: SOURCE_IP_NOT_IN_RANGE
		A conexão está criptografada via TLS		enum: TLS_ENCRYPTED
		A conexão não está criptografada via TLS		enum: TLS_NOT_ENCRYPTED
		O tamanho da mensagem é maior que		enum: MESSAGE_SIZE_GREATER_THAN
		O tamanho da mensagem é menor que		enum: MESSAGE_SIZE_LESS_THAN
		A mensagem é criptografada com S/MIME		enum: MESSAGE_IS_SMIME_ENCRYPTED
		A mensagem não está criptografada com S/MIME		enum: MESSAGE_IS_NOT_SMIME_ENCRYPTED
		A mensagem está assinada com S/MIME		enum: MESSAGE_IS_SMIME_SIGNED
		A mensagem não está assinada com S/MIME		enum: MESSAGE_IS_NOT_SMIME_SIGNED
		A mensagem está no modo confidencial do Gmail		enum: MESSAGE_IS_IN_CONFIDENTIAL_MODE
		A mensagem não está no modo confidencial do Gmail		enum: MESSAGE_IS_NOT_IN_CONFIDENTIAL_MODE
		Malware detectado pelo sandbox de segurança		enum: MALWARE_DETECTED_FROM_SECURITY_SANDBOX
PredefinedContentMatch	N/A (seletor de correspondência de conteúdo predefinido)			predefined_content_match_name	string
	Número mínimo de correspondências			min_match_count	integer
	Limite de confiança		confidence_threshold	enum: MEDIUM HIGH
FileTypeMatch	Documentos do Office criptografados		encrypted_office_documents	booleano
	Documentos do Office que não estão criptografados		unencrypted_office_documents	booleano
	Vídeo e multimídia		vídeo	booleano
	Música e som		música	booleano
	Imagens		imagem	booleano
	Arquivos compactados e pacotes criptografados		compressed_encrypted_files	booleano
	Arquivos compactados e arquivos que não estão criptografados		compressed_unencrypted_files	booleano
	Tipos de arquivo personalizados: fazer a correspondência de arquivos com base na extensão do nome		custom_file_extensions	string[]
	Também corresponder arquivos com base no formato do arquivo		match_file_format	booleano
RuleConsequences	Modificar mensagem	N/A	rule_consequence_type	enum: MODIFY_MESSAGE
		N/A	primary_delivery	Entrega
		Adicionar mais destinatários	deliver_to_additional_recipients	booleano
		Destinatários	bcc_deliveries	Exibição[]
Entrega	Adicionar cabeçalho X-Gm-Original-To		add_x_gm_original_to_header	booleano
	Adicionar os cabeçalhos X-Gm-Spam e X-Gm-Phishy		add_x_gm_spam_header	booleano
	Adicionar cabeçalhos personalizados		add_custom_headers	booleano
	Cabeçalhos personalizados		custom_headers	string[]
	Adicionar assunto personalizado		prepend_custom_subject	booleano
	Digite o novo prefixo do assunto		custom_subject	string
	Alterar rota		change_default_route	booleano
	Também redirecionar spam		reroute_spam	booleano
	Suprimir devoluções deste destinatário		suppress_bounces_from_recipient	booleano
	N/A (seletor de roteamento)		normal_routing	booleano
	Alterar destinatário do envelope N/A		change_envelope_recipient	booleano
	Substituir destinatário		replace_envelope_recipient_type	enum: REPLACE_ADDRESS
			recipient_address	string
	Substituir nome de usuário		replace_envelope_recipient_type	enum: REPLACE_USER
			recipient_user	string
	Substituir domínio		replace_envelope_recipient_type	enum: REPLACE_DOMAIN
			recipient_domain	string
	Ignorar o filtro de spam para esta mensagem		bypass_spam_filter	booleano
	Remover anexos da mensagem		remove_attachments	booleano
	Adicionar este texto ao final para notificar os destinatários de que os anexos foram removidos		attachment_removal_notice	string
	Exigir transporte seguro (TLS)		require_tls	booleano
	Criptografar mensagem se não estiver criptografada (S/MIME)		encrypt_outgoing_messages	booleano
	Mensagem de erro na entrega se não for possível assinar e criptografar		bounce_unencrypted_messages	booleano
	Não enviar spam para este destinatário		do_not_deliver_spam_to_recipient	booleano
OAuthMailClientList	Restringir os clientes de e-mail permitidos (somente OAuth)		oauth_mail_client	OAuthMailClient[]
OAuthMailClient	N/A		oauth_mail_client_id	string
EmailQuarantine	N/A		quarantine_id	integer
	Nome		nome	string
	Descrição		description	string
	Consequência de negação de entrada		inbound_denial_consequence	enum: DENIAL_CONSEQUENCE_UNSPECIFIED DROP REJECT
	Consequência da negação de saída		outbound_denial_consequence	enum: DENIAL_CONSEQUENCE_UNSPECIFIED DROP REJECT
	Enviar notificações periodicamente quando mensagens forem colocadas em quarentena		send_notifications	booleano
	Grupo de revisores da quarentena		quarantine_acl_group_ids	string[]

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	Mutate compatível	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	Não	Definir políticas para alterar as configurações de compartilhamento dos grupos	collaborationCapability	enum: ANYONE_CAN_ACCESS DOMAIN_USERS_ONLY
				Criar grupos	createGroupsAccessLevel	enum: 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_VIEW_TOPICS
				Os proprietários de grupos podem ocultar grupos do diretório	ownersCanHideGroups	booleano
				Ocultar grupos recém-criados do diretório	newGroupsAreHidden	booleano

Jurídico e conformidade

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Configurações da conta	Opções de compartilhamento	cloud_sharing_options.cloud_data_sharing	Não	Opções de compartilhamento do Google Cloud Platform	sharingOptions	enum: UNSUPPORTED 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	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Lista de apps	Lista de apps	workspace_marketplace.apps_allowlist	Não	Mostrando apps para usuários em todas as unidades organizacionais	apps	AppsAllowlistSetting[]
Configurações	Gerenciar o acesso aos apps > Gerenciar o acesso à lista de permissões do Google Workspace Marketplace	workspace_marketplace.apps_access_options	Não	Selecione os apps do Marketplace que os usuários podem executar e instalar.	access_level	enum: ALLOW_ALL ALLOW_LISTED_APPS ALLOW_NONE

Subconfigurações do Marketplace

Nome da subconfiguração da API Policy	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
AppsAllowlistSetting	N/A	application_id	string
	N/A	acesso	enum: ALLOWED BLOCKED

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

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	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	Não	Permitir a gravação de reuniões.	enable_recording	booleano
	Configurações de vídeo do Meet > Transcrição automática	meet.automatic_transcription	Não	As reuniões são transcritas por padrão	ativado	booleano
	Configurações de vídeo do Meet > Gravação automática	meet.automatic_recording	Não	As reuniões são gravadas por padrão	ativado	booleano
	Configurações de segurança do Meet > Domínio	meet.safety_domain	Não	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	Não	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	enum: SAME_ORGANIZATION_ONLY ANY_WORKSPACE_ORGANIZATION ALL
	Configurações de segurança do Meet > Gerenciamento de organizadores	meet.safety_host_management	Não	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	Não	Indica quem não faz parte da organização ou não teve a identidade confirmada.	enable_external_label	booleano
	Configurações de segurança do Meet > Participação	meet.joining	Não	Tipo de acesso à reunião (sujeito às restrições definidas no domínio)	allowed_audience	enum: ALLOWED_AUDIENCE_UNSPECIFIED OPEN TRUSTED RESTRICTED
	Configurações de segurança do Meet > Chat	meet.messaging	Não	Quem pode enviar mensagens de chat na chamada	ativado	booleano
	Configurações de segurança do Meet > Apresentar	meet.presenting	Não	Quem pode compartilhar telas nas chamadas.	ativado	booleano
	Configurações de segurança do Meet > Perguntas e respostas	meet.questions	Não	Quem pode participar de sessões de perguntas e respostas nas chamadas	ativado	booleano
	Configurações de segurança do Meet > Enquetes	meet.polls	Não	Quem pode participar de enquetes nas chamadas	ativado	booleano
	Configurações de segurança do Meet > Restrições de chamadas recebidas	meet.meet_incoming_call_restrictions	Não	Essa configuração afeta apenas as Chamadas do Meet, mas não os serviços legados e as ligações do Google Chat. As restrições definidas em "Acesso" podem limitar ainda mais as chamadas que os usuários podem receber.	allowed_callers	enum: ALLOWED_CALLERS_UNSPECIFIED ALL CONTACTS_AND_ORGANIZATION_ONLY NONE

Configurações de provisionamento

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível com v1beta1	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Configurações da conta	Gerenciamento de contas conflitantes	provisioning.conflicting_accounts_management	Não	Escolha como gerenciar contas conflitantes	opção	enum: OPTION_UNSPECIFIED AUTOMATICALLY_SEND_INVITATIONS REPLACE_CONFLICTING_ACCOUNT PRESERVE_CONFLICTING_ACCOUNT
				Enviar e-mails de acompanhamento diários por (especificado) dias	automatic_invitations.invitation_count	integer
				Se um usuário não aceitar um convite no período de acompanhamento selecionado	automatic_invitations.unaccepted_invitation_resolution_option	enum: UNACCEPTED_INVITATION_RESOLUTION_OPTION_UNSPECIFIED REPLACE_CONFLICTING_ACCOUNT_ON_NEXT_CREATION PRESERVE_CONFLICTING_ACCOUNT_ON_NEXT_CREATION

Configurações de regras e detectores

Nesta seção, descrevemos as configurações de regras e detectores.

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

Para uma visão geral de como criar regras e detectores de proteção de dados para os aplicativos compatíveis, consulte Criar 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	Mutate compatível	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	Sim	Nome	display_name	string
				Descrição	description	string
				Apps	gatilhos	string[]: uma lista de strings de acionador específicas do aplicativo. Especifique um ou mais gatilhos para monitorar. A regra é avaliada quando qualquer um dos acionadores especificados ocorre. Consulte a seção Acionadores para ver os valores disponíveis.
				Condições	transição	string: expressão da Common Expression Language (CEL) das condições de dados que a regra verifica. A sintaxe da 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 app a serem realizadas quando as condições são atendidas. As ações disponíveis por acionador de app são fornecidas na seção "Ações" abaixo.
				Estado	estado	enum: 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 regras de proteção de dados, contém o nível de gravidade dos eventos acionados.

Gatilhos

A tabela a seguir mostra a lista de plataformas, aplicativos e acionadores disponíveis:

Plataforma	Aplicativo	Gatilho	Valor da API
Google Workspace	Gmail	Mensagem enviada	google.workspace.gmail.email.v1.send
		Mensagem recebida	google.workspace.gmail.email.v1.receive
	Google Drive	Arquivos do Drive	google.workspace.drive.file.v1.share
	Google Chat	Mensagem enviada	google.workspace.chat.message.v1.send
		Upload do arquivo concluído	google.workspace.chat.attachment.v1.upload
Chrome	Chrome	Upload do arquivo concluído	google.workspace.chrome.file.v1.upload
		Download concluído	google.workspace.chrome.file.v1.download
		Conteúdo colado	google.workspace.chrome.web_content.v1.upload
		Conteúdo impresso	google.workspace.chrome.page.v1.print
		URL acessado	google.workspace.chrome.url.v1.navigation
ChromeOS	ChromeOS	Restrições de transferência de arquivos	google.workspace.chromeos.file.v1.transfer

Condições

Para representar condições de dados, a API usa expressões da Common Expressions Language (CEL). Cada condição segue o padrão de {match source}.{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 apple.

Origens de correspondência

A lista de origens de correspondência disponíveis, que correspondem às configurações de correspondência com os mesmos nomes 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
• title
• to_header_recipients
• url
• url_category

Conteúdo a ser verificado

A lista de conteúdo disponível para verificação, correspondente às configurações de correspondência com os mesmos nomes 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 ao tipo de dados predefinido no Admin Console.
  • {detector name} indica o tipo de dados predefinido a ser verificado, que pode ser um dos infotypes integrados compatíveis com a Proteção de Dados Sensíveis: https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference (por exemplo, CREDIT_CARD_NUMBER ou US_SOCIAL_SECURITY_NUMBER). Alguns tipos de detector mais recentes não são compatíveis com essa API e retornam um erro se forem especificados.
  • {likelihood} indica o limite de probabilidade da correspondência. Por exemplo, google.privacy.dlp.v2.Likelihood.LIKELY corresponde ao limite Alto 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 a palavras da lista de palavras no Admin Console.
  • {detector name} é o nome do recurso da política que representa o detector de 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 para o acionador de URL visitado do Chrome.
  • {category} indica a categoria de URL compatível com a configuração do Admin Console. Para ver a lista de categorias disponíveis e as representações de API delas, consulte Categorias de URL.
• contains_word({string})
  • Corresponde se o conteúdo tiver {string} como uma palavra inteira.
• matches_file_extension({extension})
  • Faz correspondência se a extensão do arquivo é {extension}.
• matches_mime_types({categories}, {custom_types})
  • Corresponde se o tipo MIME do arquivo pertencer a um dos {categories} ou {custom_types} especificados.
• matches_metadata({metadata_criteria})
  • Corresponde aos arquivos do Drive com base em {metadata_criteria} definidos nos marcadores do Drive.
• matches_enum({enum_value})
  • Faz a correspondência de campos baseados em tipo enumerado com {enum_value}. Por exemplo, encryption_state.matches_enum('ENCRYPTED').
• matches_url_list({url_list_id})
  • Corresponde se o URL estiver presente na lista de URLs especificada {url_list_id}.
• matches_url_risk_level({risk_level})
  • Faz correspondência se o nível de risco do URL é {risk_level}.
• matches_address({email})
  • Corresponde se o endereço de e-mail for {email}.
• matches_address_domain_name({domain})
  • Faz correspondência se o domínio do endereço de e-mail é {domain}.
• matches_address_regex({regex})
  • Corresponde se o endereço de e-mail corresponder à expressão regular {regex}.

Condições compostas

Várias condições básicas podem ser combinadas 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 o conteúdo verificado tiver as substrings "maçã" e "banana".

Sintaxe de expressão CEL para regras

A expressão da Common Expression Language (CEL) que define a lógica de uma regra é encontrada no campo condition do recurso Rule. Esse campo normalmente é uma mensagem google.type.Expr, com a expressão CEL em um campo expression ou cel_expression.

Para criar uma regra válida, use as funções CEL compatíveis com o aplicativo, o evento de acionamento e a origem de correspondência específicos que você está segmentando.

A tabela a seguir lista as origens de correspondência e as funções de condição disponíveis para cada aplicativo e acionador das regras de proteção de dados (DLP).

Aplicativo	Evento de gatilho	Origem da correspondência	Funções de condição CEL disponíveis
Gmail	Mensagem enviada Mensagem recebida	all_content, body, subject, all_headers	contains({string}) contains_word({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
		file_name	contains({string}) contains_word({string})
		file_extension	matches_file_extension({extension})
		file_type	matches_mime_types({categories}, {custom_types})
		drive_enterprise_metadata	matches_metadata({metadata_criteria})
		message_security_status	matches_enum({enum_value}) (por exemplo, 'CONFIDENTIAL_MODE_ENABLED')
Drive	Arquivos do Drive	all_content, body	contains({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
		title	contains({string}) contains_word({string}) ends_with({string}) starts_with({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
		suggestion	contains({string}) contains_word({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
		file_name	contains({string}) contains_word({string})
		file_extension	matches_file_extension({extension})
		file_type	matches_mime_types({categories}, {custom_types})
		drive_enterprise_metadata	matches_metadata({metadata_criteria})
		encryption_state	matches_enum({enum_value}) (por exemplo, 'ENCRYPTED')
Chat	Mensagem enviada Arquivo enviado por upload	all_content	contains({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
	Somente arquivo enviado por upload	file_name	contains({string}) contains_word({string})
		file_extension	matches_file_extension({extension})
		file_type	matches_mime_types({categories}, {custom_types})
Chrome	Arquivo enviado por upload Arquivo transferido por download Conteúdo colado Conteúdo impresso	all_content, body	contains({string}) contains_word({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
	Arquivo enviado por upload Arquivo baixado Conteúdo impresso	title	contains({string}) contains_word({string}) ends_with({string}) starts_with({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
	Todos os acionadores do Chrome	url, source_url	contains({string}) ends_with({string}) starts_with({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_url_list({url_list_id}) (Observação: o url também é compatível com o matches_url_risk_level({risk_level}))
		url_category, source_url_category	matches_web_category({category})
		file_type	matches_mime_types({categories}, {custom_types})
		file_size_in_bytes	Operadores de comparação padrão (por exemplo, all_content.file_size_in_bytes > 1048576)
		web_app_signed_in_account, source_web_app_signed_in_account	matches_address({email}) matches_address_domain_name({domain}) matches_address_regex({regex})
	Somente conteúdo colado	source_chrome_context	matches_enum({enum_value}) (valores: 'CLIPBOARD', 'INCOGNITO', 'OTHER_PROFILE')
ChromeOS	Restrições de transferência de arquivos	all_content, body	contains({string}) contains_word({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
		title	contains({string}) contains_word({string}) ends_with({string}) starts_with({string}) matches_regex_detector({detector name}, {minimum_match_count: {count}}) matches_dlp_detector({detector name}, {likelihood}, {minimum_match_count: {count}, minimum_unique_match_count: {count}}) matches_word_list({detector name}, {minimum_match_count: {count}, minimum_unique_match_count: {count}})
		file_type	matches_mime_types({categories}, {custom_types})
		file_size_in_bytes	Operadores de comparação padrão

Ações

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

Aplicativo	Tecla 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
		applyLabels	Aplicar rótulos de classificação
		addFooter	Adicionar nota personalizada (rodapé)
Chat	chatAction	blockContent	Bloquear mensagem
		warnUser	Avisar aos usuários
		auditOnly	Somente auditoria
Google Chrome	chromeAction	blockContent	Bloquear
		warnUser	Permitir com alerta
ChromeOS	chromeOsAction	blockContent	Bloquear
		warnUser	Permitir com alerta
		auditOnly	Somente auditoria

Parâmetros da ação

Os parâmetros de ação fornecem configuração adicional para ações de regra. Os parâmetros disponíveis dependem do aplicativo.

Exemplo de configuração de parâmetros de ação

O exemplo a seguir demonstra como especificar parâmetros de ação para uma ação blockContent do Chrome, ativando o Evidence Locker (saveContent) e definindo uma mensagem de marca-d'água (watermarkMessage). Isso usa a representação Struct genérica usada pela API.

fields {
  key: "action"
  value {
    struct_value {
      fields {
        key: "chromeAction"
        value {
          struct_value {
            fields {
              key: "blockContent"
              value {
                struct_value {
                  fields {
                    key: "actionParams"
                    value {
                      struct_value {
                        fields {
                          key: "saveContent"
                          value {
                            bool_value: true
                          }
                        }
                        fields {
                          key: "watermarkMessage"
                          value {
                            string_value: "CONFIDENTIAL"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Parâmetros de ação do Drive

As ações do Drive geralmente não usam parâmetros adicionais. No entanto, a ação restrictCopyPrintDownload exige a especificação de um escopo.

Parâmetro	Tipo de dado	Descrição
restrict_copy_print_download.scope	enum	Especifica o escopo de usuários para os quais o download, a impressão e a cópia serão desativados. SCOPE_UNSPECIFIED: escopo não especificado. VIEWERS_AND_COMMENTERS: desativar para leitores e comentaristas. ALL_COLLABORATORS: desativar para todos os colaboradores (leitores, comentaristas, editores, proprietários).

Parâmetros de ação do Gmail

Parâmetro	Tipo de dado	Descrição
apply_internal_messages	booleano	Aplica a ação às mensagens internas.
apply_external_messages	booleano	Aplica a ação às mensagens externas.
apply_to_internal_receive_messages	booleano	Aplica a ação às mensagens recebidas internamente.
apply_to_external_receive_messages	booleano	Aplica a ação às mensagens recebidas de fora.
custom_end_user_message.unsafe_html_message_body	string	Conteúdo da mensagem HTML que será exibido ao usuário final quando uma regra for acionada. Somente tags <a> são aceitas.
add_footer.footer.title	string	O título da nota personalizada (máximo de 50 caracteres).
add_footer.footer.unsafe_html_message_body	string	Texto de descrição em HTML para a observação personalizada. Somente as tags <a> são aceitas (máximo de 300 caracteres).
add_footer.footer.banner_highlighted	booleano	Indica se a nota personalizada precisa ser destacada em um banner.
add_footer.footer.position	enum	A posição da observação personalizada na mensagem: TOP ou BOTTOM.
apply_labels.label_delta	Struct[]	Lista de mudanças de rótulo a serem aplicadas. Cada objeto contém: label_id: string field_delta: struct com campos: field_id: string selection: string (para campos de seleção única) selection_list: struct com operation (SET, MERGE) e values (string[])
apply_labels.conflict_resolution_strategy	enum	Estratégia para resolver conflitos: SYSTEM_OVERRIDE ou ALLOW_USER_OVERRIDE.
apply_labels.custom_end_user_message.unsafe_html_message_body	string	Conteúdo da mensagem HTML que será exibido ao usuário final quando a ação de aplicar marcadores for acionada. Somente tags <a> são aceitas.
quarantine_message.quarantine_resource_name	string	O nome do recurso da quarentena. Segue o formato quarantines/obfuscated<id> ou quarantines/default.

Parâmetros de ação do Chat

Parâmetro	Tipo de dado	Descrição
apply_internal_direct_messages	booleano	Aplica a ação às mensagens diretas individuais internas.
apply_external_direct_messages	booleano	Aplica a ação às mensagens enviadas usando mensagens diretas individuais externas.
apply_internal_rooms	booleano	Aplica a ação às mensagens enviadas para salas internas.
apply_external_rooms	booleano	Aplica a ação às mensagens enviadas para salas externas.
apply_internal_group_chats	booleano	Aplica a ação às mensagens enviadas para grupos de chat internos.
apply_external_group_chats	booleano	Aplica a ação às mensagens enviadas para grupos de chat externos.
custom_end_user_message.unsafe_html_message_body	string	Conteúdo da mensagem HTML que será exibido ao usuário final quando uma regra for acionada. Somente tags <a> são aceitas.

Parâmetros de ação do Google Chrome

Parâmetro	Tipo de dado	Descrição
save_content	booleano	Permite salvar com segurança o conteúdo que aciona esta regra (Evidence Locker).
watermark_message	string	Texto exibido como marca-d'água quando uma regra de navegação de URL é acionada.
custom_end_user_message.unsafe_html_message_body	string	Conteúdo da mensagem HTML que será exibido ao usuário final quando uma regra for acionada. Somente tags <a> são aceitas.
block_screenshot	booleano	Bloqueia capturas e compartilhamento de tela quando definido como true.
match_only_download_url	booleano	Avalia a regra com base apenas no URL de download, ignorando o URL da guia.
force_save_to_cloud_sub_action.destination	enum	Destino de armazenamento em nuvem para salvamentos forçados em vez do sistema de arquivos local. DESTINATION_UNSPECIFIED: destino não especificado. GOOGLE_DRIVE_CORP: salva arquivos no Google Drive corporativo. ONEDRIVE_CORP: salva arquivos no Microsoft OneDrive corporativo.
data_masking.regex_detector	Struct[]	Uma lista de detectores de expressões regulares usados para mascaramento de dados. Especifique um ou mais detectores como uma lista de objetos, cada um contendo os campos descritos na tabela a seguir.
data_masking.regex_detector[].mask_type	enum	Tipo de mascaramento a ser aplicado quando a expressão regular corresponder. MASK_TYPE_LIGHT_OBFUSCATION: o texto mascarado pode ser revelado ao manter o ponteiro sobre ele. MASK_TYPE_HARD_OBFUSCATION: o texto mascarado pode ser revelado com um clique do mouse. MASK_TYPE_REDACT: o texto é substituído por completo e não pode ser recuperado.
data_masking.regex_detector[].resource_name	string	Identificador do recurso do detector.
data_masking.regex_detector[].display_name	string	Nome do detector exibido nas ferramentas de relatórios (como a ferramenta de investigação de segurança) quando acionado.
data_masking.regex_detector[].regex_pattern	string	O padrão de expressão regular usado para correspondência. Este campo é preenchido pelo sistema e não deve ser definido pelo usuário.

Parâmetros de ação do ChromeOS

Parâmetro	Tipo de dado	Descrição
save_content	booleano	Permite salvar com segurança o conteúdo que aciona esta regra.

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 exemplo de valor 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

Para uma visão geral das regras e dos detectores de proteção de dados, consulte Criar regras e detectores de conteúdo personalizados para a DLP do Drive.

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	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 detector.url_list	Sim	Nome	display_name	string
				Descrição	description	string
				Expressão regular	regular_expression	Struct: contém a string de expressão regular. Defina apenas se o tipo de detector for detector.regular_expression.
				Lista de palavras	word_list	Struct: contém a lista de strings de palavras. Definido apenas se o tipo de detector for detector.word_list.
				Lista de URLs	url_list	Struct: contém a lista de strings de URL. Definido apenas se o tipo de detector for detector.url_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

Nesta seção, descrevemos as regras de alerta definidas pelo sistema do Google Workspace.

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	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	Não	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. Confira os detalhes na seção "Ações" abaixo.
				Estado	estado	enum: 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	Descrição
alertCenterAction	alertCenterConfig	Enviar para a Central de alertas	Configura a gravidade do alerta e se ele é enviado para a Central de alertas.
	destinatários	Enviar notificações por e-mail	Lista de endereços de e-mail para enviar notificações quando o alerta for acionado.

Parâmetros da ação

A tabela a seguir mostra os parâmetros para alertCenterAction:

Parâmetro	Tipo de dado	Descrição
alertCenterConfig.severity	enum	A gravidade do alerta (por exemplo, LOW, MEDIUM, HIGH).
alertCenterConfig.status	enum	Se o alerta é enviado para a Central de alertas (por exemplo, ENABLED, DISABLED).
recipients	string[]	Uma lista de endereços de e-mail para receber notificações por e-mail.

Configurações de segurança

Página no Admin Console	Configuração específica no Admin Console	Tipo de configuração da API Policy	Mutate compatível	Legenda do Admin Console	Nome do campo da API Policy	Tipo de dado
Recuperação de conta	Recuperação de conta de superadmin	security.super_admin_account_recovery	Não	Permitir que os superadmins recuperem a conta	enableAccountRecovery	booleano
	Recuperação de conta de usuário	security.user_account_recovery	Não	Permitir que usuários e administradores (exceto superadministradores) recuperem as contas	enableAccountRecovery	booleano
Gerenciamento de senha	Gerenciamento de senhas	security.password	Não	Expiração	expirationDuration	Segundos (0 segundos significa que nunca expira)
				Reutilizar	allowReuse	booleano
				Aplicação de força e comprimento	enforceRequirementsAtLogin	booleano
				Comprimento (comprimento máximo)	maximumLength	integer
				Comprimento (comprimento mínimo)	minimumLength	integer
				Força	allowedStrength	enum: STRONG WEAK
Controle de sessão do Google	Controle de sessão	security.session_controls	Não	Duração da sessão da Web	webSessionDuration	Segundos
Apps menos seguros	Apps menos seguros	security.less_secure_apps	Não	Controle o acesso dos usuários a apps que usam tecnologia de login menos segura e deixam as contas mais vulneráveis.	allowLessSecureApps	booleano
Desafios de login	Desafios de login	security.login_challenges	Não	Usar o ID de funcionário para aumentar a proteção dos meus usuários	enableEmployeeIdChallenge	booleano
Sem senha	Restrição de chaves de acesso	security.passkeys_restriction	Não	Escolher os tipos de chaves de acesso que podem ser usadas para fazer login	allowed_passkeys_type	enum: ALLOWED_PASSKEYS_TYPE_UNSPECIFIED HARDWARE_SECURITY_KEYS_ONLY ANY_DEVICE_OR_PLATFORM
Programa Proteção Avançada	Inscrição	security.advanced_protection_program	Não	Usar o ID de funcionário para aumentar a proteção dos meus usuários	enableAdvancedProtectionSelfEnrollment	booleano
				Códigos de segurança	securityCodeOption	enum: ALLOWED_WITH_REMOTE_ACCESS ALLOWED_WITHOUT_REMOTE_ACCESS CODES_NOT_ALLOWED
Verificação em duas etapas	Authentication	security.two_step_verification_enrollment	Não	Permitir que os usuários ativem a verificação em duas etapas	allowEnrollment	booleano
		security.two_step_verification_enforcement		Aplicação	enforcedFrom	Carimbo de data/hora
		security.two_step_verification_grace_period		Período de inscrição para novos usuários	enrollmentGracePeriod	Duração
		security.two_step_verification_device_trust		Permitir que o usuário confie no dispositivo	allowTrustingDevice	booleano
		security.two_step_verification_enforcement_factor		Métodos	allowedSignInFactorSet	enum: ALL PASSKEY_ONLY PASSKEY_PLUS_SECURITY_CODE PASSKEY_PLUS_IP_BOUND_SECURITY_CODE NO_TELEPHONY
		security.two_step_verification_sign_in_code		Período de carência para suspensão da política de verificação em duas etapas	backupCodeExceptionPeriod	Duração
Configurações de aprovação de outra parte	Configurações de aprovação de outra parte	multi_party_approval.require_approvals	Não	Escolha se um admin com privilégios de aprovação de outra parte precisa aprovar ações sensíveis no Admin Console e na API Admin	multi_party_approval_state	enum: MULTI_PARTY_APPROVAL_STATE_UNSPECIFIED ENABLED DISABLED
	Aprovação de outra parte para configurações de segurança	multi_party_approval.security_actions	Não	Verificação em duas etapas	two_step_verification_multi_party_approval_state
				Recuperação de conta	account_recovery_multi_party_approval_state
				Controle de sessão do Google	session_controls_multi_party_approval_state
				Programa Proteção Avançada	advanced_protection_program_multi_party_approval_state
				Desafios de login	login_challenges_multi_party_approval_state
				Sem senha	passwordless_multi_party_approval_state
				Delegação em todo o domínio	domain_wide_delegation_multi_party_approval_state
				SSO com IdPs de terceiros	sso_with_third_party_idps_multi_party_approval_state
				Acesso baseado no contexto	context_aware_access_multi_party_approval_state
	Aprovação de outra parte para acesso da API às configurações de segurança	multi_party_approval.security_actions_api_access	Não	SSO com IdPs de terceiros	sso_with_third_party_idps_multi_party_approval_state
	Aprovação de outra parte para as configurações da agenda	multi_party_approval.calendar_actions	Não	Compartilhamento de agendas	calendar_sharing_multi_party_approval_state
				Configurações gerais da agenda	general_calendar_settings_multi_party_approval_state
				Configurações para o arquivamento de terceiros do conteúdo do app Agenda	third_party_archiving_settings_multi_party_approval_state
	Aprovação de outra parte para configurações de grupos	multi_party_approval.groups_actions	Não	Compartilhamento de grupos	groups_sharing_multi_party_approval_state
	Aprovação de outra parte para configurações de admin de domínios	multi_party_approval.domains_actions	Não	API Domains	domains_api_multi_party_approval_state

Configurações de status do serviço

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

A API Policy é compatível com as configurações de status de serviço do Google Workspace, dos serviços adicionais do Google e dos serviços de IA generativa listados no Admin Console.

Google Workspace

Nome do serviço no Admin Console	Nome do serviço na API Policy
AppSheet	appsheet
Agenda	calendário
Cloud Search	cloud_search
Google Drive e Google Docs	drive_and_docs
Gmail	gmail
Google Chat	chat
Google Meet	meet
Google Vault	vault
Google Voice	voz
Grupos para empresas	groups_for_business
Keep	keep
Sites	sites
Tarefas	tarefas

Serviços adicionais do Google

Nome do serviço no Admin Console	Nome do serviço na API Policy
AI Studio	ai_studio
Habilidades digitais aplicadas	applied_digital_skills
Atividades	atribuições
Blogger	blogger
Contas de marca	brand_accounts
Campaign Manager 360	campaign_manager
Chrome Canvas	chrome_canvas
Cursivo do Chrome	chrome_cursive
Á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
Currents	currents
Apps com acesso antecipado	early_access_apps
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	pay
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	takeout
Google Tradutor	traduzir
Google Trips	trips
Jamboard	jamboard
Histórico de localização	location_history
Data Studio	data_studio
Google Play gerenciado	managed_play
Material Gallery	material_gallery
Merchant Center	merchant_center
Partner Dash	partner_dash
Pinpoint	pinpoint
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
Work Insights	work_insights
YouTube	youtube

IA generativa

Nome do serviço no Admin Console	Nome do serviço na API Policy
App Gemini	gemini_app
NotebookLM	notebooklm

Configurações de sites

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

Configurações do UserTakeout

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