Google

BigQuery Data Transfer API

Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.

Data & analytics#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.

Endpoints 15

projects.locations

  • POSTEnroll data sources in a user project/v1/:name:enrollDataSourcesEnroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the…
  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
  • POSTUnenroll data sources in a user project/v1/:name:unenrollDataSourcesUnenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the…

projects.locations.dataSources

  • POSTReturns true if valid credentials exist for the given data source and requesting user./v1/:name:checkValidCredsReturns true if valid credentials exist for the given data source and requesting user.
  • GETLists supported data sources and returns their settings./v1/:parent/dataSources?pageSize=0&pageToken=stringLists supported data sources and returns their settings.

projects.transferConfigs.transferResources

  • GETReturns a transfer resource./v1/:nameReturns a transfer resource.
  • GETReturns information about transfer resources./v1/:parent/transferResources?filter=string&pageSize=0&pageToken=stringReturns information about transfer resources.

projects.transferConfigs.runs

  • DELETEDeletes the specified transfer run./v1/:nameDeletes the specified transfer run.
  • GETReturns information about running and completed transfer runs./v1/:parent/runs?pageSize=0&pageToken=string&runAttempt=RUN_ATTEMPT_UNSPECIFIED&states=TRANSFER_STATE_UNSPECIFIEDReturns information about running and completed transfer runs.

projects.transferConfigs

  • PATCHUpdates a data transfer configuration/v1/:name?authorizationCode=string&serviceAccountName=string&updateMask=string&versionInfo=stringUpdates a data transfer configuration. All fields must be set, even if they are not updated.
  • GETReturns information about all transfer configs owned by a project in the specified location./v1/:parent/transferConfigs?dataSourceIds=string&pageSize=0&pageToken=stringReturns information about all transfer configs owned by a project in the specified location.
  • POSTCreates a new data transfer configuration./v1/:parent/transferConfigs?authorizationCode=string&serviceAccountName=string&versionInfo=stringCreates a new data transfer configuration.
  • POSTCreates transfer runs for a time range [start_time, end_time]/v1/:parent:scheduleRunsCreates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer…
  • POSTManually initiates transfer runs/v1/:parent:startManualRunsManually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a…

projects.transferConfigs.runs.transferLogs

  • GETReturns log messages for the transfer run./v1/:parent/transferLogs?messageTypes=MESSAGE_SEVERITY_UNSPECIFIED&pageSize=0&pageToken=stringReturns log messages for the transfer run.

API details

Base URL
https://bigquerydatatransfer.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the key query parameter
Operations
15 operations on 12 pathsGET 7POST 6PATCH 1DELETE 1
Main resources
projects.transferConfigs 5projects.locations 3projects.locations.dataSources 2projects.transferConfigs.runs 2projects.transferConfigs.transferResources 2projects.transferConfigs.runs.transferLogs 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the BigQuery Data Transfer API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the BigQuery Data Transfer API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Enroll data sources in a user project” (POST /v1/:name:enrollDataSources), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the BigQuery Data Transfer API?

Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis. It is listed under Data & analytics and has 15 endpoints.

Who publishes the BigQuery Data Transfer API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the BigQuery Data Transfer API?

Requests go to https://bigquerydatatransfer.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the BigQuery Data Transfer API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the key query parameter.

How many endpoints does the BigQuery Data Transfer API have?

15 operations on 12 paths (7 GET, 6 POST, 1 PATCH, 1 DELETE). The largest groups are projects.transferConfigs, projects.locations, projects.locations.dataSources, projects.transferConfigs.runs.

Is forking the BigQuery Data Transfer API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.