Reference documentation and code samples for the Google Analytics Admin V1alpha Client class BigQueryLink.
A link between a GA4 Property and BigQuery project.
Generated from protobuf message google.analytics.admin.v1alpha.BigQueryLink
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ 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' |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the link was created. |
↳ daily_export_enabled |
bool
If set true, enables daily data export to the linked Google Cloud project. |
↳ streaming_export_enabled |
bool
If set true, enables streaming export to the linked Google Cloud project. |
↳ include_advertising_id |
bool
If set true, exported data will include advertising identifiers for mobile app streams. |
↳ export_streams |
array
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'] |
↳ excluded_events |
array
The list of event names that will be excluded from exports. |
getName
Output only. Resource name of this BigQuery link.
Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of this BigQuery link.
Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProject
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'
| Returns | |
|---|---|
| Type | Description |
string | |
setProject
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'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when the link was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the link was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDailyExportEnabled
If set true, enables daily data export to the linked Google Cloud project.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDailyExportEnabled
If set true, enables daily data export to the linked Google Cloud project.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStreamingExportEnabled
If set true, enables streaming export to the linked Google Cloud project.
| Returns | |
|---|---|
| Type | Description |
bool | |
setStreamingExportEnabled
If set true, enables streaming export to the linked Google Cloud project.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIncludeAdvertisingId
If set true, exported data will include advertising identifiers for mobile app streams.
| Returns | |
|---|---|
| Type | Description |
bool | |
setIncludeAdvertisingId
If set true, exported data will include advertising identifiers for mobile app streams.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExportStreams
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']
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setExportStreams
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']
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExcludedEvents
The list of event names that will be excluded from exports.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setExcludedEvents
The list of event names that will be excluded from exports.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |