Reference documentation and code samples for the Google Ads Data Manager V1 Client class AdIdentifiers.
Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
Generated from protobuf message google.ads.datamanager.v1.AdIdentifiers
Namespace
Google \ Ads \ DataManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ session_attributes |
string
Optional. Session attributes for event attribution and modeling. |
↳ gclid |
string
Optional. The Google click ID (gclid) associated with this event. |
↳ gbraid |
string
Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14. |
↳ wbraid |
string
Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14. |
↳ landing_page_device_info |
DeviceInfo
Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad. |
↳ mobile_device_id |
string
Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers. |
↳ dclid |
string
Optional. The display click ID associated with this event. |
↳ impression_id |
string
Optional. The impression ID associated with this event. |
↳ match_id |
string
Optional. The match ID field used to join this event with a previous event. |
↳ encrypted_user_ids |
array<EncryptedUserId>
Optional. Any number of encrypted user IDs. |
getSessionAttributes
Optional. Session attributes for event attribution and modeling.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSessionAttributes
Optional. Session attributes for event attribution and modeling.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGclid
Optional. The Google click ID (gclid) associated with this event.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGclid
Optional. The Google click ID (gclid) associated with this event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGbraid
Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGbraid
Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWbraid
Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.
| Returns | |
|---|---|
| Type | Description |
string |
|
setWbraid
Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLandingPageDeviceInfo
Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad.
| Returns | |
|---|---|
| Type | Description |
DeviceInfo|null |
|
hasLandingPageDeviceInfo
clearLandingPageDeviceInfo
setLandingPageDeviceInfo
Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad.
| Parameter | |
|---|---|
| Name | Description |
var |
DeviceInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMobileDeviceId
Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMobileDeviceId
Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDclid
Optional. The display click ID associated with this event.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDclid
Optional. The display click ID associated with this event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getImpressionId
Optional. The impression ID associated with this event.
| Returns | |
|---|---|
| Type | Description |
string |
|
setImpressionId
Optional. The impression ID associated with this event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMatchId
Optional. The match ID field used to join this event with a previous event.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMatchId
Optional. The match ID field used to join this event with a previous event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptedUserIds
Optional. Any number of encrypted user IDs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<EncryptedUserId> |
|
setEncryptedUserIds
Optional. Any number of encrypted user IDs.
| Parameter | |
|---|---|
| Name | Description |
var |
array<EncryptedUserId>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|