Google Analytics Admin V1alpha Client - Class WebDataStream (0.24.1)

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

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ measurement_id string

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

↳ firebase_app_id string

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_time Google\Protobuf\Timestamp

Output only. Time when this stream was originally created.

↳ update_time Google\Protobuf\Timestamp

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

↳ default_uri string

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

↳ display_name string

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
Type Description
string

setName

Output only. Resource name of this Data Stream.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getMeasurementId

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

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

Returns
Type Description
string

setMeasurementId

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

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

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Time when this stream was originally created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when this stream was originally created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDefaultUri

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

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

Returns
Type Description
string

setDefaultUri

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

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

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

Returns
Type Description
string

setDisplayName

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

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

Parameter
Name Description
var string
Returns
Type Description
$this