Interface AddressInfoOrBuilder (0.20.0)

public interface AddressInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAddressLine()

public abstract String getAddressLine()

Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted.

Normalize the value before hashing:

  • Remove symbol characters
  • Convert to lowercase
  • Remove leading and trailing whitespace

string address_line = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The addressLine.

getAddressLineBytes()

public abstract ByteString getAddressLineBytes()

Optional. The street and number of the user's address. Used only for Google Analytics. This field is hashed and possibly encrypted.

Normalize the value before hashing:

  • Remove symbol characters
  • Convert to lowercase
  • Remove leading and trailing whitespace

string address_line = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for addressLine.

getAdministrativeArea()

public abstract String getAdministrativeArea()

Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics.

The value should be normalized as such:

  • Remove symbol characters
  • Convert to lowercase
  • Remove leading and trailing whitespace

string administrative_area = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The administrativeArea.

getAdministrativeAreaBytes()

public abstract ByteString getAdministrativeAreaBytes()

Optional. The administrative area (state/province) of the user's address. Used only for Google Analytics.

The value should be normalized as such:

  • Remove symbol characters
  • Convert to lowercase
  • Remove leading and trailing whitespace

string administrative_area = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for administrativeArea.

getCity()

public abstract String getCity()

Optional. The city of the user's address. Used only for Google Analytics.

The value should be normalized as such:

  • Remove symbol characters
  • Convert to lowercase
  • Remove leading and trailing whitespace

string city = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The city.

getCityBytes()

public abstract ByteString getCityBytes()

Optional. The city of the user's address. Used only for Google Analytics.

The value should be normalized as such:

  • Remove symbol characters
  • Convert to lowercase
  • Remove leading and trailing whitespace

string city = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for city.

getFamilyName()

public abstract String getFamilyName()

Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.

string family_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The familyName.

getFamilyNameBytes()

public abstract ByteString getFamilyNameBytes()

Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.

string family_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for familyName.

getGivenName()

public abstract String getGivenName()

Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.

string given_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The givenName.

getGivenNameBytes()

public abstract ByteString getGivenNameBytes()

Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.

string given_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for givenName.

getPostalCode()

public abstract String getPostalCode()

Required. The postal code of the user's address.

string postal_code = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The postalCode.

getPostalCodeBytes()

public abstract ByteString getPostalCodeBytes()

Required. The postal code of the user's address.

string postal_code = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for postalCode.

getRegionCode()

public abstract String getRegionCode()

Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.

string region_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The regionCode.

getRegionCodeBytes()

public abstract ByteString getRegionCodeBytes()

Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.

string region_code = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for regionCode.