Google Analytics Admin V1alpha Client - Class WebDataStream (0.10.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class WebDataStream.

A resource message representing a Google Analytics web stream.

Generated from protobuf message google.analytics.admin.v1alpha.WebDataStream

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ namestring

Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"

↳ measurement_idstring

Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"

↳ firebase_app_idstring

Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.

↳ create_timeGoogle\Protobuf\Timestamp

Output only. Time when this stream was originally created.

↳ update_timeGoogle\Protobuf\Timestamp

Output only. Time when stream payload fields were last updated.

↳ default_uristring

Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"

↳ display_namestring

Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.

getName

Output only. Resource name of this Data Stream.

Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"

Returns
TypeDescription
string

setName

Output only. Resource name of this Data Stream.

Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getMeasurementId

Output only. Analytics "Measurement ID", without the "G-" prefix.

Example: "G-1A2BCD345E" would just be "1A2BCD345E"

Returns
TypeDescription
string

setMeasurementId

Output only. Analytics "Measurement ID", without the "G-" prefix.

Example: "G-1A2BCD345E" would just be "1A2BCD345E"

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getFirebaseAppId

Output only. ID of the corresponding web app in Firebase, if any.

This ID can change if the web app is deleted and recreated.

Returns
TypeDescription
string

setFirebaseAppId

Output only. ID of the corresponding web app in Firebase, if any.

This ID can change if the web app is deleted and recreated.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getCreateTime

Output only. Time when this stream was originally created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when this stream was originally created.

Parameter
NameDescription
varGoogle\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Time when stream payload fields were last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time when stream payload fields were last updated.

Parameter
NameDescription
varGoogle\Protobuf\Timestamp
Returns
TypeDescription
$this

getDefaultUri

Immutable. Domain name of the web app being measured, or empty.

Example: "http://www.google.com", "https://www.google.com"

Returns
TypeDescription
string

setDefaultUri

Immutable. Domain name of the web app being measured, or empty.

Example: "http://www.google.com", "https://www.google.com"

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getDisplayName

Required. Human-readable display name for the Data Stream.

The max allowed display name length is 255 UTF-16 code units.

Returns
TypeDescription
string

setDisplayName

Required. Human-readable display name for the Data Stream.

The max allowed display name length is 255 UTF-16 code units.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this