Class AdIdentifiers (0.14.0)

public final class AdIdentifiers extends GeneratedMessage implements AdIdentifiersOrBuilder

Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).

Protobuf type google.ads.datamanager.v1.AdIdentifiers

Static Fields

DCLID_FIELD_NUMBER

public static final int DCLID_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTED_USER_IDS_FIELD_NUMBER

public static final int ENCRYPTED_USER_IDS_FIELD_NUMBER
Field Value
Type Description
int

GBRAID_FIELD_NUMBER

public static final int GBRAID_FIELD_NUMBER
Field Value
Type Description
int

GCLID_FIELD_NUMBER

public static final int GCLID_FIELD_NUMBER
Field Value
Type Description
int

IMPRESSION_ID_FIELD_NUMBER

public static final int IMPRESSION_ID_FIELD_NUMBER
Field Value
Type Description
int

LANDING_PAGE_DEVICE_INFO_FIELD_NUMBER

public static final int LANDING_PAGE_DEVICE_INFO_FIELD_NUMBER
Field Value
Type Description
int

MATCH_ID_FIELD_NUMBER

public static final int MATCH_ID_FIELD_NUMBER
Field Value
Type Description
int

MOBILE_DEVICE_ID_FIELD_NUMBER

public static final int MOBILE_DEVICE_ID_FIELD_NUMBER
Field Value
Type Description
int

SESSION_ATTRIBUTES_FIELD_NUMBER

public static final int SESSION_ATTRIBUTES_FIELD_NUMBER
Field Value
Type Description
int

WBRAID_FIELD_NUMBER

public static final int WBRAID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AdIdentifiers getDefaultInstance()
Returns
Type Description
AdIdentifiers

getDescriptor()

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

newBuilder()

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

newBuilder(AdIdentifiers prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDclid()

public String getDclid()

Optional. The display click ID associated with this event.

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

Returns
Type Description
String

The dclid.

getDclidBytes()

public ByteString getDclidBytes()

Optional. The display click ID associated with this event.

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

Returns
Type Description
ByteString

The bytes for dclid.

getDefaultInstanceForType()

public AdIdentifiers getDefaultInstanceForType()
Returns
Type Description
AdIdentifiers

getEncryptedUserIds(int index)

public EncryptedUserId getEncryptedUserIds(int index)

Optional. Any number of encrypted user IDs.

repeated .google.ads.datamanager.v1.EncryptedUserId encrypted_user_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
EncryptedUserId

getEncryptedUserIdsCount()

public int getEncryptedUserIdsCount()

Optional. Any number of encrypted user IDs.

repeated .google.ads.datamanager.v1.EncryptedUserId encrypted_user_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEncryptedUserIdsList()

public List<EncryptedUserId> getEncryptedUserIdsList()

Optional. Any number of encrypted user IDs.

repeated .google.ads.datamanager.v1.EncryptedUserId encrypted_user_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<EncryptedUserId>

getEncryptedUserIdsOrBuilder(int index)

public EncryptedUserIdOrBuilder getEncryptedUserIdsOrBuilder(int index)

Optional. Any number of encrypted user IDs.

repeated .google.ads.datamanager.v1.EncryptedUserId encrypted_user_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
EncryptedUserIdOrBuilder

getEncryptedUserIdsOrBuilderList()

public List<? extends EncryptedUserIdOrBuilder> getEncryptedUserIdsOrBuilderList()

Optional. Any number of encrypted user IDs.

repeated .google.ads.datamanager.v1.EncryptedUserId encrypted_user_ids = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.ads.datamanager.v1.EncryptedUserIdOrBuilder>

getGbraid()

public String getGbraid()

Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.

string gbraid = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The gbraid.

getGbraidBytes()

public ByteString getGbraidBytes()

Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.

string gbraid = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for gbraid.

getGclid()

public String getGclid()

Optional. The Google click ID (gclid) associated with this event.

string gclid = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The gclid.

getGclidBytes()

public ByteString getGclidBytes()

Optional. The Google click ID (gclid) associated with this event.

string gclid = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for gclid.

getImpressionId()

public String getImpressionId()

Optional. The impression ID associated with this event.

string impression_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The impressionId.

getImpressionIdBytes()

public ByteString getImpressionIdBytes()

Optional. The impression ID associated with this event.

string impression_id = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for impressionId.

getLandingPageDeviceInfo()

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

.google.ads.datamanager.v1.DeviceInfo landing_page_device_info = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeviceInfo

The landingPageDeviceInfo.

getLandingPageDeviceInfoOrBuilder()

public DeviceInfoOrBuilder getLandingPageDeviceInfoOrBuilder()

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.

.google.ads.datamanager.v1.DeviceInfo landing_page_device_info = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeviceInfoOrBuilder

getMatchId()

public String getMatchId()

Optional. The match ID field used to join this event with a previous event.

string match_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The matchId.

getMatchIdBytes()

public ByteString getMatchIdBytes()

Optional. The match ID field used to join this event with a previous event.

string match_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for matchId.

getMobileDeviceId()

public String getMobileDeviceId()

Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers.

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

Returns
Type Description
String

The mobileDeviceId.

getMobileDeviceIdBytes()

public ByteString getMobileDeviceIdBytes()

Optional. The mobile identifier for advertisers. This would be IDFA on iOS, AdID on Android, or other platforms’ identifiers for advertisers.

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

Returns
Type Description
ByteString

The bytes for mobileDeviceId.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionAttributes()

public String getSessionAttributes()

Optional. Session attributes for event attribution and modeling.

string session_attributes = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sessionAttributes.

getSessionAttributesBytes()

public ByteString getSessionAttributesBytes()

Optional. Session attributes for event attribution and modeling.

string session_attributes = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sessionAttributes.

getWbraid()

public String getWbraid()

Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.

string wbraid = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The wbraid.

getWbraidBytes()

public ByteString getWbraidBytes()

Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.

string wbraid = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for wbraid.

hasLandingPageDeviceInfo()

public boolean hasLandingPageDeviceInfo()

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.

.google.ads.datamanager.v1.DeviceInfo landing_page_device_info = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the landingPageDeviceInfo field is set.

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 AdIdentifiers.Builder newBuilderForType()
Returns
Type Description
AdIdentifiers.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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