Class AddressInfo (0.20.0)

public final class AddressInfo extends GeneratedMessage implements AddressInfoOrBuilder

Address information for the user.

Protobuf type google.ads.datamanager.v1.AddressInfo

Static Fields

ADDRESS_LINE_FIELD_NUMBER

public static final int ADDRESS_LINE_FIELD_NUMBER
Field Value
Type Description
int

ADMINISTRATIVE_AREA_FIELD_NUMBER

public static final int ADMINISTRATIVE_AREA_FIELD_NUMBER
Field Value
Type Description
int

CITY_FIELD_NUMBER

public static final int CITY_FIELD_NUMBER
Field Value
Type Description
int

FAMILY_NAME_FIELD_NUMBER

public static final int FAMILY_NAME_FIELD_NUMBER
Field Value
Type Description
int

GIVEN_NAME_FIELD_NUMBER

public static final int GIVEN_NAME_FIELD_NUMBER
Field Value
Type Description
int

POSTAL_CODE_FIELD_NUMBER

public static final int POSTAL_CODE_FIELD_NUMBER
Field Value
Type Description
int

REGION_CODE_FIELD_NUMBER

public static final int REGION_CODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AddressInfo getDefaultInstance()
Returns
Type Description
AddressInfo

getDescriptor()

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

newBuilder()

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

newBuilder(AddressInfo prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAddressLine()

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

getDefaultInstanceForType()

public AddressInfo getDefaultInstanceForType()
Returns
Type Description
AddressInfo

getFamilyName()

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

getParserForType()

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

getPostalCode()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AddressInfo.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AddressInfo.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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