Reference documentation and code samples for the Google Ads Data Manager V1 Client class AddressInfo.
Address information for the user.
Generated from protobuf message google.ads.datamanager.v1.AddressInfo
Namespace
Google \ Ads \ DataManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ given_name |
string
Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. |
↳ family_name |
string
Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256. |
↳ region_code |
string
Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address. |
↳ postal_code |
string
Required. The postal code of the user's address. |
↳ address_line |
string
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 |
↳ city |
string
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 |
↳ administrative_area |
string
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 |
getGivenName
Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGivenName
Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFamilyName
Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFamilyName
Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegionCode
Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRegionCode
Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPostalCode
Required. The postal code of the user's address.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPostalCode
Required. The postal code of the user's address.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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
| Returns | |
|---|---|
| Type | Description |
string |
|
setAddressLine
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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
| Returns | |
|---|---|
| Type | Description |
string |
|
setCity
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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
| Returns | |
|---|---|
| Type | Description |
string |
|
setAdministrativeArea
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|