Class Property (0.56.0)

public final class Property extends GeneratedMessageV3 implements PropertyOrBuilder

A resource message representing a Google Analytics GA4 property.

Protobuf type google.analytics.admin.v1beta.Property

Implements

PropertyOrBuilder

Static Fields

ACCOUNT_FIELD_NUMBER

public static final int ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CURRENCY_CODE_FIELD_NUMBER

public static final int CURRENCY_CODE_FIELD_NUMBER
Field Value
Type Description
int

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

INDUSTRY_CATEGORY_FIELD_NUMBER

public static final int INDUSTRY_CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_TYPE_FIELD_NUMBER

public static final int PROPERTY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_LEVEL_FIELD_NUMBER

public static final int SERVICE_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Property getDefaultInstance()
Returns
Type Description
Property

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Property.Builder newBuilder()
Returns
Type Description
Property.Builder

newBuilder(Property prototype)

public static Property.Builder newBuilder(Property prototype)
Parameter
Name Description
prototype Property
Returns
Type Description
Property.Builder

parseDelimitedFrom(InputStream input)

public static Property parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Property
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Property parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Property
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Property parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Property
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Property
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Property parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Property
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Property
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Property parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Property
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Property
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Property parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Property
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Property
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Property parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Property
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Property parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Property
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Property> parser()
Returns
Type Description
Parser<Property>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccount()

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

getDefaultInstanceForType()

public Property getDefaultInstanceForType()
Returns
Type Description
Property

getDeleteTime()

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

getParserForType()

public Parser<Property> getParserForType()
Returns
Type Description
Parser<Property>
Overrides

getPropertyType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceLevel()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Property.Builder newBuilderForType()
Returns
Type Description
Property.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Property.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Property.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Property.Builder toBuilder()
Returns
Type Description
Property.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException