BigQuery Data Transfer API
Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.
- REST Resource: v1.projects
- REST Resource: v1.projects.dataSources
- REST Resource: v1.projects.locations
- REST Resource: v1.projects.locations.dataSources
- REST Resource: v1.projects.locations.transferConfigs
- REST Resource: v1.projects.locations.transferConfigs.runs
- REST Resource: v1.projects.locations.transferConfigs.runs.transferLogs
- REST Resource: v1.projects.transferConfigs
- REST Resource: v1.projects.transferConfigs.runs
- REST Resource: v1.projects.transferConfigs.runs.transferLogs
Service: bigquerydatatransfer.googleapis.com
To call this service, we recommend that you use the Google-providedclient libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
ADiscovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
Aservice endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://bigquerydatatransfer.googleapis.com
REST Resource:v1.projects
| Methods | |
|---|---|
enrollDataSources | POST /v1/{name=projects/*}:enrollDataSourcesEnroll data sources in a user project. |
REST Resource:v1.projects.dataSources
| Methods | |
|---|---|
checkValidCreds | POST /v1/{name=projects/*/dataSources/*}:checkValidCredsReturns true if valid credentials exist for the given data source and requesting user. |
get | GET /v1/{name=projects/*/dataSources/*}Retrieves a supported data source and returns its settings. |
list | GET /v1/{parent=projects/*}/dataSourcesLists supported data sources and returns their settings. |
REST Resource:v1.projects.locations
| Methods | |
|---|---|
enrollDataSources | POST /v1/{name=projects/*/locations/*}:enrollDataSourcesEnroll data sources in a user project. |
get | GET /v1/{name=projects/*/locations/*}Gets information about a location. |
list | GET /v1/{name=projects/*}/locationsLists information about the supported locations for this service. |
unenrollDataSources | POST /v1/{name=projects/*/locations/*}:unenrollDataSourcesUnenroll data sources in a user project. |
REST Resource:v1.projects.locations.dataSources
| Methods | |
|---|---|
checkValidCreds | POST /v1/{name=projects/*/locations/*/dataSources/*}:checkValidCredsReturns true if valid credentials exist for the given data source and requesting user. |
get | GET /v1/{name=projects/*/locations/*/dataSources/*}Retrieves a supported data source and returns its settings. |
list | GET /v1/{parent=projects/*/locations/*}/dataSourcesLists supported data sources and returns their settings. |
REST Resource:v1.projects.locations.transferConfigs
| Methods | |
|---|---|
create | POST /v1/{parent=projects/*/locations/*}/transferConfigsCreates a new data transfer configuration. |
delete | DELETE /v1/{name=projects/*/locations/*/transferConfigs/*}Deletes a data transfer configuration, including any associated transfer runs and logs. |
get | GET /v1/{name=projects/*/locations/*/transferConfigs/*}Returns information about a data transfer config. |
list | GET /v1/{parent=projects/*/locations/*}/transferConfigsReturns information about all transfer configs owned by a project in the specified location. |
patch | PATCH /v1/{transferConfig.name=projects/*/locations/*/transferConfigs/*}Updates a data transfer configuration. |
scheduleRuns | POST /v1/{parent=projects/*/locations/*/transferConfigs/*}:scheduleRunsCreates transfer runs for a time range [start_time, end_time]. |
startManualRuns | POST /v1/{parent=projects/*/locations/*/transferConfigs/*}:startManualRunsManually initiates transfer runs. |
REST Resource:v1.projects.locations.transferConfigs.runs
| Methods | |
|---|---|
delete | DELETE /v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}Deletes the specified transfer run. |
get | GET /v1/{name=projects/*/locations/*/transferConfigs/*/runs/*}Returns information about the particular transfer run. |
list | GET /v1/{parent=projects/*/locations/*/transferConfigs/*}/runsReturns information about running and completed transfer runs. |
REST Resource:v1.projects.locations.transferConfigs.runs.transferLogs
| Methods | |
|---|---|
list | GET /v1/{parent=projects/*/locations/*/transferConfigs/*/runs/*}/transferLogsReturns log messages for the transfer run. |
REST Resource:v1.projects.transferConfigs
| Methods | |
|---|---|
create | POST /v1/{parent=projects/*}/transferConfigsCreates a new data transfer configuration. |
delete | DELETE /v1/{name=projects/*/transferConfigs/*}Deletes a data transfer configuration, including any associated transfer runs and logs. |
get | GET /v1/{name=projects/*/transferConfigs/*}Returns information about a data transfer config. |
list | GET /v1/{parent=projects/*}/transferConfigsReturns information about all transfer configs owned by a project in the specified location. |
patch | PATCH /v1/{transferConfig.name=projects/*/transferConfigs/*}Updates a data transfer configuration. |
scheduleRuns | POST /v1/{parent=projects/*/transferConfigs/*}:scheduleRunsCreates transfer runs for a time range [start_time, end_time]. |
startManualRuns | POST /v1/{parent=projects/*/transferConfigs/*}:startManualRunsManually initiates transfer runs. |
REST Resource:v1.projects.transferConfigs.runs
| Methods | |
|---|---|
delete | DELETE /v1/{name=projects/*/transferConfigs/*/runs/*}Deletes the specified transfer run. |
get | GET /v1/{name=projects/*/transferConfigs/*/runs/*}Returns information about the particular transfer run. |
list | GET /v1/{parent=projects/*/transferConfigs/*}/runsReturns information about running and completed transfer runs. |
REST Resource:v1.projects.transferConfigs.runs.transferLogs
| Methods | |
|---|---|
list | GET /v1/{parent=projects/*/transferConfigs/*/runs/*}/transferLogsReturns log messages for the transfer run. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-02 UTC.