Bigquery.datasets.list

Lists all datasets in the specified project to which you have been granted the READER dataset role.

GET/projects/{projectId}/datasets

Use it in a workflow

Add a step and choose the BigQuery connector.
Pick the Bigquery.datasets.list action (under datasets).
Fill in the fields below, then reference the result from later steps as {{bigqueryDatasetsList.response.data}}.

Request

Path parameters

projectIdstringrequired

Project ID of the datasets to be listed

Query parameters

altstring

Data format for the response.

One ofjson

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

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.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIpstring

Deprecated. Please use quotaUser instead.

allboolean

Whether to list all datasets, including hidden ones

filterstring

An expression for filtering the results of the request by label. The syntax is "labels.<name>[:<value>]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.

maxResultsinteger

The maximum number of results to return

pageTokenstring

Page token, returned by a previous call, to request the next page of results

Response

Returns 200 with an object. Read it in later steps with {{bigqueryDatasetsList.response.data.<field>}}.

datasetsarray<object>

An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.

datasetReferenceobject2 fields

friendlyNamestring

A descriptive name for the dataset, if one exists.

idstring

The fully-qualified, unique, opaque ID of the dataset.

kindstring

The resource type. This property always returns the value "bigquery#dataset".

Default "bigquery#dataset"

labelsobject

The labels associated with this dataset. You can use these to organize and group your datasets.

locationstring

The geographic location where the data resides.

etagstring

A hash value of the results page. You can use this property to determine if the page has changed since the last request.

kindstring

The list type. This property always returns the value "bigquery#datasetList".

Default "bigquery#datasetList"

nextPageTokenstring

A token that can be used to request the next results page. This property is omitted on the final results page.

json

{
  "datasets": [
    {
      "datasetReference": {
        "datasetId": "string",
        "projectId": "string"
      },
      "friendlyName": "string",
      "id": "string",
      "kind": "bigquery#dataset",
      "labels": {},
      "location": "string"
    }
  ],
  "etag": "string",
  "kind": "bigquery#datasetList",
  "nextPageToken": "string"
}

Need more? See the BigQuery guide for connection setup and behaviour shared by every action.

Was this page helpful?