Google BigQuery

Visão geral

O Google BigQuery é um data warehouse totalmente gerenciado e serverless que permite executar consultas SQL analíticas em conjuntos de dados massivos com alta velocidade e escala. Com a integração no SquadOS, seus agentes podem criar e consultar datasets, executar jobs SQL, gerenciar tabelas, rotinas e modelos de machine learning, além de controlar permissões IAM diretamente via linguagem natural.

• Site oficial: https://cloud.google.com/bigquery
• Documentação na Composio: docs.composio.dev/toolkits/googlebigquery

Autenticação

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) ou conta de serviço Google (GOOGLE_SERVICE_ACCOUNT) para conectar.

Você vai precisar de uma das seguintes formas de autenticação:

Campo	Obrigatório	Descrição
Conta Google (OAuth 2.0)	Sim	Autorize o acesso via fluxo OAuth na página segura da Composio.
Conta de serviço (JSON)	Sim (alternativa)	JSON de credenciais de uma service account com permissões no projeto BigQuery.

Como obter a credencial

Opção 1 — OAuth 2.0 (recomendado para uso pessoal)

1. Acesse o Google Cloud Console e faça login.
2. Certifique-se de que a BigQuery API está habilitada no projeto desejado.
3. Ao conectar via SquadOS, você será redirecionado para autorizar o acesso OAuth diretamente na página segura da Composio.

Opção 2 — Conta de serviço (recomendado para automações)

1. Acesse o Google Cloud Console e selecione seu projeto.
2. Vá em IAM e administrador → Contas de serviço.
3. Clique em Criar conta de serviço, preencha o nome e atribua os papéis BigQuery User e BigQuery Data Editor (ou o papel adequado ao escopo desejado).
4. Após criar, vá na conta de serviço → aba Chaves → Adicionar chave → Criar nova chave → JSON.
5. Faça download do arquivo JSON — esse é o valor a informar ao conectar via conta de serviço no SquadOS.

Dica

Use o princípio do menor privilégio: conceda apenas os papéis BigQuery necessários para o agente. Para consultas somente leitura, BigQuery Data Viewer e BigQuery Job User são suficientes.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por Google BigQuery.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth 2.0 ou informa as credenciais da conta de serviço.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Cancelar job do BigQuery

GOOGLEBIGQUERY_CANCEL_JOB

Cancela um job em execução no BigQuery. A chamada retorna imediatamente; é necessário verificar o status do job para confirmar se o cancelamento foi concluído. Jobs cancelados podem ainda gerar custos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
job_id	string	Sim	ID do job a cancelar.
location	string	Não	Localização geográfica do job. Obrigatório quando o job não está na região multi-regional us ou eu, ou quando está em uma região única (ex.: us-central1).
project_id	string	Sim	ID do projeto do job a cancelar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar compromisso de capacidade

GOOGLEBIGQUERY_CREATE_CAPACITY_COMMITMENT

Cria um novo recurso de compromisso de capacidade no BigQuery Reservation. Use quando precisar adquirir capacidade de processamento (slots) com período de comprometimento para jobs do BigQuery. Suporta planos FLEX, MONTHLY, ANNUAL, THREE_YEAR e edições STANDARD, ENTERPRISE, ENTERPRISE_PLUS.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
plan	string ("COMMITMENT_PLAN_UNSPECIFIED" | "FLEX" | "FLEX_FLAT_RATE" | "TRIAL" | "MONTHLY" | "MONTHLY_FLAT_RATE" | "ANNUAL" | "ANNUAL_FLAT_RATE" | "THREE_YEAR" | "NONE")	Sim	Plano do compromisso de capacidade. Determina o período e o preço.
parent	string	Sim	Nome do recurso pai da reserva. Deve estar no formato projects/{project}/locations/{location} (ex.: projects/myprojeto/locations/US).
edition	string ("EDITION_UNSPECIFIED" | "STANDARD" | "ENTERPRISE" | "ENTERPRISE_PLUS")	Não	Edição do compromisso de capacidade.
slotCount	string	Sim	Número de slots no compromisso. Deve ser um inteiro positivo representado como string.
renewalPlan	string	Não	Plano de renovação do compromisso de capacidade.
capacityCommitmentId	string	Não	ID opcional do compromisso. Gerado automaticamente se vazio. Máximo 64 caracteres alfanuméricos minúsculos ou hífens.
multiRegionAuxiliary	boolean	Não	Aplica-se apenas a compromissos em multi-regiões do BigQuery (US ou EU). Se verdadeiro, o compromisso é colocado na região secundária da organização para recuperação de desastres.
enforceSingleAdminProjectPerOrg	boolean	Não	Se verdadeiro, falha a requisição se outro projeto da organização já tiver um compromisso de capacidade.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar conexão do BigQuery

GOOGLEBIGQUERY_CREATE_CONNECTION

Cria uma nova conexão do BigQuery com fontes de dados externas usando a BigQuery Connection API. Use para configurar conexões com AWS, Azure, Cloud Spanner, Cloud SQL, Salesforce DataCloud ou Apache Spark.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
aws	object	Não	Propriedades de conexão específicas da Amazon Web Services (AWS).
azure	object	Não	Propriedades de conexão específicas do Azure.
spark	object	Não	Propriedades de conexão para executar stored procedures no Apache Spark.
parent	string	Sim	Nome do recurso pai no formato projects/{project_id}/locations/{location_id}. Exemplo: projects/meu-projeto/locations/us-central1.
cloudSql	object	Não	Propriedades de conexão específicas do Cloud SQL.
kmsKeyName	string	Não	Chave Cloud KMS usada para criptografia.
description	string	Não	Descrição da conexão fornecida pelo usuário.
cloudSpanner	object	Não	Propriedades de conexão específicas do Cloud Spanner.
connectionId	string	Não	ID de conexão opcional. Gerado aleatoriamente se não especificado.
friendlyName	string	Não	Nome de exibição fornecido pelo usuário para a conexão.
cloudResource	object	Não	Propriedades para delegação de acesso a recursos GCP.
salesforceDataCloud	object	Não	Propriedades de conexão específicas do Salesforce DataCloud.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar data exchange do Analytics Hub

GOOGLEBIGQUERY_CREATE_DATA_EXCHANGE

Cria um novo data exchange do Analytics Hub para compartilhamento de datasets do BigQuery. Use quando precisar configurar um contêiner para compartilhamento de dados com informações descritivas e listagens.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
icon	string	Não	Imagem em Base64 representando o data exchange. Tamanho máximo: 3,0 MiB. Dimensões esperadas: 512x512 pixels.
parent	string	Sim	Caminho do recurso pai no formato projects/{project}/locations/{location}. Exemplo: projects/meu-projeto/locations/US.
description	string	Não	Descrição do data exchange. Máximo 2000 bytes.
displayName	string	Sim	Nome de exibição legível do data exchange. Máximo 63 bytes.
documentation	string	Não	Documentação descrevendo o data exchange.
dataExchangeId	string	Sim	ID do data exchange. Deve conter apenas letras Unicode, números (0-9) ou sublinhados. Máximo 100 bytes.
primaryContact	string	Não	E-mail ou URL do ponto de contato principal do data exchange. Máximo 1000 bytes.
sharingEnvironmentConfig	object	Não	Configuração do ambiente de compartilhamento para o comportamento do data exchange.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar listagem do Analytics Hub

GOOGLEBIGQUERY_CREATE_DATAEXCHANGES_LISTINGS

Cria uma nova listagem em um data exchange do Analytics Hub. Use quando precisar compartilhar um dataset do BigQuery com assinantes específicos ou torná-lo disponível para descoberta. O dataset deve existir e estar na mesma região que o data exchange.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Caminho do recurso pai no formato projects/{projectId}/locations/{location}/dataExchanges/{dataExchangeId}. A localização deve coincidir com a do dataset.
listingId	string	Sim	ID da listagem. Deve conter apenas letras Unicode, números (0-9) ou sublinhados. Máximo 100 bytes.
publisher	object	Não	Detalhes do publicador que possui a listagem.
categories	array	Não	Categorias da listagem. Até duas categorias são permitidas.
description	string	Não	Descrição resumida da listagem. Máximo 2000 bytes.
displayName	string	Sim	Nome de exibição legível da listagem. Máximo 63 bytes.
dataProvider	object	Não	Detalhes do provedor de dados que possui os dados de origem.
documentation	string	Não	Documentação descrevendo a listagem em detalhes.
requestAccess	string	Não	E-mail ou URL para solicitar acesso à listagem. Máximo 1000 bytes.
primaryContact	string	Não	E-mail ou URL do ponto de contato principal da listagem. Máximo 1000 bytes.
bigqueryDataset	object	Sim	Dataset do BigQuery a ser compartilhado. Deve existir e estar na mesma região que o data exchange.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar dataset do BigQuery

GOOGLEBIGQUERY_CREATE_DATASET

Cria um novo dataset do BigQuery com localização, rótulos e descrição explícitos usando a API de Datasets. Use quando o fluxo precisar configurar um dataset de staging/warehouse e a correção da região for crítica para evitar erros de localização em jobs downstream.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
access	array	Não	Lista de controle de acesso (ACL) do dataset. Se não especificada, herda as permissões do projeto.
labels	object	Não	Rótulos para organizar o dataset. Chaves e valores devem ser minúsculos, máximo 63 caracteres.
location	string	Sim	Localização geográfica onde o dataset deve residir. Crítico para evitar erros de localização. Exemplos: US, EU, us-central1, europe-west1.
dataset_id	string	Sim	ID do dataset. Deve ser único no projeto. Use caracteres alfanuméricos, sublinhados ou hífens.
project_id	string	Sim	ID do projeto onde o dataset será criado.
description	string	Não	Descrição do dataset.
friendly_name	string	Não	Nome amigável para o dataset exibido na UI do BigQuery.
defaultTableExpirationMs	integer	Não	Tempo de vida padrão de todas as tabelas do dataset, em milissegundos.
defaultPartitionExpirationMs	integer	Não	Tempo de vida padrão de todas as partições das tabelas do dataset, em milissegundos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar listagem do Analytics Hub (v2)

GOOGLEBIGQUERY_CREATE_LISTING

Cria uma nova listagem em um data exchange usando a API do Analytics Hub. Use ao publicar um dataset do BigQuery para disponibilizá-lo para assinatura por outros usuários ou organizações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alt	string ("json" | "media" | "proto")	Não	Formato de dados para a resposta.
key	string	Não	Chave de API do projeto.
icon	string	Não	Imagem em Base64 representando a listagem. Tamanho máximo: 3,0 MiB.
xgafv	string ("1" | "2")	Não	Formato de erro V1.
fields	string	Não	Seletor especificando quais campos incluir na resposta parcial.
parent	string	Sim	Caminho do recurso pai. Formato: projects/{project_id}/locations/{location}/dataExchanges/{data_exchange_id}.
callback	string	Não	Parâmetro de callback JSONP.
listingId	string	Não	ID da listagem. Gerado aleatoriamente se não fornecido.
publisher	object	Não	Detalhes do publicador da listagem.
categories	array	Não	Categorias da listagem. Até duas categorias.
quota_user	string	Não	String arbitrária para fins de cota. Máximo 40 caracteres.
uploadType	string	Não	Protocolo de upload legado para mídia.
description	string	Não	Descrição resumida da listagem. Máximo 2000 bytes.
displayName	string	Sim	Nome de exibição legível da listagem. Máximo 63 bytes.
oauth_token	string	Não	Token OAuth 2.0 para o usuário atual.
prettyPrint	boolean	Não	Retorna resposta com indentações e quebras de linha.
access_token	string	Não	Token de acesso OAuth.
dataProvider	object	Não	Detalhes do provedor de dados.
documentation	string	Não	Documentação descrevendo a listagem.
requestAccess	string	Não	E-mail ou URL para solicitação de acesso. Máximo 1000 bytes.
primaryContact	string	Não	E-mail ou URL do ponto de contato principal. Máximo 1000 bytes.
bigqueryDataset	object	Sim	Referência ao dataset do BigQuery compartilhado.
upload_protocol	string	Não	Protocolo de upload para mídia.
restrictedExportConfig	object	Não	Configuração de exportação restrita para o dataset vinculado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar política de dados do BigQuery (v2beta1)

GOOGLEBIGQUERY_CREATE_LOCATIONS_DATAPOLICIES

Cria uma nova política de dados em um projeto com localização especificada usando a API v2beta1 do BigQuery Data Policy. Use quando precisar configurar regras de mascaramento de dados ou segurança em nível de coluna para dados sensíveis.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso do projeto e localização. Formato: projects/{project_number}/locations/{location_id}. Exemplo: projects/934040047113/locations/us-central1.
dataPolicy	object	Sim	Configuração da política de dados contendo o tipo, a tag de política e as regras de mascaramento.
dataPolicyId	string	Sim	ID atribuído pelo usuário para a política de dados. Deve ser único no projeto. Usado também como nome de exibição.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar template de consulta do Analytics Hub

GOOGLEBIGQUERY_CREATE_QUERY_TEMPLATE

Cria um novo template de consulta em um data exchange do Analytics Hub Data Clean Room (DCR). Use quando precisar definir consultas predefinidas e aprovadas para casos de uso de data clean room. Templates de consulta devem ser criados apenas em data exchanges DCR.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Recurso pai onde o template será criado. Formato: projects/{project}/locations/{location}/dataExchanges/{dataExchange}. Requer um data exchange do tipo Data Clean Room (DCR).
routine	object	Sim	Definição da rotina contendo a lógica do template de consulta.
description	string	Não	Descrição do template de consulta explicando seu propósito e uso.
displayName	string	Sim	Nome legível do template de consulta exibido aos assinantes do data exchange.
queryTemplateId	string	Sim	ID do template. Deve conter apenas letras Unicode, números (0-9) ou sublinhados. Máximo 100 bytes.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar reserva do BigQuery

GOOGLEBIGQUERY_CREATE_RESERVATION

Cria um novo recurso de reserva do BigQuery para garantir capacidade de processamento (slots) para jobs de consulta e pipeline. Use quando precisar reservar recursos de processamento dedicados para desempenho previsível e controle de custos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Projeto e localização. Ex.: projects/myprojeto/locations/US.
edition	string ("EDITION_UNSPECIFIED" | "STANDARD" | "ENTERPRISE" | "ENTERPRISE_PLUS")	Não	Edição da reserva.
autoscale	object	Não	Configurações de auto scaling para a reserva.
concurrency	string	Não	Limite suave no número de jobs que podem rodar simultaneamente nesta reserva. Padrão: 0 (calculado automaticamente).
slotCapacity	string	Sim	Slots base disponíveis para esta reserva. Deve ser um inteiro positivo como string.
reservationId	string	Não	ID opcional da reserva. Gerado automaticamente se não fornecido. Máximo 64 caracteres.
ignoreIdleSlots	boolean	Não	Se falso, jobs desta reserva podem usar slots ociosos de outras reservas do mesmo projeto admin.
multiRegionAuxiliary	boolean	Não	Aplicável apenas para reservas em multi-regiões (US ou EU). Se verdadeiro, a reserva é colocada na região secundária da organização.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar atribuição de reserva do BigQuery

GOOGLEBIGQUERY_CREATE_RESERVATION_ASSIGNMENT

Cria uma atribuição de reserva do BigQuery que permite a um projeto, pasta ou organização enviar jobs usando slots de uma reserva especificada. Um recurso pode ter apenas uma atribuição por combinação de (job_type, location).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso pai da atribuição. Formato: projects/{project_id}/locations/{location}/reservations/{reservation_id}.
jobType	string ("JOB_TYPE_UNSPECIFIED" | "PIPELINE" | "QUERY" | "ML_EXTERNAL" | "BACKGROUND")	Sim	Tipo de jobs que usarão a reserva.
assignee	string	Sim	Recurso que usará a reserva. Pode ser projeto, pasta ou organização. Formato: projects/{project_id}, folders/{folder_id} ou organizations/{org_id}.
assignmentId	string	Não	ID opcional da atribuição. Gerado automaticamente se vazio. Máximo 64 caracteres.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar rotina do BigQuery

GOOGLEBIGQUERY_CREATE_ROUTINE

Cria uma nova rotina definida pelo usuário (função ou procedimento) em um dataset do BigQuery. Use para definir funções/procedimentos SQL, JavaScript, Python, Java ou Scala para lógica reutilizável, transformações de dados ou mascaramento personalizado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
language	string ("LANGUAGE_UNSPECIFIED" | "SQL" | "JAVASCRIPT" | "PYTHON" | "JAVA" | "SCALA")	Não	Linguagem de programação da rotina.
arguments	array	Não	Argumentos de entrada/saída da rotina.
dataset_id	string	Sim	ID do dataset onde a rotina será criada.
project_id	string	Sim	ID do projeto onde a rotina será criada.
returnType	object	Não	Tipo de dados do retorno da rotina.
strictMode	boolean	Não	Se verdadeiro (padrão), o corpo do procedimento é validado contra erros como tabelas inexistentes.
description	string	Não	Descrição da rotina.
routineType	string ("ROUTINE_TYPE_UNSPECIFIED" | "SCALAR_FUNCTION" | "PROCEDURE" | "TABLE_VALUED_FUNCTION" | "AGGREGATE_FUNCTION")	Sim	Tipo da rotina.
securityMode	string ("SECURITY_MODE_UNSPECIFIED" | "DEFINER" | "INVOKER")	Não	Modo de segurança da rotina.
sparkOptions	object	Não	Opções para rotinas Spark definidas pelo usuário.
definitionBody	string	Sim	Corpo da rotina. Para funções SQL, é a expressão na cláusula AS. Para JavaScript, é a string avaliada.
returnTableType	object	Não	Tipo de tabela para funções com valor de tabela.
determinismLevel	string ("DETERMINISM_LEVEL_UNSPECIFIED" | "DETERMINISTIC" | "NOT_DETERMINISTIC")	Não	Nível de determinismo para UDFs JavaScript.
routineReference	object	Sim	Referência contendo projectId, datasetId e routineId para a nova rotina.
importedLibraries	array	Não	Para rotinas JavaScript, caminhos das bibliotecas JavaScript importadas.
dataGovernanceType	string ("DATA_GOVERNANCE_TYPE_UNSPECIFIED" | "DATA_MASKING")	Não	Tipo de governança de dados da rotina.
remoteFunctionOptions	object	Não	Opções para funções remotas definidas pelo usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar tabela do BigQuery

GOOGLEBIGQUERY_CREATE_TABLE

Cria uma nova tabela vazia em um dataset do BigQuery. Use para configurar infraestrutura de dados para tabelas padrão, externas, views ou views materializadas. Suporta particionamento, clustering e configuração de criptografia.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
view	object	Não	Definição de view lógica.
labels	object	Não	Rótulos para organizar tabelas.
schema	object	Não	Schema da tabela definindo seus campos/colunas.
clustering	object	Não	Configuração de clustering da tabela.
dataset_id	string	Sim	ID do dataset onde a tabela será criada.
project_id	string	Sim	ID do projeto onde a tabela será criada.
description	string	Não	Descrição amigável da tabela.
friendlyName	string	Não	Nome descritivo da tabela exibido na UI do BigQuery.
expirationTime	string	Não	Data de expiração da tabela em milissegundos desde a época.
tableReference	object	Sim	Referência identificando a tabela. Deve corresponder ao project_id e dataset_id do caminho.
defaultCollation	string	Não	Collation padrão para novos campos STRING. Opções: und:ci (case insensitive) ou '' (case sensitive, padrão).
materializedView	object	Não	Definição e configuração de view materializada.
timePartitioning	object	Não	Configuração de particionamento por tempo para a tabela.
rangePartitioning	object	Não	Configuração de particionamento por intervalo para a tabela.
requirePartitionFilter	boolean	Não	Se verdadeiro, consultas nesta tabela exigem filtro de partição.
encryptionConfiguration	object	Não	Configuração de criptografia para a tabela.
externalDataConfiguration	object	Não	Configuração para fontes de dados externas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir dataset do BigQuery

GOOGLEBIGQUERY_DELETE_DATASET

Exclui um dataset do BigQuery especificado pelo datasetId via API datasets.delete. Antes da exclusão, todas as tabelas devem ser deletadas, a menos que deleteContents=True seja especificado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
dataset_id	string	Sim	ID do dataset a ser excluído.
project_id	string	Sim	ID do projeto do dataset a ser excluído.
delete_contents	boolean	Não	Se verdadeiro, exclui todas as tabelas do dataset. Se falso (padrão) e o dataset tiver tabelas, a requisição falhará.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir metadados de job do BigQuery

GOOGLEBIGQUERY_DELETE_JOB_METADATA

Exclui os metadados de um job do BigQuery. Se for um job pai com jobs filhos, os metadados de todos os jobs filhos também serão excluídos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
job_id	string	Sim	ID do job cujos metadados serão excluídos. Se for um job pai com filhos, os metadados de todos os filhos também serão excluídos.
location	string	Não	Localização geográfica do job. Obrigatório para jobs em certas regiões.
project_id	string	Sim	ID do projeto do job cujos metadados serão excluídos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir modelo de ML do BigQuery

GOOGLEBIGQUERY_DELETE_MODEL

Exclui um modelo de machine learning do BigQuery de um dataset. A operação exclui o modelo permanentemente e não pode ser desfeita.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
model_id	string	Sim	ID do modelo a excluir.
dataset_id	string	Sim	ID do dataset do modelo a excluir.
project_id	string	Sim	ID do projeto do modelo a excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir rotina do BigQuery

GOOGLEBIGQUERY_DELETE_ROUTINE

Exclui uma rotina do BigQuery pelo seu ID. Use para remover um stored procedure, função definida pelo usuário ou table function de um dataset. Esta operação é irreversível.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
dataset_id	string	Sim	ID do dataset da rotina a excluir.
project_id	string	Sim	ID do projeto da rotina a excluir.
routine_id	string	Sim	ID da rotina a excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir tabela do BigQuery

GOOGLEBIGQUERY_DELETE_TABLE

Exclui uma tabela do BigQuery de um dataset. A operação exclui todos os dados da tabela permanentemente e não pode ser desfeita.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
table_id	string	Sim	ID da tabela a excluir.
dataset_id	string	Sim	ID do dataset da tabela a excluir.
project_id	string	Sim	ID do projeto da tabela a excluir.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter modelo de ML do BigQuery

GOOGLEBIGQUERY_GET_BIGQUERY_MODEL

Recupera um recurso de modelo de machine learning específico do BigQuery pelo ID do modelo. Use para obter informações detalhadas sobre um modelo treinado, incluindo configuração, execuções de treinamento, hiperparâmetros e métricas de avaliação.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
model_id	string	Sim	ID do modelo solicitado.
dataset_id	string	Sim	ID do dataset do modelo solicitado.
project_id	string	Sim	ID do projeto do modelo solicitado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter política IAM de conexão do BigQuery

GOOGLEBIGQUERY_GET_CONNECTION_IAM_POLICY

Obtém a política de controle de acesso IAM para um recurso de conexão do BigQuery. Retorna uma política vazia se o recurso existir mas não tiver política definida. Use para verificar quem tem acesso a uma conexão específica antes de modificar permissões.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
options	object	Não	Configurações opcionais para a requisição GetIamPolicy. Especifique requestedPolicyVersion se precisar de um formato de versão de política específico.
resource	string	Sim	Recurso para o qual a política está sendo solicitada. Formato: projects/{project}/locations/{location}/connections/{connection}.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter metadados de dataset do BigQuery

GOOGLEBIGQUERY_GET_DATASET

Recupera metadados de dataset do BigQuery incluindo localização via API datasets.get. Use antes de criar jobs/consultas quando o fluxo estiver falhando com erros de localização, para confirmar a região do dataset e corrigir a localização do job.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
dataset_id	string	Sim	ID do dataset solicitado.
project_id	string	Sim	ID do projeto do dataset solicitado.
dataset_view	string ("DATASET_VIEW_UNSPECIFIED" | "METADATA" | "ACL" | "FULL")	Não	View especificando quais informações do dataset retornar. Padrão: FULL.
access_policy_version	integer	Não	Versão do schema de política de acesso a buscar. Valores válidos: 0, 1, 3. Use a versão 3 para bindings condicionais.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter job do BigQuery

GOOGLEBIGQUERY_GET_JOB

Recupera informações sobre um job específico do BigQuery. Retorna configuração, status e estatísticas do job. Use para verificar o status do job após executar consultas ou obter detalhes sobre a execução.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
job_id	string	Sim	ID do job solicitado.
location	string	Não	Localização geográfica do job. Obrigatório quando o job não está na região multi-regional us ou eu, ou está em uma região única (ex.: us-central1).
project_id	string	Sim	ID do projeto do job solicitado.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter resultados de consulta do BigQuery

GOOGLEBIGQUERY_GET_QUERY_RESULTS

Obtém os resultados de um job de consulta do BigQuery via RPC. Use para recuperar resultados após executar uma consulta, verificar status de conclusão do job e buscar resultados paginados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alt	string ("json" | "media" | "proto")	Não	Formato de dados para a resposta.
key	string	Não	Chave de API do projeto.
jobId	string	Sim	ID do job de consulta.
xgafv	string ("1" | "2")	Não	Formato de erro V1.
fields	string	Não	Seletor de campos para resposta parcial.
callback	string	Não	Parâmetro de callback JSONP.
location	string	Não	Localização geográfica do job.
pageToken	string	Não	Token de paginação retornado pela chamada anterior.
projectId	string	Sim	ID do projeto do job de consulta.
quotaUser	string	Não	String para fins de cota. Máximo 40 caracteres.
timeoutMs	integer	Não	Tempo máximo de espera em milissegundos. Padrão: 10000 (10 segundos).
maxResults	integer	Não	Número máximo de resultados a ler.
startIndex	string	Não	Índice de início com base zero.
uploadType	string	Não	Protocolo de upload legado.
oauth_token	string	Não	Token OAuth 2.0 para o usuário atual.
prettyPrint	boolean	Não	Retorna resposta formatada.
access_token	string	Não	Token de acesso OAuth.
upload_protocol	string	Não	Protocolo de upload para mídia.
formatOptions.useInt64Timestamp	boolean	Não	Se verdadeiro, retorna timestamps como inteiro int64 em microssegundos. Padrão: false.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter rotina do BigQuery

GOOGLEBIGQUERY_GET_ROUTINE

Recupera uma rotina do BigQuery (função definida pelo usuário ou stored procedure) pelo seu ID. Use para inspecionar definições de rotinas, argumentos, tipos de retorno e metadados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
read_mask	string	Não	Se definido, apenas os campos da rotina especificados na máscara são retornados.
dataset_id	string	Sim	ID do dataset da rotina solicitada.
project_id	string	Sim	ID do projeto da rotina solicitada.
routine_id	string	Sim	ID da rotina solicitada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter política IAM de rotina do BigQuery

GOOGLEBIGQUERY_GET_ROUTINE_IAM_POLICY

Recupera a política de controle de acesso IAM para um recurso de rotina do BigQuery. Retorna uma política vazia se a rotina existir mas não tiver política definida. Use para verificar permissões de acesso atuais antes de modificá-las.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
options	object	Não	Configurações opcionais para a requisição GetIamPolicy.
dataset_id	string	Sim	ID do dataset que contém a rotina.
project_id	string	Sim	ID do projeto que contém a rotina.
routine_id	string	Sim	ID da rotina para obter a política IAM.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter conta de serviço do BigQuery

GOOGLEBIGQUERY_GET_SERVICE_ACCOUNT

Obtém a conta de serviço de um projeto usada para interações com o Google Cloud KMS. Use quando precisar recuperar o e-mail da conta de serviço do BigQuery para configurar criptografia KMS ou permissões de acesso a chaves.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alt	string ("json" | "media" | "proto")	Não	Formato de dados para a resposta.
key	string	Não	Chave de API do projeto.
xgafv	string ("1" | "2")	Não	Formato de erro V1.
fields	string	Não	Seletor de campos para resposta parcial.
callback	string	Não	Parâmetro de callback JSONP.
project_id	string	Sim	ID do projeto.
quota_user	string	Não	String para fins de cota. Máximo 40 caracteres.
uploadType	string	Não	Protocolo de upload legado.
oauth_token	string	Não	Token OAuth 2.0 para o usuário atual.
prettyPrint	boolean	Não	Retorna resposta formatada.
access_token	string	Não	Token de acesso OAuth.
upload_protocol	string	Não	Protocolo de upload para mídia.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter política IAM de tabela do BigQuery

GOOGLEBIGQUERY_GET_TABLE_IAM_POLICY

Recupera a política de controle de acesso IAM para um recurso de tabela do BigQuery. Retorna uma política vazia se o recurso existir mas não tiver política definida. Use para verificar permissões de acesso atuais antes de modificá-las.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
resource	string	Sim	Recurso para o qual a política está sendo solicitada. Formato: projects/{projectId}/datasets/{datasetId}/tables/{tableId}.
requested_policy_version	integer	Não	Versão máxima de política para formatar a resposta. Valores válidos: 0, 1 e 3. Padrão: 1.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter schema de tabela do BigQuery

GOOGLEBIGQUERY_GET_TABLE_SCHEMA

Busca o schema e metadados de uma tabela do BigQuery sem consultar dados de linhas. Use antes de gerar consultas SQL para evitar erros de nome de coluna e confirmar tipos de campos e modos nullable. Especialmente útil quando o acesso ao INFORMATION_SCHEMA é restrito.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
table_id	string	Sim	ID da tabela para recuperar schema e metadados.
dataset_id	string	Sim	ID do dataset que contém a tabela.
project_id	string	Sim	ID do projeto que contém o dataset.
selected_fields	string	Não	Lista de campos separados por vírgula a retornar (ex.: schema,numRows,type). Se não especificado, retorna todos os campos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir dados em tabela do BigQuery

GOOGLEBIGQUERY_INSERT_ALL

Transmite dados para o BigQuery um registro por vez sem executar um job de carga. Use quando precisar de disponibilidade imediata de dados ou inserir pequenos lotes. Suporta deduplicação em nível de linha via insertId e tratamento de erros via skipInvalidRows.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
rows	array	Sim	Array de linhas a inserir. Cada linha contém os dados como objeto JSON. Pelo menos uma linha deve ser fornecida.
traceId	string	Não	ID de rastreamento único para depuração. Máximo 36 caracteres ASCII.
table_id	string	Sim	ID da tabela de destino.
dataset_id	string	Sim	ID do dataset da tabela de destino.
project_id	string	Sim	ID do projeto da tabela de destino.
templateSuffix	string	Não	Se especificado, trata a tabela de destino como template base e insere linhas em uma tabela de instância chamada {destination}{templateSuffix}.
skipInvalidRows	boolean	Não	Se verdadeiro, insere todas as linhas válidas mesmo que algumas sejam inválidas. Se falso (padrão), toda a requisição falha se qualquer linha for inválida.
ignoreUnknownValues	boolean	Não	Se verdadeiro, aceita linhas com valores que não correspondem ao schema e ignora os valores desconhecidos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir job no BigQuery

GOOGLEBIGQUERY_INSERT_JOB

Inicia um novo job assíncrono do BigQuery (consulta, carga, extração ou cópia). Use para executar uma consulta como job, carregar dados do Cloud Storage, extrair dados de tabela para GCS ou copiar tabelas. Para validação sem execução, defina dryRun como verdadeiro na configuração.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
project_id	string	Sim	ID do projeto que será cobrado pelo job.
jobReference	object	Não	Referência do job.
configuration	object	Sim	Configuração do job. Especifique exatamente um de: query, load, extract ou copy no objeto de configuração.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Inserir job no BigQuery com upload

GOOGLEBIGQUERY_INSERT_JOB_WITH_UPLOAD

Inicia um novo job de carga no BigQuery com upload de arquivo. Faz upload de um arquivo (CSV, JSON, etc.) e carrega no BigQuery em uma única operação. Use quando precisar enviar dados de um arquivo local diretamente para o BigQuery em vez de carregar do Cloud Storage.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
project_id	string	Sim	ID do projeto que será cobrado pelo job.
jobReference	object	Não	Referência opcional para o job de upload.
configuration	object	Sim	Configuração do job contendo configurações de carga (schema, tabela de destino, formato, etc.).
file_to_upload	object	Sim	Arquivo a ser carregado no BigQuery. O conteúdo será carregado conforme o sourceFormat especificado na configuração.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar listagens do Analytics Hub

GOOGLEBIGQUERY_LIST_ANALYTICS_HUB_LISTINGS

Lista todas as listagens em um data exchange do Analytics Hub. Use quando precisar descobrir listagens de dados disponíveis em um data exchange específico que podem ser assinadas para compartilhamento de dados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alt	string ("json" | "media" | "proto")	Não	Formato de dados para a resposta.
key	string	Não	Chave de API do projeto.
xgafv	string ("1" | "2")	Não	Formato de erro V1.
fields	string	Não	Seletor de campos para resposta parcial.
parent	string	Sim	Caminho do recurso pai da listagem. Formato: projects/{project_id}/locations/{location}/dataExchanges/{data_exchange_id}.
callback	string	Não	Parâmetro de callback JSONP.
pageSize	integer	Não	Número máximo de resultados por página.
pageToken	string	Não	Token de paginação retornado pela chamada anterior.
quota_user	string	Não	String para fins de cota. Máximo 40 caracteres.
uploadType	string	Não	Protocolo de upload legado.
oauth_token	string	Não	Token OAuth 2.0 para o usuário atual.
prettyPrint	boolean	Não	Retorna resposta formatada.
access_token	string	Não	Token de acesso OAuth.
upload_protocol	string	Não	Protocolo de upload para mídia.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar conexões do BigQuery

GOOGLEBIGQUERY_LIST_BIG_QUERY_CONNECTIONS

Lista conexões do BigQuery em um projeto e localização especificados. Use quando precisar descobrir conexões disponíveis com fontes de dados externas (Cloud SQL, AWS, Azure, Spark, etc.) configuradas para o BigQuery.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso pai. Formato: projects/{project_id}/locations/{location_id}.
pageSize	integer	Não	Número máximo de conexões por página.
pageToken	string	Não	Token de paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar compromissos de capacidade do BigQuery

GOOGLEBIGQUERY_LIST_CAPACITY_COMMITMENTS

Lista todos os compromissos de capacidade do projeto admin. Use quando precisar visualizar slots de processamento comprados e seus detalhes de comprometimento (plano, estado, duração).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso pai da reserva. Ex.: projects/myprojeto/locations/US.
page_size	integer	Não	Número máximo de itens a retornar.
page_token	string	Não	Token da próxima página, retornado por uma chamada List anterior.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar listagens de data exchange

GOOGLEBIGQUERY_LIST_DATAEXCHANGES_LISTINGS

Lista todas as listagens em um data exchange do Analytics Hub usando a API v1beta1. Use quando precisar descobrir listagens de dados disponíveis em um data exchange específico para compartilhamento de dados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alt	string ("json" | "media" | "proto")	Não	Formato de dados para a resposta.
key	string	Não	Chave de API do projeto.
xgafv	string ("1" | "2")	Não	Formato de erro V1.
fields	string	Não	Seletor de campos para resposta parcial.
parent	string	Sim	Caminho do recurso pai da listagem. Formato: projects/{project_id}/locations/{location}/dataExchanges/{data_exchange_id}.
callback	string	Não	Parâmetro de callback JSONP.
pageSize	integer	Não	Número máximo de resultados por página.
pageToken	string	Não	Token de paginação retornado pela chamada anterior.
quota_user	string	Não	String para fins de cota. Máximo 40 caracteres.
uploadType	string	Não	Protocolo de upload legado.
oauth_token	string	Não	Token OAuth 2.0 para o usuário atual.
prettyPrint	boolean	Não	Retorna resposta formatada.
access_token	string	Não	Token de acesso OAuth.
upload_protocol	string	Não	Protocolo de upload para mídia.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar datasets do BigQuery

GOOGLEBIGQUERY_LIST_DATASETS

Lista datasets em um projeto específico do BigQuery, incluindo localizações dos datasets. Use após identificar um projeto acessível para descobrir datasets disponíveis e suas localizações antes de realizar consultas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
all	boolean	Não	Se verdadeiro, lista todos os datasets, incluindo os ocultos. Padrão: false.
filter	string	Não	Filtra datasets por rótulo no formato labels.key:value.
page_token	string	Não	Token de paginação.
project_id	string	Sim	ID do projeto que contém os datasets.
max_results	integer	Não	Número máximo de datasets a retornar por página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar jobs do BigQuery

GOOGLEBIGQUERY_LIST_JOBS

Lista todos os jobs que você iniciou em um projeto do BigQuery. Informações de jobs ficam disponíveis por seis meses após a criação. Jobs são ordenados em ordem cronológica inversa. Use para monitorar execução de consultas, rastrear status de jobs e recuperar histórico.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
all_users	boolean	Não	Se verdadeiro, exibe jobs de todos os usuários do projeto. Padrão: false. Requer papel de proprietário do projeto.
page_token	string	Não	Token de paginação.
project_id	string	Sim	ID do projeto dos jobs a listar.
projection	string ("full" | "minimal")	Não	Restringe as informações retornadas a um conjunto selecionado de campos.
max_results	integer	Não	Número máximo de resultados por página.
state_filter	array	Não	Filtro por estado do job. Pode incluir done, pending, running.
parent_job_id	string	Não	Se definido, mostra apenas jobs filhos do pai especificado.
max_creation_time	string	Não	Valor máximo para o tempo de criação do job, em milissegundos desde a época POSIX.
min_creation_time	string	Não	Valor mínimo para o tempo de criação do job, em milissegundos desde a época POSIX.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar localizações do BigQuery Data Transfer

GOOGLEBIGQUERY_LIST_LOCATIONS

Lista informações sobre localizações suportadas para o BigQuery Data Transfer Service. Use quando precisar descobrir regiões disponíveis onde operações de transferência de dados do BigQuery podem ser realizadas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Recurso que possui a coleção de localizações. Formato: projects/{project_id}.
filter	string	Não	Filtro para restringir os resultados.
pageSize	integer	Não	Número máximo de resultados a retornar.
pageToken	string	Não	Token de paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar conexões em localização

GOOGLEBIGQUERY_LIST_LOCATIONS_CONNECTIONS

Lista conexões do BigQuery em um projeto e localização usando a API v1beta1. Use quando precisar descobrir conexões disponíveis com fontes de dados externas configuradas para o BigQuery em uma localização específica.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso pai. Formato: projects/{project_id}/locations/{location_id}.
pageToken	string	Não	Token de paginação.
maxResults	integer	Sim	Número máximo de conexões por página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar políticas de dados de localização do BigQuery

GOOGLEBIGQUERY_LIST_LOCATIONS_DATAPOLICIES

Lista todas as políticas de dados em um projeto pai e localização especificados usando a API v2beta1. Use quando precisar descobrir políticas de mascaramento de dados e políticas de segurança em nível de coluna configuradas para datasets do BigQuery.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
filter	string	Não	Filtra as políticas de dados por tags de política associadas.
parent	string	Sim	Nome do recurso do projeto para listar políticas de dados. Formato: projects/{project}/locations/{location}.
pageSize	integer	Não	Número máximo de políticas de dados a retornar. Deve ser entre 1 e 1000. Padrão: 50.
pageToken	string	Não	Token de paginação retornado por uma solicitação list anterior.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar modelos de ML do BigQuery

GOOGLEBIGQUERY_LIST_MODELS

Lista todos os modelos de machine learning do BigQuery em um dataset especificado. Requer o papel READER no dataset. Use para descobrir modelos disponíveis antes de obter informações detalhadas via método models.get.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
dataset_id	string	Sim	ID do dataset dos modelos a listar.
page_token	string	Não	Token de paginação retornado por uma chamada anterior.
project_id	string	Sim	ID do projeto dos modelos a listar.
max_results	integer	Não	Número máximo de modelos por página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar data exchanges da organização

GOOGLEBIGQUERY_LIST_ORGANIZATION_DATA_EXCHANGES

Lista todos os data exchanges de projetos em uma organização e localização especificados usando a API do Analytics Hub. Use quando precisar descobrir data exchanges disponíveis em uma organização que podem ser usados para compartilhamento de dados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alt	string ("json" | "media" | "proto")	Não	Formato de dados para a resposta.
key	string	Não	Chave de API do projeto.
xgafv	string ("1" | "2")	Não	Formato de erro V1.
fields	string	Não	Seletor de campos para resposta parcial.
callback	string	Não	Parâmetro de callback JSONP.
pageSize	integer	Não	Número máximo de resultados por página.
pageToken	string	Não	Token de paginação.
quota_user	string	Não	String para fins de cota. Máximo 40 caracteres.
uploadType	string	Não	Protocolo de upload legado.
oauth_token	string	Não	Token OAuth 2.0 para o usuário atual.
prettyPrint	boolean	Não	Retorna resposta formatada.
access_token	string	Não	Token de acesso OAuth.
organization	string	Sim	Caminho do recurso da organização. Formato: organizations/{organization_id}/locations/{location}.
upload_protocol	string	Não	Protocolo de upload para mídia.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar projetos do BigQuery

GOOGLEBIGQUERY_LIST_PROJECTS

Lista projetos do BigQuery aos quais o usuário teve algum papel de projeto concedido. Retorna projetos com pelo menos acesso READ.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page_token	string	Não	Token de paginação. Se não presente, não há mais páginas disponíveis.
max_results	integer	Não	Número máximo de projetos por página. Padrão: até 50.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar templates de consulta do Analytics Hub

GOOGLEBIGQUERY_LIST_QUERY_TEMPLATES

Lista todos os templates de consulta em um data exchange do Analytics Hub. Use quando precisar descobrir templates de consulta disponíveis que definem consultas predefinidas e aprovadas para casos de uso de data clean room.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Caminho do recurso pai dos QueryTemplates. Formato: projects/{project}/locations/{location}/dataExchanges/{dataExchange}.
pageSize	integer	Não	Número máximo de resultados por página.
pageToken	string	Não	Token de paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar atribuições de reserva do BigQuery

GOOGLEBIGQUERY_LIST_RESERVATION_ASSIGNMENTS

Lista atribuições de reserva do BigQuery. Somente atribuições criadas explicitamente serão retornadas (sem expansão ou fusão). Use o curinga - no caminho pai para listar atribuições em todas as reservas de uma localização.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso pai da reserva. Formato: projects/{project_id}/locations/{location}/reservations/{reservation_id} ou projects/{project_id}/locations/{location}/reservations/- (curinga).
page_size	integer	Não	Número máximo de atribuições por página.
page_token	string	Não	Token de paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar grupos de reserva do BigQuery

GOOGLEBIGQUERY_LIST_RESERVATION_GROUPS

Lista todos os grupos de reserva do BigQuery para um projeto em uma localização especificada. Use quando precisar descobrir grupos de reservas disponíveis que servem como contêineres para reservas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
parent	string	Sim	Nome do recurso pai contendo projeto e localização. Formato: projects/{projectId}/locations/{location}.
page_size	integer	Não	Número máximo de itens por página.
page_token	string	Não	Token de paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar reservas do BigQuery

GOOGLEBIGQUERY_LIST_RESERVATIONS

Lista todas as reservas do BigQuery para um projeto em uma localização especificada. Use quando precisar descobrir reservas disponíveis ou ver detalhes incluindo capacidade de slots e configuração de auto scaling.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alt	string ("json" | "media" | "proto")	Não	Formato de dados para a resposta.
key	string	Não	Chave de API do projeto.
xgafv	string ("1" | "2")	Não	Formato de erro V1.
fields	string	Não	Seletor de campos para resposta parcial.
parent	string	Sim	Nome do recurso pai contendo projeto e localização. Ex.: projects/myprojeto/locations/US.
callback	string	Não	Callback JSONP.
page_size	integer	Não	Número máximo de itens por página.
page_token	string	Não	Token de paginação.
quota_user	string	Não	String para fins de cota. Máximo 40 caracteres.
oauth_token	string	Não	Token OAuth 2.0 para o usuário atual.
upload_type	string	Não	Protocolo de upload legado.
access_token	string	Não	Token de acesso OAuth.
pretty_print	boolean	Não	Retorna resposta formatada.
upload_protocol	string	Não	Protocolo de upload para mídia.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar rotinas do BigQuery

GOOGLEBIGQUERY_LIST_ROUTINES

Lista todas as rotinas (funções definidas pelo usuário e stored procedures) em um dataset do BigQuery. Requer o papel READER no dataset. Use para descobrir rotinas disponíveis antes de executá-las ou inspecioná-las.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
filter	string	Não	Filtra rotinas por tipo. Formato suportado: routineType:{RoutineType}. Ex.: routineType:SCALAR_FUNCTION.
readMask	string	Não	Se definido, apenas os campos da rotina na máscara de campo são retornados.
pageToken	string	Não	Token de paginação.
dataset_id	string	Sim	ID do dataset das rotinas a listar.
maxResults	integer	Não	Número máximo de resultados por página.
project_id	string	Sim	ID do projeto das rotinas a listar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar políticas de acesso a linhas do BigQuery

GOOGLEBIGQUERY_LIST_ROW_ACCESS_POLICIES

Lista todas as políticas de acesso a linhas em uma tabela especificada do BigQuery. Use quando precisar descobrir quais políticas de segurança em nível de linha estão aplicadas a uma tabela e seus predicados de filtro.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
table_id	string	Sim	ID da tabela para listar políticas de acesso a linhas.
page_size	integer	Não	Número máximo de resultados por página.
dataset_id	string	Sim	ID do dataset das políticas de acesso a linhas a listar.
page_token	string	Não	Token de paginação.
project_id	string	Sim	ID do projeto das políticas de acesso a linhas a listar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar dados de tabela do BigQuery

GOOGLEBIGQUERY_LIST_TABLE_DATA

Lista o conteúdo de uma tabela do BigQuery em linhas via API REST. Use para recuperar dados reais de uma tabela sem escrever consultas SQL. Retorna resultados paginados com dados de linhas no formato nativo do BigQuery.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
table_id	string	Sim	ID da tabela a listar.
dataset_id	string	Sim	ID do dataset da tabela a listar.
page_token	string	Não	Token de paginação.
project_id	string	Sim	ID do projeto da tabela a listar.
max_results	integer	Não	Número máximo de linhas por página.
start_index	string	Não	Índice de início da linha na tabela.
selected_fields	string	Não	Subconjunto de campos a retornar. Exemplo: selected_fields = 'a,e.d.f'.
format_options_use_int64_timestamp	boolean	Não	Se verdadeiro, retorna timestamps como inteiro int64 em microssegundos. Padrão: false.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar tabelas do BigQuery

GOOGLEBIGQUERY_LIST_TABLES

Lista tabelas em um dataset do BigQuery via API REST. Use no início da exploração para descobrir tabelas acessíveis sem depender do INFORMATION_SCHEMA, especialmente quando consultas SQL de metadados são bloqueadas ou restritas.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
dataset_id	string	Sim	ID do dataset para listar tabelas.
page_token	string	Não	Token de paginação.
project_id	string	Sim	ID do projeto que contém o dataset.
max_results	integer	Não	Número máximo de tabelas por página.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar parcialmente dataset do BigQuery

GOOGLEBIGQUERY_PATCH_DATASET

Atualiza um dataset existente do BigQuery usando semântica PATCH do RFC5789. Apenas substitui os campos fornecidos na requisição, deixando outros campos inalterados. Use quando precisar modificar propriedades do dataset como descrição, rótulos, configurações de expiração ou controles de acesso.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
access	array	Não	Array de objetos que definem o acesso ao dataset para uma ou mais entidades.
labels	object	Não	Rótulos associados ao dataset.
location	string	Não	Localização geográfica onde o dataset deve residir.
dataset_id	string	Sim	ID do dataset sendo atualizado.
project_id	string	Sim	ID do projeto do dataset sendo atualizado.
description	string	Não	Descrição amigável do dataset.
friendlyName	string	Não	Nome descritivo do dataset.
datasetReference	object	Não	Referência do dataset para o patch.
defaultCollation	string	Não	Define a collation padrão para tabelas futuras. Valores suportados: und:ci (case insensitive) ou '' (case sensitive).
isCaseInsensitive	boolean	Não	Se verdadeiro, o dataset e seus nomes de tabela são case-insensitive.
maxTimeTravelHours	string	Não	Define a janela de time travel em horas. O valor pode ser de 48 a 168 horas (2 a 7 dias).
defaultRoundingMode	string ("ROUNDING_MODE_UNSPECIFIED" | "ROUND_HALF_AWAY_FROM_ZERO" | "ROUND_HALF_EVEN")	Não	Define o modo de arredondamento padrão para novas tabelas.
linkedDatasetSource	object	Não	Configuração da fonte de dataset vinculado.
storageBillingModel	string ("STORAGE_BILLING_MODEL_UNSPECIFIED" | "LOGICAL" | "PHYSICAL")	Não	Atualiza o modelo de cobrança de armazenamento do dataset.
defaultTableExpirationMs	string	Não	Tempo de vida padrão de todas as tabelas em milissegundos. Mínimo: 3600000 (uma hora). Defina como 0 para limpar.
externalDatasetReference	object	Não	Configuração de referência de dataset externo.
defaultPartitionExpirationMs	string	Não	Expiração padrão de partições em milissegundos.
defaultEncryptionConfiguration	object	Não	Configuração de criptografia do dataset.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar parcialmente modelo de ML do BigQuery

GOOGLEBIGQUERY_PATCH_MODEL

Atualiza campos específicos em um modelo de machine learning existente do BigQuery usando semântica PATCH. Use quando precisar modificar metadados do modelo como descrição, nome amigável, rótulos ou tempo de expiração sem substituir todo o recurso.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
labels	object	Não	Rótulos associados ao modelo. Chaves e valores máximo 63 caracteres, apenas minúsculos.
model_id	string	Sim	ID do modelo a atualizar.
dataset_id	string	Sim	ID do dataset do modelo a atualizar.
project_id	string	Sim	ID do projeto do modelo a atualizar.
description	string	Não	Descrição amigável do modelo.
friendlyName	string	Não	Nome descritivo do modelo.
expirationTime	string	Não	Tempo de expiração do modelo em milissegundos desde a época.
encryptionConfiguration	object	Não	Configuração de criptografia do modelo.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar parcialmente tabela do BigQuery

GOOGLEBIGQUERY_PATCH_TABLE

Atualiza campos específicos em uma tabela existente do BigQuery usando semântica PATCH do RFC5789. Apenas os campos fornecidos na requisição são atualizados. Use quando precisar modificar metadados da tabela como descrição, nome amigável, rótulos ou tempo de expiração.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
labels	object	Não	Rótulos para organizar a tabela.
table_id	string	Sim	ID da tabela a atualizar.
dataset_id	string	Sim	ID do dataset que contém a tabela a atualizar.
project_id	string	Sim	ID do projeto que contém a tabela a atualizar.
description	string	Não	Descrição amigável da tabela.
friendlyName	string	Não	Nome descritivo da tabela exibido na UI do BigQuery.
expirationTime	string	Não	Tempo de expiração da tabela em milissegundos desde a época.
autodetect_schema	boolean	Não	Se verdadeiro, detecta automaticamente o schema; caso contrário, mantém o schema original.
requirePartitionFilter	boolean	Não	Se verdadeiro, consultas nesta tabela exigem filtro de partição.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Consultar no BigQuery

GOOGLEBIGQUERY_QUERY

Executa uma consulta SQL no BigQuery via API REST. Use a sintaxe SQL padrão do BigQuery, por exemplo SELECT * FROM \projeto.dataset.tabela` WHERE coluna = ‘valor’. Resultados estão em data.rows; um array rows` vazio significa que nenhum dado correspondente foi encontrado. Verifique os nomes exatos de project_id, dataset, tabela e coluna antes de executar.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
query	string	Sim	Consulta a executar no BigQuery. Use sintaxe SQL padrão.
location	string	Não	Localização geográfica onde a consulta deve ser executada (ex.: US, EU, us-central1). Padrão: região multi-regional US. Deve corresponder à localização real do dataset.
project_id	string	Sim	ID do projeto contra o qual a consulta será executada.
timeout_ms	integer	Não	Timeout da consulta em milissegundos. Padrão: 10000 (10 segundos).
max_results	integer	Não	Número máximo de linhas a retornar. Se não especificado, retorna todas.
use_legacy_sql	boolean	Não	Se verdadeiro, usa sintaxe SQL legada. Padrão: false (SQL padrão).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Pesquisar todas as atribuições de reserva do BigQuery

GOOGLEBIGQUERY_SEARCH_ALL_ASSIGNMENTS

Pesquisa todas as atribuições de reserva do BigQuery para um recurso especificado em uma região específica. Use quando precisar encontrar atribuições para um projeto, pasta ou organização. Retorna atribuições criadas no recurso ou em seu ancestral mais próximo, cobrindo todos os JobTypes.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
alt	string ("json" | "media" | "proto")	Não	Formato de dados para a resposta.
key	string	Não	Chave de API do projeto.
query	string	Não	Especifique o nome do recurso como assignee na consulta. Exemplos: assignee=projects/myprojeto, assignee=folders/123, assignee=organizations/456.
xgafv	string ("1" | "2")	Não	Formato de erro V1.
fields	string	Não	Seletor de campos para resposta parcial.
parent	string	Sim	Nome do recurso com localização (o nome do projeto pode ser curinga -). Ex.: projects/-/locations/US.
callback	string	Não	Callback JSONP.
page_size	integer	Não	Número máximo de itens por página.
page_token	string	Não	Token de paginação.
quota_user	string	Não	String para fins de cota. Máximo 40 caracteres.
oauth_token	string	Não	Token OAuth 2.0 para o usuário atual.
upload_type	string	Não	Protocolo de upload legado.
access_token	string	Não	Token de acesso OAuth.
pretty_print	boolean	Não	Retorna resposta formatada.
upload_protocol	string	Não	Protocolo de upload para mídia.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Definir política IAM de rotina do BigQuery

GOOGLEBIGQUERY_SET_ROUTINE_IAM_POLICY

Define a política de controle de acesso IAM para um recurso de rotina do BigQuery. Use para conceder ou modificar permissões de acesso para usuários, contas de serviço ou grupos. Inclua o etag de getIamPolicy para evitar modificações concorrentes.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
policy	object	Sim	Política IAM a definir, contendo bindings (array de mapeamentos papel-membros), etag opcional e versão.
dataset_id	string	Sim	ID do dataset da rotina.
project_id	string	Sim	ID do projeto da rotina.
routine_id	string	Sim	ID da rotina.
update_mask	string	Não	Máscara de campo para atualizações seletivas da política. Especifique campos a atualizar (ex.: bindings,etag).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Testar permissões IAM de rotina do BigQuery

GOOGLEBIGQUERY_TEST_ROUTINE_IAM_PERMISSIONS

Testa quais permissões IAM o chamador tem sobre uma rotina do BigQuery. Retorna o subconjunto de permissões solicitadas que o chamador realmente possui. Use para verificar o acesso antes de realizar operações.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
dataset_id	string	Sim	ID do dataset da rotina para testar permissões IAM.
project_id	string	Sim	ID do projeto da rotina para testar permissões IAM.
routine_id	string	Sim	ID da rotina para testar permissões IAM.
permissions	array	Sim	Conjunto de permissões a verificar. Array de strings como bigquery.routines.get, bigquery.routines.update, bigquery.routines.delete.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Restaurar dataset excluído do BigQuery

GOOGLEBIGQUERY_UNDELETE_DATASET

Restaura um dataset do BigQuery dentro da janela de time travel. Se um tempo de exclusão for especificado, a versão do dataset excluída naquele momento é restaurada; caso contrário, a versão mais recentemente excluída é restaurada.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
dataset_id	string	Sim	ID do dataset sendo restaurado.
project_id	string	Sim	ID do projeto do dataset a ser restaurado.
deletion_time	string	Não	Horário exato em que o dataset foi excluído (formato RFC3339). Se não especificado, restaura a versão mais recentemente excluída.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar conexão do BigQuery

GOOGLEBIGQUERY_UPDATE_CONNECTION

Atualiza uma conexão especificada do BigQuery usando a BigQuery Connection API. Use quando precisar modificar propriedades de conexão como nome amigável, descrição ou configurações específicas. Por razões de segurança, as credenciais são redefinidas automaticamente se propriedades de conexão forem incluídas na máscara de atualização.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
aws	object	Não	Propriedades de conexão específicas da Amazon Web Services.
name	string	Sim	Nome da conexão a atualizar. Formato: projects/{project_id}/locations/{location_id}/connections/{connection_id}.
azure	object	Não	Propriedades de conexão específicas do Azure.
spark	object	Não	Propriedades de conexão para Apache Spark.
cloudSql	object	Não	Propriedades de conexão específicas do Cloud SQL.
kmsKeyName	string	Não	Chave Cloud KMS para criptografia.
updateMask	string	Sim	Máscara de atualização para os campos de conexão a atualizar. Lista de caminhos de campo separados por vírgula. Por razões de segurança, as credenciais são redefinidas se propriedades de conexão estiverem na máscara.
description	string	Não	Descrição fornecida pelo usuário.
cloudSpanner	object	Não	Propriedades de conexão específicas do Cloud Spanner.
friendlyName	string	Não	Nome de exibição fornecido pelo usuário para a conexão.
cloudResource	object	Não	Propriedades de conexão para delegação de acesso a recursos GCP.
salesforceDataCloud	object	Não	Propriedades de conexão específicas do Salesforce DataCloud.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar dataset do BigQuery

GOOGLEBIGQUERY_UPDATE_DATASET

Atualiza informações em um dataset existente do BigQuery usando o método PUT. O método de atualização substitui todo o recurso dataset, enquanto o método patch substitui apenas os campos fornecidos. Use quando precisar modificar propriedades do dataset como descrição, controles de acesso ou configurações padrão.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
access	array	Não	Array de objetos que definem o acesso ao dataset para uma ou mais entidades.
labels	object	Não	Rótulos para organizar o dataset.
location	string	Sim	Localização geográfica onde o dataset reside. Não pode ser alterada após a criação do dataset. Exemplos: US, EU, us-central1, europe-west1.
dataset_id	string	Sim	ID do dataset sendo atualizado.
project_id	string	Sim	ID do projeto do dataset sendo atualizado.
description	string	Não	Descrição amigável do dataset.
friendlyName	string	Não	Nome descritivo do dataset exibido na UI do BigQuery.
datasetReference	object	Sim	Referência do dataset contendo dataset ID e project ID. Deve corresponder aos parâmetros do caminho.
defaultCollation	string	Não	Define a collation padrão para tabelas futuras. Valores: und:ci (case insensitive) ou '' (case sensitive).
isCaseInsensitive	boolean	Não	Se verdadeiro, o dataset e seus nomes de tabela são case-insensitive.
maxTimeTravelHours	integer	Não	Define a janela de time travel em horas. O valor pode ser de 48 a 168 horas (2 a 7 dias). Padrão: 168 horas.
defaultRoundingMode	string ("ROUNDING_MODE_UNSPECIFIED" | "ROUND_HALF_AWAY_FROM_ZERO" | "ROUND_HALF_EVEN")	Não	Define o modo de arredondamento padrão para novas tabelas.
linkedDatasetSource	object	Não	Dataset de origem vinculado a outro dataset do BigQuery.
storageBillingModel	string ("STORAGE_BILLING_MODEL_UNSPECIFIED" | "LOGICAL" | "PHYSICAL")	Não	Atualiza o modelo de cobrança de armazenamento. LOGICAL usa bytes lógicos, PHYSICAL usa bytes físicos.
defaultTableExpirationMs	integer	Não	Tempo de vida padrão de todas as tabelas em milissegundos. Mínimo: 3600000 (uma hora). Defina como 0 para limpar.
externalDatasetReference	object	Não	Configura o acesso a um dataset definido em um armazenamento de metadados externo.
defaultPartitionExpirationMs	integer	Não	Expiração padrão de partições em milissegundos. Herdada por novas tabelas particionadas por tempo.
defaultEncryptionConfiguration	object	Não	Configuração de criptografia do dataset.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar rotina do BigQuery

GOOGLEBIGQUERY_UPDATE_ROUTINE

Atualiza uma rotina existente do BigQuery (função ou stored procedure). Substitui todo o recurso da rotina com a definição fornecida. Use ao modificar lógica de rotina, argumentos, tipos de retorno ou outra configuração. Certifique-se de fornecer todos os campos obrigatórios pois esta é uma operação de substituição completa.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
language	string	Não	Linguagem da rotina. Opções: SQL, JAVASCRIPT, PYTHON, JAVA, SCALA. Padrão: SQL se remote_function_options estiver ausente.
arguments	array	Não	Lista de argumentos da rotina.
dataset_id	string	Sim	ID do dataset da rotina a atualizar.
project_id	string	Sim	ID do projeto da rotina a atualizar.
returnType	object	Não	Especificação do tipo de dados para argumentos e valores de retorno da rotina.
routine_id	string	Sim	ID da rotina a atualizar.
strictMode	boolean	Não	Para procedimentos, habilita verificações adicionais de erros. Padrão: verdadeiro.
description	string	Não	Descrição da rotina.
routineType	string	Sim	Tipo da rotina. Opções: SCALAR_FUNCTION, PROCEDURE, TABLE_VALUED_FUNCTION, AGGREGATE_FUNCTION.
securityMode	string	Não	Modo de segurança da rotina. Opções: DEFINER, INVOKER.
sparkOptions	object	Não	Opções para rotinas Spark definidas pelo usuário.
definitionBody	string	Sim	Corpo da rotina. Para funções SQL, é a expressão sem parênteses. Para JavaScript, é a string avaliada.
returnTableType	object	Não	Tipo de tabela retornado por funções com valor de tabela.
determinismLevel	string	Não	Nível de determinismo para UDFs JavaScript. Opções: DETERMINISTIC, NOT_DETERMINISTIC.
routineReference	object	Sim	Referência da rotina no corpo da requisição. Deve corresponder aos parâmetros do caminho.
importedLibraries	array	Não	Para rotinas JavaScript, caminhos das bibliotecas JavaScript importadas.
dataGovernanceType	string	Não	Se definido como DATA_MASKING, a função é validada como função de mascaramento.
remoteFunctionOptions	object	Não	Opções para funções remotas definidas pelo usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Atualizar tabela do BigQuery

GOOGLEBIGQUERY_UPDATE_TABLE

Atualiza uma tabela existente do BigQuery. O método de atualização substitui todo o recurso Table. Use quando precisar modificar propriedades da tabela como schema, descrição, rótulos, configuração de particionamento ou clustering.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
labels	object	Não	Rótulos para organizar e agrupar tabelas.
schema	object	Não	Schema da tabela.
table_id	string	Sim	ID da tabela a atualizar.
clustering	object	Não	Configura o clustering da tabela.
dataset_id	string	Sim	ID do dataset da tabela a atualizar.
project_id	string	Sim	ID do projeto da tabela a atualizar.
description	string	Não	Descrição amigável da tabela.
friendlyName	string	Não	Nome descritivo da tabela.
expirationTime	string	Não	Tempo de expiração da tabela em milissegundos desde a época.
tableReference	object	Sim	Referência identificando a tabela. Deve corresponder aos parâmetros do caminho.
defaultCollation	string	Não	Define a collation padrão para novos campos STRING na tabela.
timePartitioning	object	Não	Configura o particionamento por tempo para a tabela.
autodetect_schema	boolean	Não	Se verdadeiro, detecta automaticamente o schema; caso contrário, mantém o original.
rangePartitioning	object	Não	Configura o particionamento por intervalo para a tabela.
requirePartitionFilter	boolean	Não	Se verdadeiro, consultas nesta tabela exigem filtro de partição.
encryptionConfiguration	object	Não	Configuração de criptografia da tabela.
externalDataConfiguration	object	Não	Configuração para fontes de dados externas.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.