Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
REST Resource: properties.bigQueryLinks
Stay organized with collections
Save and categorize content based on your preferences.
Resource: BigQueryLink
A link between a Google Analytics property and BigQuery project.
| JSON representation |
{
"name": string,
"project": string,
"createTime": string,
"dailyExportEnabled": boolean,
"streamingExportEnabled": boolean,
"freshDailyExportEnabled": boolean,
"includeAdvertisingId": boolean,
"exportStreams": [
string
],
"excludedEvents": [
string
],
"datasetLocation": string
} |
| Fields |
name |
string
Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
|
project |
string
Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'
|
createTime |
string (Timestamp format)
Output only. Time when the link was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
|
dailyExportEnabled |
boolean
If set true, enables daily data export to the linked Google Cloud project.
|
streamingExportEnabled |
boolean
If set true, enables streaming export to the linked Google Cloud project.
|
freshDailyExportEnabled |
boolean
If set true, enables fresh daily export to the linked Google Cloud project.
|
includeAdvertisingId |
boolean
If set true, exported data will include advertising identifiers for mobile app streams.
|
exportStreams[] |
string
The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: ['properties/1000/dataStreams/2000']
|
excludedEvents[] |
string
The list of event names that will be excluded from exports.
|
datasetLocation |
string
Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
|
Methods |
|
|
Creates a BigQueryLink. |
|
|
Deletes a BigQueryLink on a property. |
|
|
Lookup for a single BigQuery Link. |
|
|
Lists BigQuery Links on a property. |
|
|
Updates a BigQueryLink. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eBigQueryLink connects a Google Analytics 4 property to a BigQuery project for data export.\u003c/p\u003e\n"],["\u003cp\u003eIt supports daily, streaming, and fresh daily exports, with options to include advertising IDs and exclude specific events.\u003c/p\u003e\n"],["\u003cp\u003eData is exported to a BigQuery dataset in a specified geographic location.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage BigQueryLinks using methods to create, delete, get, list, and update them.\u003c/p\u003e\n"]]],["A BigQueryLink connects a Google Analytics property to a BigQuery project. Key actions include creating, deleting, getting, listing, and updating these links. The link configuration includes enabling daily, streaming, and fresh daily exports, specifying which data streams to export, and excluding specific events. It also involves setting the dataset location and deciding whether to include advertising identifiers. The link's name, linked project, and creation time are also tracked.\n"],null,["# REST Resource: properties.bigQueryLinks\n\n- [Resource: BigQueryLink](#BigQueryLink)\n - [JSON representation](#BigQueryLink.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: BigQueryLink\n----------------------\n\nA link between a Google Analytics property and BigQuery project.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"project\": string, \"createTime\": string, \"dailyExportEnabled\": boolean, \"streamingExportEnabled\": boolean, \"freshDailyExportEnabled\": boolean, \"includeAdvertisingId\": boolean, \"exportStreams\": [ string ], \"excludedEvents\": [ string ], \"datasetLocation\": string } ``` |\n\n| Fields ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567' |\n| `project` | `string` Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. Time when the link was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `dailyExportEnabled` | `boolean` If set true, enables daily data export to the linked Google Cloud project. |\n| `streamingExportEnabled` | `boolean` If set true, enables streaming export to the linked Google Cloud project. |\n| `freshDailyExportEnabled` | `boolean` If set true, enables fresh daily export to the linked Google Cloud project. |\n| `includeAdvertisingId` | `boolean` If set true, exported data will include advertising identifiers for mobile app streams. |\n| `exportStreams[]` | `string` The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: \\['properties/1000/dataStreams/2000'\\] |\n| `excludedEvents[]` | `string` The list of event names that will be excluded from exports. |\n| `datasetLocation` | `string` Required. Immutable. The geographic location where the created BigQuery dataset should reside. See \u003chttps://cloud.google.com/bigquery/docs/locations\u003e for supported locations. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------------------|---------------------------------------|\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.bigQueryLinks/create) | Creates a BigQueryLink. |\n| ### [delete](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.bigQueryLinks/delete) | Deletes a BigQueryLink on a property. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.bigQueryLinks/get) | Lookup for a single BigQuery Link. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.bigQueryLinks/list) | Lists BigQuery Links on a property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.bigQueryLinks/patch) | Updates a BigQueryLink. |"]]
