Package com.google.analytics.admin.v1alpha

Interface PropertyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Property, Property.Builder
@Generated public interface PropertyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Identifier. Resource name of this property.
 Format: properties/{property_id}
 Example: "properties/1000"
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Resource name of this property.
 Format: properties/{property_id}
 Example: "properties/1000"
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getPropertyTypeValue

      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.
      .google.analytics.admin.v1alpha.PropertyType property_type = 14 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for propertyType.

    • getPropertyType

      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.
      .google.analytics.admin.v1alpha.PropertyType property_type = 14 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The propertyType.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Time when the entity was originally created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Time when the entity was originally created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time when the entity was originally created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.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:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Time when entity payload fields were last updated.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getParent

      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:
      The parent.

    • getParentBytes

      com.google.protobuf.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:
      The bytes for parent.

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.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:
      The bytes for displayName.

    • getIndustryCategoryValue

      int getIndustryCategoryValue()
       Industry associated with this property
 Example: AUTOMOTIVE, FOOD_AND_DRINK
      .google.analytics.admin.v1alpha.IndustryCategory industry_category = 6;
      Returns:
      The enum numeric value on the wire for industryCategory.

    • getIndustryCategory

      IndustryCategory getIndustryCategory()
       Industry associated with this property
 Example: AUTOMOTIVE, FOOD_AND_DRINK
      .google.analytics.admin.v1alpha.IndustryCategory industry_category = 6;
      Returns:
      The industryCategory.

    • getTimeZone

      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:
      The timeZone.

    • getTimeZoneBytes

      com.google.protobuf.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:
      The bytes for timeZone.

    • getCurrencyCode

      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:
      The currencyCode.

    • getCurrencyCodeBytes

      com.google.protobuf.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:
      The bytes for currencyCode.

    • getServiceLevelValue

      int getServiceLevelValue()
       Output only. The Google Analytics service level that applies to this
 property.
      .google.analytics.admin.v1alpha.ServiceLevel service_level = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for serviceLevel.

    • getServiceLevel

      ServiceLevel getServiceLevel()
       Output only. The Google Analytics service level that applies to this
 property.
      .google.analytics.admin.v1alpha.ServiceLevel service_level = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The serviceLevel.

    • hasDeleteTime

      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:
      Whether the deleteTime field is set.

    • getDeleteTime

      com.google.protobuf.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:
      The deleteTime.

    • getDeleteTimeOrBuilder

      com.google.protobuf.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];

    • hasExpireTime

      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:
      Whether the expireTime field is set.

    • getExpireTime

      com.google.protobuf.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:
      The expireTime.

    • getExpireTimeOrBuilder

      com.google.protobuf.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];

    • getAccount

      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:
      The account.

    • getAccountBytes

      com.google.protobuf.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:
      The bytes for account.