Skip to main content
Google BigQuery logo
  • Category: databases
  • Auth: OAUTH2, GOOGLE_SERVICE_ACCOUNT
  • Composio-managed OAuth available? Yes
  • Tools: 63
  • Triggers: 0
  • Slug: GOOGLEBIGQUERY
  • Version: 20261101_00

Frequently Asked Questions

Google can show “This app is blocked” during the BigQuery OAuth flow when the OAuth app requests Google scopes that are not approved or verified for that app.For managed Google BigQuery OAuth, this can happen because Composio’s managed OAuth app does not yet have the required BigQuery scope approved. That scope is still under verification, which is why Google can block the connection.To unblock production usage, use your own verified Google OAuth app in a custom auth config with the BigQuery scopes your workflow needs, then reconnect the account. If your setup can use service-account auth for BigQuery, that can also avoid the user-consent OAuth screen.

Tools

Slug: GOOGLEBIGQUERY_CANCEL_JOBTool to cancel a running BigQuery job. This call returns immediately, and you need to poll for the job status to see if the cancel completed successfully. Note that cancelled jobs may still incur costs.

Input Parameters

string
required
Required. Job ID of the job to cancel.
string
The geographic location of the job. You must specify the location to run the job for the following scenarios: If the location to run a job is not in the us or the eu multi-regional location. If the job’s location is in a single region (for example, us-central1).
string
required
Required. Project ID of the job to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_CAPACITY_COMMITMENTTool to create a new capacity commitment resource in BigQuery Reservation. Use when you need to purchase compute capacity (slots) with a committed period of usage for BigQuery jobs. Supports various commitment plans (FLEX, MONTHLY, ANNUAL, THREE_YEAR) and editions (STANDARD, ENTERPRISE, ENTERPRISE_PLUS).

Input Parameters

string ("COMMITMENT_PLAN_UNSPECIFIED" | "FLEX" | "FLEX_FLAT_RATE" | "TRIAL" | "MONTHLY" | "MONTHLY_FLAT_RATE" | "ANNUAL" | "ANNUAL_FLAT_RATE" | "THREE_YEAR" | "NONE")
required
Required. Capacity commitment plan. Determines the commitment period and pricing.
string
required
Required. Resource name of the parent reservation. Must be in the format ‘projects/{project}/locations/{location}’ (e.g., ‘projects/myproject/locations/US’).
string ("EDITION_UNSPECIFIED" | "STANDARD" | "ENTERPRISE" | "ENTERPRISE_PLUS")
Edition of the capacity commitment.
string
required
Required. Number of slots in this commitment. Must be a positive integer represented as a string.
string ("COMMITMENT_PLAN_UNSPECIFIED" | "FLEX" | "FLEX_FLAT_RATE" | "TRIAL" | "MONTHLY" | "MONTHLY_FLAT_RATE" | "ANNUAL" | "ANNUAL_FLAT_RATE" | "THREE_YEAR" | "NONE")
Capacity commitment plan types.
string
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. Must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters.
boolean
Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization’s secondary region for disaster recovery. NOTE: this is a preview feature.
boolean
If true, fail the request if another project in the organization has a capacity commitment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_CONNECTIONTool to create a new BigQuery connection to external data sources using the BigQuery Connection API. Use when setting up connections to AWS, Azure, Cloud Spanner, Cloud SQL, Salesforce DataCloud, or Apache Spark.

Input Parameters

object
Connection properties specific to Amazon Web Services (AWS).
object
Container for connection properties specific to Azure.
object
Container for connection properties to execute stored procedures for Apache Spark.
string
required
Required. Parent resource name in the format ‘projects/{project_id}/locations/{location_id}’. Example: ‘projects/my-project/locations/us-central1’.
object
Connection properties specific to Cloud SQL.
string
Optional. The Cloud KMS key that is used for encryption. Example: ‘projects/{kms_project_id}/locations/{region}/keyRings/{key_region}/cryptoKeys/{key}’.
string
User provided description for the connection.
object
Connection properties specific to Cloud Spanner.
string
Optional. Connection id that should be assigned to the created connection. If not specified, a random connection id will be generated.
string
User provided display name for the connection.
object
Container for connection properties for delegation of access to GCP resources.
object
Connection properties specific to Salesforce DataCloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_DATA_EXCHANGETool to create a new Analytics Hub data exchange for sharing BigQuery datasets. Use when you need to set up a container for data sharing with descriptive information and listings.

Input Parameters

string
Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB. Expected image dimensions are 512x512 pixels.
string
required
Required. The parent resource path of the data exchange in the format ‘projects/{project}/locations/{location}’. Example: ‘projects/my-project/locations/US’.
string
Optional. Description of the data exchange. Must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Max length: 2000 bytes.
string
required
Required. Human-readable display name of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Max length: 63 bytes.
string
Optional. Documentation describing the data exchange.
string
required
Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
string
Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
object
Sharing environment configuration for data exchange behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_DATAEXCHANGES_LISTINGSTool to create a new listing in a BigQuery Analytics Hub data exchange. Use when you need to share a BigQuery dataset with specific subscribers or make it available for discovery. The dataset must exist and be in the same region as the data exchange.

Input Parameters

string
required
Required. The parent data exchange resource path in format ‘projects/{projectId}/locations/{location}/dataExchanges/{dataExchangeId}’. The location must match the dataset location.
string
required
Required. The ID to use for the listing. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
object
Details of the publisher who owns the listing.
array
Optional. Categories of the listing. Up to two categories are allowed. Helps subscribers discover relevant data.
string
Optional. Short description of the listing. Max 2000 bytes. Use this to explain what data the listing contains and how it can be used.
string
required
Required. Human-readable display name of the listing. Max 63 bytes. Supports Unicode letters, numbers, underscores, dashes, spaces, ampersands.
object
Details of the data provider who owns the source data.
string
Optional. Documentation describing the listing in detail. Can include usage instructions, schema details, and data lineage information.
string
Optional. Email or URL where users can request access to the listing. Max 1000 bytes.
string
Optional. Email or URL of the primary point of contact for the listing. Max 1000 bytes.
object
required
Required. The BigQuery dataset source to be shared. This dataset must exist and be in the same region as the data exchange.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_DATASETTool to create a new BigQuery dataset with explicit location, labels, and description using the BigQuery Datasets API. Use when the workflow needs to set up a staging/warehouse dataset and correctness of region is critical to avoid downstream job location mismatches. Surfaces 409 Already Exists errors cleanly without retrying.

Input Parameters

array
Access control list (ACL) for the dataset. If not specified, the dataset inherits project-level permissions.
object
Labels to organize and categorize the dataset. Labels are key-value pairs. Keys and values must be lowercase, max 63 characters.
string
required
Geographic location where the dataset should reside. This is CRITICAL to avoid location-related query/job errors. Examples: ‘US’, ‘EU’, ‘us-central1’, ‘europe-west1’.
string
required
The dataset ID. Must be unique within the project. Use alphanumeric characters, underscores, or hyphens.
string
required
The project ID where the dataset will be created. This is used in the URL path, not in the request body.
string
A description of the dataset. Use this to document the dataset’s purpose and contents.
string
A user-friendly name for the dataset. This is a descriptive label that appears in the BigQuery UI.
integer
Default lifetime of all tables in the dataset, in milliseconds. Tables will be deleted this many milliseconds after creation unless explicitly set otherwise.
integer
Default lifetime of all partitions in tables in the dataset, in milliseconds. Partitions will be deleted this many milliseconds after creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_LISTINGTool to create a new listing in a data exchange using Analytics Hub API. Use when publishing a BigQuery dataset to make it available for subscription by other users or organizations.

Input Parameters

string ("json" | "media" | "proto")
Data format for response.
string
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string
Base64 encoded image representing the listing. Max Size: 3.0MiB. Expected image dimensions are 512x512 pixels.
string ("1" | "2")
V1 error format.
string
Selector specifying which fields to include in a partial response.
string
required
Required. The parent resource path of the listing. Format: ‘projects/{project_id}/locations/{location}/dataExchanges/{data_exchange_id}’.
string
JSONP callback parameter.
string
The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes. If not provided, a random ID will be generated.
object
Details of the listing publisher.
array
Categories of the listing. Up to two categories are allowed.
string
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
Legacy upload protocol for media (e.g. ‘media’, ‘multipart’).
string
Short description of the listing. Must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Max length: 2000 bytes.
string
required
Required. Human-readable display name of the listing. Must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and cannot start or end with spaces. Max length: 63 bytes.
string
OAuth 2.0 token for the current user.
boolean
Returns response with indentations and line breaks.
string
OAuth access token.
object
Details of the data provider.
string
Documentation describing the listing.
string
Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.
string
Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.
object
required
Required. Reference to the shared BigQuery dataset. Analytics Hub creates a linked dataset for subscribers when they subscribe to this listing.
string
Upload protocol for media (e.g. ‘raw’, ‘multipart’).
object
Restricted export configuration for linked dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_LOCATIONS_DATAPOLICIESTool to create a new data policy under a project with specified location using the v2beta1 BigQuery Data Policy API. Use when you need to set up data masking rules or column-level security for sensitive data. The v2beta1 endpoint uses a nested request structure.

Input Parameters

string
required
Required. Resource name of the project and location that the data policy will belong to. The format is projects/{project_number}/locations/{location_id}. Example: ‘projects/934040047113/locations/us-central1’.
object
required
Required. The data policy configuration containing the policy type, policy tag, and masking rules.
string
required
Required. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name. This will also be used as the display name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_QUERY_TEMPLATETool to create a new query template in a BigQuery Analytics Hub Data Clean Room (DCR) data exchange. Use when you need to define predefined and approved queries for data clean room use cases. Query templates must be created in DCR data exchanges only.

Input Parameters

string
required
Required. The parent resource where this query template will be created. Format: projects/{project}/locations/{location}/dataExchanges/{dataExchange}. Note: Query templates require a Data Clean Room (DCR) data exchange.
object
required
Required. The routine definition containing the query template logic.
string
Optional. Description of the query template explaining its purpose and usage.
string
required
Required. Human-readable name of the query template. This name will be shown to subscribers of the data exchange.
string
required
Required. The ID to use for the query template, which will become the final component of the template’s resource name. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_RESERVATIONTool to create a new BigQuery reservation resource to guarantee compute capacity (slots) for query and pipeline jobs. Use when you need to reserve dedicated compute resources for predictable performance and cost management. Reservations can be configured with autoscaling, concurrency limits, and edition-based features.

Input Parameters

string
required
Required. Project, location. E.g., ‘projects/myproject/locations/US’. The parent resource where the reservation will be created.
string ("EDITION_UNSPECIFIED" | "STANDARD" | "ENTERPRISE" | "ENTERPRISE_PLUS")
Edition of the reservation.
object
Auto scaling settings for the reservation.
string
Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. Default value is 0 which means that concurrency target will be automatically computed by the system. Must be a non-negative integer represented as a string.
string
required
Required. Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery. Must be a positive integer represented as a string. You can increase baseline slots every few minutes, but decreases are limited to once an hour if slots exceed committed slots.
string
Optional reservation ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. If not provided, a reservation ID will be generated automatically.
boolean
If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, jobs will execute with only the slot capacity specified in slot_capacity field.
boolean
Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization’s secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization’s default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_RESERVATION_ASSIGNMENTTool to create a BigQuery reservation assignment that allows a project, folder, or organization to submit jobs using slots from a specified reservation. Use when setting up resource allocation for BigQuery workloads. Note: A resource can only have one assignment per (job_type, location) combination.

Input Parameters

string
required
Required. The parent resource name of the assignment. Format: ‘projects/{project_id}/locations/{location}/reservations/{reservation_id}’. Example: ‘projects/myproject/locations/US/reservations/team1-prod’.
string ("JOB_TYPE_UNSPECIFIED" | "PIPELINE" | "QUERY" | "ML_EXTERNAL" | "BACKGROUND")
required
Required. Which type of jobs will use the reservation. Typically ‘QUERY’ for SQL queries, ‘PIPELINE’ for data pipelines, ‘ML_EXTERNAL’ for ML jobs, or ‘BACKGROUND’ for background jobs.
string
required
Required. The resource which will use the reservation. Can be a project, folder, or organization. Format: ‘projects/{project_id}’, ‘folders/{folder_id}’, or ‘organizations/{org_id}’.
string
Optional assignment ID. Assignment name will be generated automatically if this field is empty. Must only contain lower case alphanumeric characters or dashes. Max length is 64 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_ROUTINETool to create a new user-defined routine (function or procedure) in a BigQuery dataset. Use when you need to define SQL, JavaScript, Python, Java, or Scala functions/procedures for reusable logic, data transformations, or custom masking. Supports scalar functions, table-valued functions, procedures, and aggregate functions with comprehensive type definitions.

Input Parameters

string ("LANGUAGE_UNSPECIFIED" | "SQL" | "JAVASCRIPT" | "PYTHON" | "JAVA" | "SCALA")
Programming language of the routine.
array
Optional. Input/output arguments for the routine.
string
required
Required. Dataset ID where the routine will be created. Used in the URL path.
string
required
Required. Project ID where the routine will be created. Used in the URL path.
object
Data type of a BigQuery field or function argument. Supports simple types like INT64, and complex types like ARRAY and STRUCT.
boolean
Optional. If TRUE (default), the procedure body is checked for errors like non-existent tables. Set to FALSE for recursive procedures to avoid validation errors.
string
Optional. A description of the routine.
string ("ROUTINE_TYPE_UNSPECIFIED" | "SCALAR_FUNCTION" | "PROCEDURE" | "TABLE_VALUED_FUNCTION" | "AGGREGATE_FUNCTION")
required
Required. The type of routine: SCALAR_FUNCTION, PROCEDURE, TABLE_VALUED_FUNCTION, or AGGREGATE_FUNCTION.
string ("SECURITY_MODE_UNSPECIFIED" | "DEFINER" | "INVOKER")
Security mode of the routine.
object
Options for user-defined Spark routines.
string
required
Required. The body of the routine. For SQL functions, this is the expression in the AS clause (excluding parentheses). For JavaScript, it’s the evaluated string in the AS clause.
object
A table type for table-valued functions.
string ("DETERMINISM_LEVEL_UNSPECIFIED" | "DETERMINISTIC" | "NOT_DETERMINISTIC")
Determinism level for JavaScript UDFs.
object
required
Required. Reference containing projectId, datasetId, and routineId for the new routine.
array
Optional. For JavaScript routines, paths of imported JavaScript libraries.
string ("DATA_GOVERNANCE_TYPE_UNSPECIFIED" | "DATA_MASKING")
Data governance type for the routine.
object
Options for remote user-defined functions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_CREATE_TABLETool to create a new, empty table in a BigQuery dataset. Use when setting up data infrastructure for standard tables, external tables, views, or materialized views. Supports partitioning, clustering, and encryption configuration.

Input Parameters

object
Logical view definition.
object
Labels to organize tables. Keys and values must be lowercase, max 63 characters, starting with a letter.
object
Schema of a table defining its fields/columns.
object
Clustering configuration for a table.
string
required
The dataset ID where the table will be created. Used in the URL path.
string
required
The project ID where the table will be created. Used in the URL path.
string
A user-friendly description of the table.
string
A descriptive name for the table shown in the BigQuery UI.
string
Time when the table expires, in milliseconds since epoch. If not set, the table persists indefinitely or uses dataset default.
object
required
Reference identifying the table. Must match project_id and dataset_id from the path.
string
Default collation for new STRING fields. Options: ‘und:ci’ (case insensitive), ” (case sensitive, default).
object
Materialized view definition and configuration.
object
Time-based partitioning configuration for a table.
object
Range-based partitioning configuration for a table.
boolean
If true, queries over this table require a partition filter for partition elimination.
object
Encryption configuration for a table.
object
Configuration for external data sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_DELETE_DATASETTool to delete a BigQuery dataset specified by datasetId via the datasets.delete API. Before deletion, you must delete all tables unless deleteContents=True is specified. Use when cleaning up test datasets or removing unused data warehouses. Immediately after deletion, you can create another dataset with the same name.

Input Parameters

string
required
Required. Dataset ID of dataset being deleted.
string
required
Required. Project ID of the dataset being deleted.
boolean
If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_DELETE_JOB_METADATATool to delete the metadata of a BigQuery job. Use when you need to remove job metadata from the system. If this is a parent job with child jobs, metadata from all child jobs will be deleted as well.

Input Parameters

string
required
Required. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed.
string
The geographic location of the job. Required for jobs in certain regions. See details at: https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
string
required
Required. Project ID of the job for which metadata is to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_DELETE_MODELTool to delete a BigQuery ML model from a dataset. Use when you need to remove a trained machine learning model permanently. The operation deletes the model and cannot be undone.

Input Parameters

string
required
Required. Model ID of the model to delete.
string
required
Required. Dataset ID of the model to delete.
string
required
Required. Project ID of the model to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_DELETE_ROUTINETool to delete a BigQuery routine by its ID. Use when you need to remove a stored procedure, user-defined function, or table function from a dataset. This operation is irreversible.

Input Parameters

string
required
Required. Dataset ID of the routine to delete.
string
required
Required. Project ID of the routine to delete.
string
required
Required. Routine ID of the routine to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_DELETE_TABLETool to delete a BigQuery table from a dataset. Use when you need to remove a table and all its data permanently. The operation deletes all data in the table and cannot be undone.

Input Parameters

string
required
Required. Table ID of the table to delete.
string
required
Required. Dataset ID of the table to delete.
string
required
Required. Project ID of the table to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_BIGQUERY_MODELTool to retrieve a specific BigQuery ML model resource by model ID. Use when you need detailed information about a trained machine learning model including its configuration, training runs, hyperparameters, and evaluation metrics.

Input Parameters

string
required
Required. Model ID of the requested model.
string
required
Required. Dataset ID of the requested model.
string
required
Required. Project ID of the requested model.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_CONNECTION_IAM_POLICYTool to get the IAM access control policy for a BigQuery connection resource. Returns an empty policy if the resource exists but has no policy set. Use this to check who has access to a specific connection before modifying permissions.

Input Parameters

object
Optional settings for GetIamPolicy request. Specify requestedPolicyVersion if you need a specific policy version format.
string
required
REQUIRED: The resource for which the policy is being requested. Format: projects/{project}/locations/{location}/connections/{connection}. Example: projects/my-project/locations/us/connections/my-connection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_DATASETTool to retrieve BigQuery dataset metadata including location via the datasets.get API. Use this before creating jobs/queries if the workflow has been failing with location mismatch to confirm the dataset’s region and correct the job location accordingly.

Input Parameters

string
required
Dataset ID of the requested dataset.
string
required
Project ID of the requested dataset.
string ("DATASET_VIEW_UNSPECIFIED" | "METADATA" | "ACL" | "FULL")
Optional view specifying which dataset information to return. DATASET_VIEW_UNSPECIFIED defaults to FULL. METADATA returns only metadata. ACL returns only access control. FULL returns both metadata and ACL.
integer
Version of access policy schema to fetch. Valid values: 0, 1, 3. Use version 3 for conditional access policy bindings. If unset, defaults to version 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_JOBTool to retrieve information about a specific BigQuery job. Returns job configuration, status, and statistics. Use this to check job status after running queries or to get details about job execution.

Input Parameters

string
required
Required. Job ID of the requested job.
string
The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the us or the eu multi-regional location - If the job’s location is in a single region (for example, us-central1) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
string
required
Required. Project ID of the requested job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_QUERY_RESULTSTool to get the results of a BigQuery query job via RPC. Use this to retrieve results after running a query, or to check job completion status and fetch paginated results.

Input Parameters

string ("json" | "media" | "proto")
Data format for response enum.
string
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. Optional.
string
required
Required. Job ID of the query job.
string ("1" | "2")
V1 error format enum.
string
Selector specifying which fields to include in a partial response. Optional.
string
JSONP callback parameter. Optional.
string
The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the us or the eu multi-regional location - If the job’s location is in a single region (for example, us-central1). For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. Optional.
string
Page token, returned by a previous call, to request the next page of results. Optional.
string
required
Required. Project ID of the query job.
string
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Optional.
integer
Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true. Optional.
integer
Maximum number of results to read. Optional.
string
Zero-based index of the starting row. Optional.
string
Legacy upload protocol for media (e.g. “media”, “multipart”). Optional.
string
OAuth 2.0 token for the current user. Optional.
boolean
Returns response with indentations and line breaks. Optional.
string
OAuth access token. Optional.
string
Upload protocol for media (e.g. “raw”, “multipart”). Optional.
boolean
Optional. Output timestamp as usec int64. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_ROUTINETool to retrieve a BigQuery routine (user-defined function or stored procedure) by its ID. Use to inspect routine definitions, arguments, return types, and metadata.

Input Parameters

string
If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.
string
required
Required. Dataset ID of the requested routine.
string
required
Required. Project ID of the requested routine.
string
required
Required. Routine ID of the requested routine.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_ROUTINE_IAM_POLICYTool to retrieve the IAM access control policy for a BigQuery routine resource. Returns an empty policy if the routine exists but has no policy set. Use this to check current access permissions before modifying them.

Input Parameters

object
Optional settings for GetIamPolicy request. Specify requestedPolicyVersion if you need a specific policy version format.
string
required
Required. The ID of the dataset containing the routine.
string
required
Required. The ID of the project containing the routine.
string
required
Required. The ID of the routine to get IAM policy for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_SERVICE_ACCOUNTTool to get the service account for a project used for interactions with Google Cloud KMS. Use when you need to retrieve the BigQuery service account email for KMS encryption configuration or key access permissions.

Input Parameters

string ("json" | "media" | "proto")
Data format for response. Optional query parameter.
string
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. Optional query parameter.
string ("1" | "2")
V1 error format. Optional query parameter.
string
Selector specifying which fields to include in a partial response. Optional query parameter.
string
JSONP callback. Optional query parameter.
string
required
Required. ID of the project.
string
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Optional query parameter.
string
Legacy upload protocol for media (e.g. ‘media’, ‘multipart’). Optional query parameter.
string
OAuth 2.0 token for the current user. Optional query parameter.
boolean
Returns response with indentations and line breaks. Optional query parameter.
string
OAuth access token. Optional query parameter.
string
Upload protocol for media (e.g. ‘raw’, ‘multipart’). Optional query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_TABLE_IAM_POLICYTool to retrieve the IAM access control policy for a BigQuery table resource. Returns an empty policy if the resource exists but has no policy set. Use this to check current access permissions before modifying them.

Input Parameters

string
required
REQUIRED: The resource for which the policy is being requested. Format: ‘projects/{projectId}/datasets/{datasetId}/tables/{tableId}’.
integer
Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Policies with conditional role bindings must specify version 3. If unset, defaults to version 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_GET_TABLE_SCHEMAFetch a BigQuery table’s schema and metadata without querying row data. The returned schema includes top-level field names, types, modes, and descriptions, but not nested field definitions.

Input Parameters

string
required
The table ID to retrieve schema and metadata for.
string
required
The dataset ID containing the table.
string
required
The project ID containing the dataset.
string
Comma-separated list of fields to return (e.g., ‘schema,numRows,type’). If not specified, returns all fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_INSERT_ALLTool to stream data into BigQuery one record at a time without running a load job. Use when you need immediate data availability or inserting small batches. Supports row-level deduplication via insertId and error handling via skipInvalidRows.

Input Parameters

array
required
Required. Array of rows to insert. Each row contains the data to be inserted as a JSON object. At least one row must be provided.
string
Optional. Unique request trace ID for debugging. Case-sensitive, up to 36 ASCII characters. A UUID is recommended.
string
required
Required. Table ID of the destination table.
string
required
Required. Dataset ID of the destination table.
string
required
Required. Project ID of the destination table.
string
Optional. If specified, treats the destination table as a base template and inserts rows into an instance table named ‘{destination}{templateSuffix}’. Useful for table sharding patterns.
boolean
Optional. If true, insert all valid rows even if some rows are invalid. If false (default), the entire request fails if any row is invalid.
boolean
Optional. If true, accept rows with values that don’t match the schema and ignore the unknown values. If false (default), treat unknown values as errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_INSERT_JOBTool to start a new asynchronous BigQuery job (query, load, extract, or copy). Use when you need to run a query as a job, load data from Cloud Storage, extract table data to GCS, or copy tables. For dry-run validation without execution, set dryRun to true in configuration.

Input Parameters

string
required
Project ID of project that will be billed for the job. This is used in the URL path.
object
Job reference identifying the job.
object
required
Required. Job configuration. Specify exactly one of: query, load, extract, or copy in the configuration object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_INSERT_JOB_WITH_UPLOADTool to start a new BigQuery load job with file upload. Uploads a file (CSV, JSON, etc.) and loads it into a BigQuery table in a single operation. Use when you need to upload data from a local file directly to BigQuery rather than loading from Cloud Storage.

Input Parameters

string
required
Project ID that will be billed for the job. Used in the URL path.
object
Optional job reference for the upload job.
object
required
Job configuration containing load settings (schema, destination table, format, etc.).
object
required
File to upload to BigQuery. The file content will be loaded according to the sourceFormat specified in configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_ANALYTICS_HUB_LISTINGSTool to list all listings in a given Analytics Hub data exchange. Use when you need to discover available data listings within a specific data exchange that can be subscribed to for data sharing.

Input Parameters

string ("json" | "media" | "proto")
Data format for response.
string
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string ("1" | "2")
V1 error format.
string
Selector specifying which fields to include in a partial response.
string
required
Required. The parent resource path of the listing. Format: ‘projects/{project_id}/locations/{location}/dataExchanges/{data_exchange_id}’ where project_id is your GCP project ID, location is the region (e.g., ‘US’, ‘us-central1’), and data_exchange_id is the data exchange identifier.
string
JSONP callback parameter.
integer
The maximum number of results to return in a single response page. Use page tokens to iterate through the entire collection.
string
Page token, returned by a previous call, to request the next page of results.
string
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
Legacy upload protocol for media (e.g. ‘media’, ‘multipart’).
string
OAuth 2.0 token for the current user.
boolean
Returns response with indentations and line breaks.
string
OAuth access token.
string
Upload protocol for media (e.g. ‘raw’, ‘multipart’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_BIG_QUERY_CONNECTIONSTool to list BigQuery connections in a given project and location. Use when you need to discover available external data source connections (Cloud SQL, AWS, Azure, Spark, etc.) configured for BigQuery.

Input Parameters

string
required
Required. Parent resource name. Must be in the form: projects/{project_id}/locations/{location_id}. Example: ‘projects/my-project/locations/us-central1’
integer
Maximum number of connections to return per page.
string
Page token for pagination. Use the nextPageToken from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_CAPACITY_COMMITMENTSList capacity commitments for an admin project in a specified location, including purchased compute slots and commitment details such as plan, state, and duration. Results are paginated.

Input Parameters

string
required
Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US
integer
The maximum number of items to return.
string
The next_page_token value returned from a previous List request, if any.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_DATAEXCHANGES_LISTINGSTool to list all listings in a given Analytics Hub data exchange using the v1beta1 API. Use when you need to discover available data listings within a specific data exchange that can be subscribed to for data sharing.

Input Parameters

string ("json" | "media" | "proto")
Data format for response.
string
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string ("1" | "2")
V1 error format.
string
Selector specifying which fields to include in a partial response.
string
required
Required. The parent resource path of the listing. Format: ‘projects/{project_id}/locations/{location}/dataExchanges/{data_exchange_id}’ where project_id is your GCP project ID, location is the region (e.g., ‘US’, ‘us-central1’), and data_exchange_id is the data exchange identifier.
string
JSONP callback parameter.
integer
The maximum number of results to return in a single response page. Use page tokens to iterate through the entire collection.
string
Page token, returned by a previous call, to request the next page of results.
string
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
Legacy upload protocol for media (e.g. ‘media’, ‘multipart’).
string
OAuth 2.0 token for the current user.
boolean
Returns response with indentations and line breaks.
string
OAuth access token.
string
Upload protocol for media (e.g. ‘raw’, ‘multipart’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_DATASETSTool to list datasets in a specific BigQuery project, including dataset locations. Use after identifying an accessible project to discover available datasets and their locations before querying. The dataset location is critical for avoiding location-related query/job errors.

Input Parameters

boolean
Whether to list all datasets, including hidden ones. Defaults to false.
string
Filter datasets by label in the format ‘labels.key:value’. Multiple filters can be ANDed together by connecting with a space.
string
Page token for pagination. Use the nextPageToken from a previous response to get the next page of results.
string
required
The project ID containing the datasets.
integer
Maximum number of datasets to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_JOBSLists a page of jobs in a BigQuery project, optionally including jobs owned by all users, with filters for creation time, state, or parent job. Job information is available for six months and sorted by creation time in reverse chronological order.

Input Parameters

boolean
Whether to display jobs owned by all users in the project. Default False. Requires Is Owner project role to set to true.
string
Page token, returned by a previous call, to request the next page of results.
string
required
Project ID of the jobs to list.
string ("full" | "minimal")
Restrict information returned to a set of selected fields.
integer
The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
array
Filter for job state. Can include values like ‘done’, ‘pending’, ‘running’. Multiple states can be specified.
string
If set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.
string
Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.
string
Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_LOCATIONSTool to list information about supported locations for BigQuery Data Transfer Service. Use when you need to discover available regions/locations where BigQuery Data Transfer operations can be performed.

Input Parameters

string
required
The resource that owns the locations collection, if applicable. Format: ‘projects/{project_id}’ where project_id is your GCP project ID.
string
A filter to narrow down results to a preferred subset. The filtering language accepts strings like ‘displayName=tokyo’, and is documented in more detail in AIP-160.
integer
The maximum number of results to return. If not set, the service selects a default.
string
A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_LOCATIONS_CONNECTIONSTool to list BigQuery connections in a given project and location using the v1beta1 API. Use when you need to discover available external data source connections (Cloud SQL, AWS, Azure, Spark, etc.) configured for BigQuery in a specific location.

Input Parameters

string
required
Required. Parent resource name. Must be in the form: projects/{project_id}/locations/{location_id}. Example: ‘projects/my-project/locations/us’
string
Page token for pagination. Use the nextPageToken from a previous response to get the next page of results.
integer
required
Required. Maximum number of connections to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_LOCATIONS_DATAPOLICIESTool to list all data policies in a specified parent project and location using the v2beta1 API. Use when you need to discover data masking policies and column-level security policies configured for BigQuery datasets.

Input Parameters

string
Filters the data policies by policy tags that they are associated with. Currently filter only supports ‘policy_tag’ based filtering and OR based predicates. Sample filter can be ‘policy_tag: projects/1/locations/us/taxonomies/2/policyTags/3’. You may also use wildcard such as ‘policy_tag: projects/1/locations/us/taxonomies/2*’. Please note that OR predicates cannot be used with wildcard filters.
string
required
Required. Resource name of the project for which to list data policies. Format is projects/{project}/locations/{location}.
integer
The maximum number of data policies to return. Must be a value between 1 and 1000. If not set, defaults to 50.
string
The nextPageToken value returned from a previous list request, if any. If not set, defaults to an empty string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_MODELSTool to list all BigQuery ML models in a specified dataset. Requires READER dataset role. Use this to discover available models before getting detailed information via models.get method.

Input Parameters

string
required
Required. Dataset ID of the models to list.
string
Page token for pagination, returned by a previous call to request the next page of results.
string
required
Required. Project ID of the models to list.
integer
Maximum number of models to return per page. Use page tokens to iterate through the entire collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_ORGANIZATION_DATA_EXCHANGESTool to list all data exchanges from projects in a given organization and location using Analytics Hub API. Use when you need to discover available data exchanges within an organization that can be used for data sharing.

Input Parameters

string ("json" | "media" | "proto")
Data format for response.
string
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string ("1" | "2")
V1 error format.
string
Selector specifying which fields to include in a partial response.
string
JSONP callback parameter.
integer
The maximum number of results to return in a single response page. Use page tokens to iterate through the entire collection.
string
Page token, returned by a previous call, to request the next page of results.
string
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
Legacy upload protocol for media (e.g. ‘media’, ‘multipart’).
string
OAuth 2.0 token for the current user.
boolean
Returns response with indentations and line breaks.
string
OAuth access token.
string
required
Required. The organization resource path of the projects containing DataExchanges. Format: ‘organizations/{organization_id}/locations/{location}’ where organization_id is your GCP organization ID and location is the region (e.g., ‘US’, ‘us-central1’).
string
Upload protocol for media (e.g. ‘raw’, ‘multipart’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_PROJECTSTool to list BigQuery projects to which the user has been granted any project role. Returns projects with at least READ access. For enhanced capabilities, consider using the Resource Manager API.

Input Parameters

string
Page token returned by a previous call, to request the next page of results. If not present, no further pages are available.
integer
Maximum number of projects to return per page. If not set, returns all results up to 50 per page. The number of projects returned may be fewer than maxResults because projects are filtered to only those with the BigQuery API enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_QUERY_TEMPLATESList a page of query templates in an Analytics Hub data exchange. Use the returned page token to retrieve further pages and discover predefined queries for data clean room use cases.

Input Parameters

string
required
Required. The parent resource path of the QueryTemplates. Format: projects/{project}/locations/{location}/dataExchanges/{dataExchange}.
integer
The maximum number of results to return in a single response page. Use page tokens to iterate through the entire collection.
string
Page token, returned by a previous call, to request the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_RESERVATION_ASSIGNMENTSTool to list BigQuery reservation assignments. Only explicitly created assignments will be returned (no expansion or merge happens). Use wildcard ”-” in parent path to list assignments across all reservations in a location.

Input Parameters

string
required
Required. The parent resource name of the reservation. Format: ‘projects/{project_id}/locations/{location}/reservations/{reservation_id}’ or ‘projects/{project_id}/locations/{location}/reservations/-’ (wildcard to list assignments across all reservations).
integer
Maximum number of assignments to return per page.
string
Page token from a previous ListAssignments response to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_RESERVATION_GROUPSTool to list all BigQuery reservation groups for a project in a specified location. Use when you need to discover available reservation groups which serve as containers for reservations.

Input Parameters

string
required
Required. The parent resource name containing project and location in the format projects/{projectId}/locations/{location} where location is the geographic location (e.g., us-central1, us-east1).
integer
The maximum number of items to return per page. If not specified, the server will determine the number of results to return.
string
The next_page_token value returned from a previous List request, if any. Use this to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_RESERVATIONSTool to list all BigQuery reservations for a project in a specified location. Use when you need to discover available reservations or view reservation details including slot capacity and autoscale configuration.

Input Parameters

string ("json" | "media" | "proto")
Data format for response.
string
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string ("1" | "2")
V1 error format.
string
Selector specifying which fields to include in a partial response.
string
required
Required. The parent resource name containing project and location, e.g.: projects/myproject/locations/US. The location must be specified (e.g., US, EU, us-central1).
string
JSONP
integer
The maximum number of items to return per page. If not specified, the server will determine the number of results to return.
string
The next_page_token value returned from a previous List request, if any. Use this to retrieve the next page of results.
string
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
OAuth 2.0 token for the current user.
string
Legacy upload protocol for media (e.g. ‘media’, ‘multipart’).
string
OAuth access token.
boolean
Returns response with indentations and line breaks.
string
Upload protocol for media (e.g. ‘raw’, ‘multipart’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_ROUTINESList routines, including user-defined functions and stored procedures, in a BigQuery dataset. Results are paginated; use the returned page token to retrieve subsequent pages.

Input Parameters

string
If set, then only the Routines matching this filter are returned. The supported format is routineType:{RoutineType}, where {RoutineType} is a RoutineType enum. For example: routineType:SCALAR_FUNCTION.
string
If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.
string
Page token, returned by a previous call, to request the next page of results.
string
required
Required. Dataset ID of the routines to list.
integer
The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
string
required
Required. Project ID of the routines to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_ROW_ACCESS_POLICIESList row access policies and their filter predicates for a specified BigQuery table. Results are paginated; use the returned page token to retrieve subsequent pages.

Input Parameters

string
required
Required. Table ID of the table to list row access policies.
integer
The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
string
required
Required. Dataset ID of row access policies to list.
string
Page token, returned by a previous call, to request the next page of results.
string
required
Required. Project ID of the row access policies to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_TABLE_DATATool to list the content of a BigQuery table in rows via the REST API. Use this to retrieve actual data from a table without writing SQL queries. Returns paginated results with row data in the native BigQuery format.

Input Parameters

string
required
Required. Table ID of the table to list.
string
required
Required. Dataset ID of the table to list.
string
To retrieve the next page of table data, set this field to the string provided in the pageToken field of the response body from your previous call to tabledata.list.
string
required
Required. Project ID of the table to list.
integer
Row limit of the table. Maximum number of rows to return per page.
string
Start row index of the table.
string
Subset of fields to return, supports select into sub fields. Example: selected_fields = ‘a,e.d.f’;
boolean
Optional. Output timestamp as usec int64. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_LIST_TABLESList tables in a BigQuery dataset via the REST API, with pagination. This can help discover accessible tables without relying on SQL-based metadata queries.

Input Parameters

string
required
The dataset ID to list tables from.
string
Page token for pagination. Use the nextPageToken from a previous response to get the next page of results.
string
required
The project ID containing the dataset.
integer
Maximum number of tables to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_PATCH_DATASETTool to update an existing BigQuery dataset using RFC5789 PATCH semantics. Only replaces fields provided in the request, leaving other fields unchanged. Use when you need to modify dataset properties like description, labels, expiration settings, or access controls without affecting other configuration.

Input Parameters

array
Optional. An array of objects that define dataset access for one or more entities.
object
The labels associated with this dataset. You can use these to organize and group your datasets.
string
The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
string
required
Required. Dataset ID of the dataset being updated.
string
required
Required. Project ID of the dataset being updated.
string
Optional. A user-friendly description of the dataset.
string
Optional. A descriptive name for the dataset.
object
Dataset reference for patching.
string
Optional. Defines the default collation specification of future tables created in the dataset. Supported values: ‘und:ci’ (case insensitive) or ” (case sensitive).
boolean
Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE.
string
Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days).
string ("ROUNDING_MODE_UNSPECIFIED" | "ROUND_HALF_AWAY_FROM_ZERO" | "ROUND_HALF_EVEN")
Optional. Defines the default rounding mode specification of new tables created within this dataset.
object
Linked dataset source configuration.
string ("STORAGE_BILLING_MODEL_UNSPECIFIED" | "LOGICAL" | "PHYSICAL")
Optional. Updates storage_billing_model for the dataset.
string
Optional. The default lifetime of all tables in the dataset, in milliseconds. Minimum value is 3600000 (one hour). Set to 0 to clear.
object
External dataset reference configuration.
string
Default partition expiration in milliseconds. When new time-partitioned tables are created, they will inherit this value.
object
Encryption configuration for the dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_PATCH_MODELTool to update specific fields in an existing BigQuery ML model using PATCH semantics. Use when you need to modify model metadata like description, friendly name, labels, or expiration time without replacing the entire model resource.

Input Parameters

object
The labels associated with this model. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes.
string
required
Required. Model ID of the model to patch.
string
required
Required. Dataset ID of the model to patch.
string
required
Required. Project ID of the model to patch.
string
Optional. A user-friendly description of this model.
string
Optional. A descriptive name for this model.
string
Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely.
object
Encryption configuration for the model.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_PATCH_TABLETool to update specific fields in an existing BigQuery table using RFC5789 PATCH semantics. Only the fields provided in the request are updated; unspecified fields remain unchanged. Use when you need to modify table metadata like description, friendly name, labels, or expiration time without replacing the entire table resource.

Input Parameters

object
Labels to organize and categorize the table. Keys and values must be lowercase, max 63 characters.
string
required
The table ID to update.
string
required
The dataset ID containing the table to update.
string
required
The project ID containing the table to update.
string
User-friendly description of the table. Use this to document the table’s purpose and contents.
string
A descriptive name for the table that appears in the BigQuery UI.
string
The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely.
boolean
When true, will autodetect schema; otherwise will keep the original schema.
boolean
If true, queries over this table require a partition filter that can be used for partition elimination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_QUERYRuns a SQL query in BigQuery using the REST API, including statements that can modify data. Results appear under data.rows; an empty array does not necessarily mean no matches if the job is incomplete, and the response can include a job ID and page token for retrieving results.

Input Parameters

string
required
Query to run on BigQuery. Use standard SQL syntax.
string
Geographic location where the query should run (e.g., ‘US’, ‘EU’, ‘us-central1’). Defaults to ‘US’ multi-region. Must match the dataset’s actual geographic location; mismatched regions cause query failure.
string
required
The project ID to run the query against.
integer
Query timeout in milliseconds. Defaults to 10000 (10 seconds).
integer
Maximum number of rows to return. If not specified, returns all rows.
boolean
Whether to use legacy SQL syntax. Defaults to False (standard SQL).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_SEARCH_ALL_ASSIGNMENTSTool to search all BigQuery reservation assignments for a specified resource in a particular region. Use when you need to find assignments for a project, folder, or organization. Returns assignments created on the resource or its closest ancestor, covering all JobTypes.

Input Parameters

string ("json" | "media" | "proto")
Data format for response.
string
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string
Please specify resource name as assignee in the query. Examples: * assignee=projects/myproject * assignee=folders/123 * assignee=organizations/456
string ("1" | "2")
V1 error format.
string
Selector specifying which fields to include in a partial response.
string
required
Required. The resource name with location (project name could be the wildcard ’-’), e.g.: projects/-/locations/US.
string
JSONP
integer
The maximum number of items to return per page.
string
The next_page_token value returned from a previous List request, if any.
string
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
OAuth 2.0 token for the current user.
string
Legacy upload protocol for media (e.g. ‘media’, ‘multipart’).
string
OAuth access token.
boolean
Returns response with indentations and line breaks.
string
Upload protocol for media (e.g. ‘raw’, ‘multipart’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_SET_ROUTINE_IAM_POLICYTool to set the IAM access control policy for a BigQuery routine resource. Use this to grant or modify access permissions for users, service accounts, or groups. Include the etag from getIamPolicy to prevent concurrent modifications.

Input Parameters

object
required
The IAM policy to set, containing bindings (array of role-members mappings), optional etag and version.
string
required
Required. Dataset ID of the routine.
string
required
Required. Project ID of the routine.
string
required
Required. Routine ID.
string
Field mask for selective policy updates. Specify fields to update (e.g., ‘bindings,etag’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_TEST_ROUTINE_IAM_PERMISSIONSTool to test which IAM permissions the caller has on a BigQuery routine. Returns the subset of requested permissions that the caller actually has. Use to verify access before performing operations.

Input Parameters

string
required
Required. Dataset ID of the routine to test IAM permissions for.
string
required
Required. Project ID of the routine to test IAM permissions for.
string
required
Required. Routine ID to test IAM permissions for.
array
required
Required. The set of permissions to check for the resource. Array of permission strings like ‘bigquery.routines.get’, ‘bigquery.routines.update’, ‘bigquery.routines.delete’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_UNDELETE_DATASETTool to undelete a BigQuery dataset within the time travel window. If a deletion time is specified, the dataset version deleted at that time is undeleted; otherwise, the most recently deleted version is restored.

Input Parameters

string
required
Required. Dataset ID of the dataset being undeleted.
string
required
Required. Project ID of the dataset to be undeleted.
string
Optional. The exact time when the dataset was deleted (RFC3339 format). If not specified, it will undelete the most recently deleted version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_UPDATE_CONNECTIONTool to update a specified BigQuery connection using the BigQuery Connection API. Use when you need to modify connection properties such as friendly name, description, or connection-specific settings. For security reasons, credentials are automatically reset if connection properties are included in the update mask.

Input Parameters

object
Connection properties specific to Amazon Web Services.
string
required
Required. Name of the connection to update in the format ‘projects/{project_id}/locations/{location_id}/connections/{connection_id}’.
object
Connection properties specific to Azure.
object
Connection properties for Apache Spark.
object
Connection properties specific to Cloud SQL.
string
Optional. The Cloud KMS key that is used for encryption. Example: ‘projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]’.
string
required
Required. Update mask for the connection fields to be updated. Comma-separated list of field paths (e.g., ‘friendlyName,description’). For security reasons, credentials are reset if connection properties are in the mask.
string
User provided description.
object
Connection properties specific to Cloud Spanner.
string
User provided display name for the connection.
object
Connection properties for delegation of access to GCP resources.
object
Connection properties specific to Salesforce DataCloud.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_UPDATE_DATASETTool to update information in an existing BigQuery dataset using the PUT method. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. Use when you need to modify dataset properties like description, access controls, or default settings.

Input Parameters

array
Optional. An array of objects that define dataset access for one or more entities. If unspecified, BigQuery adds default dataset access for projectReaders, projectWriters, projectOwners, and the dataset creator.
object
Optional. Labels to organize and categorize the dataset. Labels are key-value pairs. Keys and values must be lowercase, max 63 characters.
string
required
Required. Geographic location where the dataset resides. This cannot be changed after dataset creation. Examples: ‘US’, ‘EU’, ‘us-central1’, ‘europe-west1’.
string
required
Required. Dataset ID of the dataset being updated. This is used in the URL path.
string
required
Required. Project ID of the dataset being updated. This is used in the URL path.
string
Optional. A user-friendly description of the dataset. Use this to document the dataset’s purpose and contents.
string
Optional. A descriptive name for the dataset. This is a user-friendly label that appears in the BigQuery UI.
object
required
Required. Dataset reference containing the dataset ID and project ID. This must match the path parameters.
string
Optional. Defines the default collation specification of future tables created in the dataset. Supported values: ‘und:ci’ (undetermined locale, case insensitive) or ” (empty string for case-sensitive).
boolean
Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE.
integer
Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.
string ("ROUNDING_MODE_UNSPECIFIED" | "ROUND_HALF_AWAY_FROM_ZERO" | "ROUND_HALF_EVEN")
Optional. Defines the default rounding mode specification of new tables created within this dataset.
object
A dataset source type which refers to another BigQuery dataset.
string ("STORAGE_BILLING_MODEL_UNSPECIFIED" | "LOGICAL" | "PHYSICAL")
Optional. Updates storage_billing_model for the dataset. LOGICAL uses logical bytes, PHYSICAL uses physical bytes.
integer
Optional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration, set to 0.
object
Configures the access a dataset defined in an external metadata storage.
integer
Optional. The default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in this dataset, the table will inherit this value.
object
Encryption configuration for the dataset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_UPDATE_ROUTINETool to update an existing BigQuery routine (function or stored procedure). This replaces the entire routine resource with the provided definition. Use when modifying routine logic, arguments, return types, or other configuration. Ensure all required fields are provided as this is a full replacement operation.

Input Parameters

string
The language of the routine. Options: ‘SQL’, ‘JAVASCRIPT’, ‘PYTHON’, ‘JAVA’, ‘SCALA’. Defaults to ‘SQL’ if remote_function_options is absent.
array
Optional. The list of arguments for the routine.
string
required
The dataset ID of the routine to update. Used in the URL path.
string
required
The project ID of the routine to update. Used in the URL path.
object
Data type specification for BigQuery routine arguments and return values.
string
required
The routine ID of the routine to update. Used in the URL path.
boolean
Optional. For procedures, enables additional error checking. Default is TRUE.
string
Optional. A description of the routine.
string
required
REQUIRED. The type of routine. Options: ‘SCALAR_FUNCTION’, ‘PROCEDURE’, ‘TABLE_VALUED_FUNCTION’, ‘AGGREGATE_FUNCTION’.
string
Optional. The security mode of the routine. Options: ‘DEFINER’, ‘INVOKER’.
object
Options for a user-defined Spark routine.
string
required
REQUIRED. The body of the routine. For SQL functions, this is the expression (without parentheses). For JavaScript, this is the evaluated string.
object
Table type returned by table-valued functions.
string
Optional. The determinism level of JavaScript UDFs. Options: ‘DETERMINISTIC’, ‘NOT_DETERMINISTIC’.
object
required
REQUIRED. The routine reference in the request body. Must match the path parameters.
array
Optional. For JavaScript routines, the paths of imported JavaScript libraries.
string
Optional. If set to ‘DATA_MASKING’, the function is validated as a masking function.
object
Options for a remote user-defined function.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLEBIGQUERY_UPDATE_TABLETool to update an existing BigQuery table. The update method replaces the entire Table resource, whereas the patch method only replaces fields that are provided. Use when you need to modify table properties like schema, description, labels, partitioning, or clustering configuration.

Input Parameters

object
Optional. Labels to organize and group your tables. Keys and values must be lowercase, max 63 characters.
object
Schema of a table.
string
required
Required. Table ID of the table to update.
object
Configures table clustering.
string
required
Required. Dataset ID of the table to update.
string
required
Required. Project ID of the table to update.
string
Optional. A user-friendly description of this table.
string
Optional. A descriptive name for this table.
string
Optional. The time when this table expires, in milliseconds since the epoch.
object
required
Required. Reference identifying the table. Must match the path parameters.
string
Optional. Defines the default collation specification of new STRING fields in the table.
object
Configures time-based partitioning for the table.
boolean
Optional. When true will autodetect schema, else will keep original schema.
object
Configures range-based partitioning for the table.
boolean
Optional. If set to true, queries over this table require a partition filter.
object
Encryption configuration for the table.
object
Configuration for external data sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not