Interface PropertyOrBuilder (0.55.0)

public interface PropertyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccount()

public abstract String getAccount()

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

string account = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The account.

getAccountBytes()

public abstract ByteString getAccountBytes()

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

string account = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for account.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time when the entity was originally created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the entity was originally created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCurrencyCode()

public abstract String getCurrencyCode()

The currency type used in reports involving monetary values.

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

string currency_code = 8;

Returns
Type Description
String

The currencyCode.

getCurrencyCodeBytes()

public abstract ByteString getCurrencyCodeBytes()

The currency type used in reports involving monetary values.

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

string currency_code = 8;

Returns
Type Description
ByteString

The bytes for currencyCode.

getDeleteTime()

public abstract Timestamp 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.

.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

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.

.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

Required. Human-readable display name for this property.

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

string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. Human-readable display name for this property.

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

string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getExpireTime()

public abstract Timestamp 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.

.google.protobuf.Timestamp expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

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.

.google.protobuf.Timestamp expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getIndustryCategory()

public abstract IndustryCategory getIndustryCategory()

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

.google.analytics.admin.v1beta.IndustryCategory industry_category = 6;

Returns
Type Description
IndustryCategory

The industryCategory.

getIndustryCategoryValue()

public abstract int getIndustryCategoryValue()

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

.google.analytics.admin.v1beta.IndustryCategory industry_category = 6;

Returns
Type Description
int

The enum numeric value on the wire for industryCategory.

getName()

public abstract String getName()

Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParent()

public abstract String 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"

string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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"

string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for parent.

getPropertyType()

public abstract PropertyType 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. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created with the Google Analytics Admin API.

.google.analytics.admin.v1beta.PropertyType property_type = 14 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
PropertyType

The propertyType.

getPropertyTypeValue()

public abstract int getPropertyTypeValue()

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. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created with the Google Analytics Admin API.

.google.analytics.admin.v1beta.PropertyType property_type = 14 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for propertyType.

getServiceLevel()

public abstract ServiceLevel getServiceLevel()

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

.google.analytics.admin.v1beta.ServiceLevel service_level = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ServiceLevel

The serviceLevel.

getServiceLevelValue()

public abstract int getServiceLevelValue()

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

.google.analytics.admin.v1beta.ServiceLevel service_level = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for serviceLevel.

getTimeZone()

public abstract String 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"

string time_zone = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

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"

string time_zone = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for timeZone.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time when the entity was originally created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public abstract boolean hasDeleteTime()

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.

.google.protobuf.Timestamp delete_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasExpireTime()

public abstract boolean hasExpireTime()

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.

.google.protobuf.Timestamp expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expireTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.