Google Analytics Admin V1alpha Client - Class Property (0.29.1)

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

A resource message representing a Google Analytics property.

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

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 property. Format: properties/{property_id} Example: "properties/1000"

↳ property_type
int

Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied.

↳ create_time
Google\Protobuf\Timestamp

Output only. Time when the entity was originally created.

↳ update_time
Google\Protobuf\Timestamp

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

↳ parent
string

Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"

↳ display_name
string

Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.

↳ industry_category
int

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

↳ time_zone
string

Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"

↳ currency_code
string

The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"

↳ service_level
int

Output only. The Google Analytics service level that applies to this property.

↳ delete_time
Google\Protobuf\Timestamp

Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.

↳ expire_time
Google\Protobuf\Timestamp

Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.

↳ account
string

Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"

getName

Output only. Resource name of this property.

Format: properties/{property_id} Example: "properties/1000"

Returns
Type
Description
string

setName

Output only. Resource name of this property.

Format: properties/{property_id} Example: "properties/1000"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPropertyType

Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied.

Returns
Type
Description
int

setPropertyType

Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getCreateTime

Output only. Time when the entity was originally created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when the entity was originally created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

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

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name
Description
Returns
Type
Description
$this

getParent

Immutable. Resource name of this property's logical parent.

Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"

Returns
Type
Description
string

setParent

Immutable. Resource name of this property's logical parent.

Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Required. Human-readable display name for this property.

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

Returns
Type
Description
string

setDisplayName

Required. Human-readable display name for this property.

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getIndustryCategory

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

Returns
Type
Description
int

setIndustryCategory

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getTimeZone

Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes.

NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"

Returns
Type
Description
string

setTimeZone

Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes.

NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCurrencyCode

The currency type used in reports involving monetary values.

Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"

Returns
Type
Description
string

setCurrencyCode

The currency type used in reports involving monetary values.

Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getServiceLevel

Output only. The Google Analytics service level that applies to this property.

Returns
Type
Description
int

setServiceLevel

Output only. The Google Analytics service level that applies to this property.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getDeleteTime

Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.

Returns
Type
Description

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.

Parameter
Name
Description
Returns
Type
Description
$this

getExpireTime

Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.

Returns
Type
Description

hasExpireTime

clearExpireTime

setExpireTime

Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.

Parameter
Name
Description
Returns
Type
Description
$this

getAccount

Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"

Returns
Type
Description
string

setAccount

Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: