Interface AdEventOrBuilder (0.16.0)

0.16.0 (latest) 0.15.0 0.14.0 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface AdEventOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdFormat()

public abstract AdFormat getAdFormat()

Enum value for ad format.

.google.ads.datamanager.v1.AdFormat ad_format = 16;

Returns
Type	Description
AdFormat	The adFormat.

getAdFormatOneofCase()

public abstract AdEvent.AdFormatOneofCase getAdFormatOneofCase()

Returns
Type	Description
AdEvent.AdFormatOneofCase

getAdFormatString()

public abstract String getAdFormatString()

String value for ad format.

string ad_format_string = 17;

Returns
Type	Description
String	The adFormatString.

getAdFormatStringBytes()

public abstract ByteString getAdFormatStringBytes()

String value for ad format.

string ad_format_string = 17;

Returns
Type	Description
ByteString	The bytes for adFormatString.

getAdFormatValue()

public abstract int getAdFormatValue()

Enum value for ad format.

.google.ads.datamanager.v1.AdFormat ad_format = 16;

Returns
Type	Description
int	The enum numeric value on the wire for adFormat.

getAdGroupId()

public abstract String getAdGroupId()

Optional. The ID of the associated ad group.

string ad_group_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The adGroupId.

getAdGroupIdBytes()

public abstract ByteString getAdGroupIdBytes()

Optional. The ID of the associated ad group.

string ad_group_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for adGroupId.

getAdHeight()

public abstract int getAdHeight()

Optional. The height of the ad in pixels.

int32 ad_height = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The adHeight.

getAdId()

public abstract String getAdId()

Optional. The ID of the associated ad within the group.

string ad_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The adId.

getAdIdBytes()

public abstract ByteString getAdIdBytes()

Optional. The ID of the associated ad within the group.

string ad_id = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for adId.

getAdPlacement()

public abstract AdPlacement getAdPlacement()

Enum value for ad placement.

.google.ads.datamanager.v1.AdPlacement ad_placement = 18;

Returns
Type	Description
AdPlacement	The adPlacement.

getAdPlacementOneofCase()

public abstract AdEvent.AdPlacementOneofCase getAdPlacementOneofCase()

Returns
Type	Description
AdEvent.AdPlacementOneofCase

getAdPlacementString()

public abstract String getAdPlacementString()

String value for ad placement.

string ad_placement_string = 19;

Returns
Type	Description
String	The adPlacementString.

getAdPlacementStringBytes()

public abstract ByteString getAdPlacementStringBytes()

String value for ad placement.

string ad_placement_string = 19;

Returns
Type	Description
ByteString	The bytes for adPlacementString.

getAdPlacementValue()

public abstract int getAdPlacementValue()

Enum value for ad placement.

.google.ads.datamanager.v1.AdPlacement ad_placement = 18;

Returns
Type	Description
int	The enum numeric value on the wire for adPlacement.

getAdType()

public abstract AdType getAdType()

Enum value for ad type.

.google.ads.datamanager.v1.AdType ad_type = 14;

Returns
Type	Description
AdType	The adType.

getAdTypeOneofCase()

public abstract AdEvent.AdTypeOneofCase getAdTypeOneofCase()

Returns
Type	Description
AdEvent.AdTypeOneofCase

getAdTypeString()

public abstract String getAdTypeString()

String value for ad type.

string ad_type_string = 15;

Returns
Type	Description
String	The adTypeString.

getAdTypeStringBytes()

public abstract ByteString getAdTypeStringBytes()

String value for ad type.

string ad_type_string = 15;

Returns
Type	Description
ByteString	The bytes for adTypeString.

getAdTypeValue()

public abstract int getAdTypeValue()

Enum value for ad type.

.google.ads.datamanager.v1.AdType ad_type = 14;

Returns
Type	Description
int	The enum numeric value on the wire for adType.

getAdWidth()

public abstract int getAdWidth()

Optional. The width of the ad in pixels.

int32 ad_width = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The adWidth.

getAdvertiserId()

public abstract String getAdvertiserId()

Required. The ID of the advertiser for the ad event.

This must match the ID sent in the linking flow.

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

Returns
Type	Description
String	The advertiserId.

getAdvertiserIdBytes()

public abstract ByteString getAdvertiserIdBytes()

Required. The ID of the advertiser for the ad event.

This must match the ID sent in the linking flow.

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

Returns
Type	Description
ByteString	The bytes for advertiserId.

getAttributionHint()

public abstract AttributionHint getAttributionHint()

Optional. The partner-assumed attribution status for this ad event.

This acts only as a signal for how the partner assumed attribution played out, and does not force an end result in final reports.

.google.ads.datamanager.v1.AttributionHint attribution_hint = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AttributionHint	The attributionHint.

getAttributionHintValue()

public abstract int getAttributionHintValue()

Optional. The partner-assumed attribution status for this ad event.

This acts only as a signal for how the partner assumed attribution played out, and does not force an end result in final reports.

.google.ads.datamanager.v1.AttributionHint attribution_hint = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for attributionHint.

getCampaignId()

public abstract String getCampaignId()

Required. The ID of the associated campaign.

string campaign_id = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The campaignId.

getCampaignIdBytes()

public abstract ByteString getCampaignIdBytes()

Required. The ID of the associated campaign.

string campaign_id = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for campaignId.

getCampaignName()

public abstract String getCampaignName()

Required. The name of the associated campaign.

string campaign_name = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The campaignName.

getCampaignNameBytes()

public abstract ByteString getCampaignNameBytes()

Required. The name of the associated campaign.

string campaign_name = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for campaignName.

getDeviceInfo()

public abstract DeviceInfo getDeviceInfo()

Optional. Information gathered about the device being used when the ad event happened.

.google.ads.datamanager.v1.DeviceInfo device_info = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DeviceInfo	The deviceInfo.

getDeviceInfoOrBuilder()

public abstract DeviceInfoOrBuilder getDeviceInfoOrBuilder()

Optional. Information gathered about the device being used when the ad event happened.

.google.ads.datamanager.v1.DeviceInfo device_info = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DeviceInfoOrBuilder

getEventId()

public abstract String getEventId()

Optional. An ID created and managed by the caller that uniquely identifies this event.

Required if you want to deduplicate ad events that are included in multiple requests. Otherwise, this field is optional.

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

Returns
Type	Description
String	The eventId.

getEventIdBytes()

public abstract ByteString getEventIdBytes()

Optional. An ID created and managed by the caller that uniquely identifies this event.

Required if you want to deduplicate ad events that are included in multiple requests. Otherwise, this field is optional.

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

Returns
Type	Description
ByteString	The bytes for eventId.

getEventSubtype()

public abstract AdEvent.EventSubtype getEventSubtype()

Enum value for event subtype.

.google.ads.datamanager.v1.AdEvent.EventSubtype event_subtype = 3;

Returns
Type	Description
AdEvent.EventSubtype	The eventSubtype.

getEventSubtypeOneofCase()

public abstract AdEvent.EventSubtypeOneofCase getEventSubtypeOneofCase()

Returns
Type	Description
AdEvent.EventSubtypeOneofCase

getEventSubtypeString()

public abstract String getEventSubtypeString()

String value for event subtype.

string event_subtype_string = 4;

Returns
Type	Description
String	The eventSubtypeString.

getEventSubtypeStringBytes()

public abstract ByteString getEventSubtypeStringBytes()

String value for event subtype.

string event_subtype_string = 4;

Returns
Type	Description
ByteString	The bytes for eventSubtypeString.

getEventSubtypeValue()

public abstract int getEventSubtypeValue()

Enum value for event subtype.

.google.ads.datamanager.v1.AdEvent.EventSubtype event_subtype = 3;

Returns
Type	Description
int	The enum numeric value on the wire for eventSubtype.

getEventType()

public abstract AdEvent.EventType getEventType()

Required. The type of the event.

.google.ads.datamanager.v1.AdEvent.EventType event_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AdEvent.EventType	The eventType.

getEventTypeValue()

public abstract int getEventTypeValue()

Required. The type of the event.

.google.ads.datamanager.v1.AdEvent.EventType event_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for eventType.

getMeasurementAllowed()

public abstract boolean getMeasurementAllowed()

Optional. Represents if the row is allowed to be used for measurement purposes, as governed by applicable privacy laws within regional jurisdiction.

optional bool measurement_allowed = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The measurementAllowed.

getMedium()

public abstract String getMedium()

Required. The medium of the ad, akin to the Google Analytics medium.

string medium = 24 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The medium.

getMediumBytes()

public abstract ByteString getMediumBytes()

Required. The medium of the ad, akin to the Google Analytics medium.

string medium = 24 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for medium.

getMobileDeviceId()

public abstract String getMobileDeviceId()

Optional. The device ID of the device that the ad was served to.

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

Returns
Type	Description
String	The mobileDeviceId.

getMobileDeviceIdBytes()

public abstract ByteString getMobileDeviceIdBytes()

Optional. The device ID of the device that the ad was served to.

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

Returns
Type	Description
ByteString	The bytes for mobileDeviceId.

getPlatform()

public abstract Platform getPlatform()

Enum value for platform.

.google.ads.datamanager.v1.Platform platform = 29;

Returns
Type	Description
Platform	The platform.

getPlatformOneofCase()

public abstract AdEvent.PlatformOneofCase getPlatformOneofCase()

Returns
Type	Description
AdEvent.PlatformOneofCase

getPlatformString()

public abstract String getPlatformString()

String value for platform.

string platform_string = 30;

Returns
Type	Description
String	The platformString.

getPlatformStringBytes()

public abstract ByteString getPlatformStringBytes()

String value for platform.

string platform_string = 30;

Returns
Type	Description
ByteString	The bytes for platformString.

getPlatformType()

public abstract PlatformType getPlatformType()

Enum value for platform type.

.google.ads.datamanager.v1.PlatformType platform_type = 27;

Returns
Type	Description
PlatformType	The platformType.

getPlatformTypeOneofCase()

public abstract AdEvent.PlatformTypeOneofCase getPlatformTypeOneofCase()

Returns
Type	Description
AdEvent.PlatformTypeOneofCase

getPlatformTypeString()

public abstract String getPlatformTypeString()

String value for platform type.

string platform_type_string = 28;

Returns
Type	Description
String	The platformTypeString.

getPlatformTypeStringBytes()

public abstract ByteString getPlatformTypeStringBytes()

String value for platform type.

string platform_type_string = 28;

Returns
Type	Description
ByteString	The bytes for platformTypeString.

getPlatformTypeValue()

public abstract int getPlatformTypeValue()

Enum value for platform type.

.google.ads.datamanager.v1.PlatformType platform_type = 27;

Returns
Type	Description
int	The enum numeric value on the wire for platformType.

getPlatformValue()

public abstract int getPlatformValue()

Enum value for platform.

.google.ads.datamanager.v1.Platform platform = 29;

Returns
Type	Description
int	The enum numeric value on the wire for platform.

getRegionCode()

public abstract String getRegionCode()

Required. The ISO 3166-2 country plus subdivision.

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

Returns
Type	Description
String	The regionCode.

getRegionCodeBytes()

public abstract ByteString getRegionCodeBytes()

Required. The ISO 3166-2 country plus subdivision.

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

Returns
Type	Description
ByteString	The bytes for regionCode.

getSource()

public abstract String getSource()

Required. The platform source of the ad, akin to the Google Analytics source.

string source = 23 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The source.

getSourceBytes()

public abstract ByteString getSourceBytes()

Required. The platform source of the ad, akin to the Google Analytics source.

string source = 23 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for source.

getTargetingType()

public abstract TargetingType getTargetingType()

Enum value for targeting type.

.google.ads.datamanager.v1.TargetingType targeting_type = 25;

Returns
Type	Description
TargetingType	The targetingType.

getTargetingTypeOneofCase()

public abstract AdEvent.TargetingTypeOneofCase getTargetingTypeOneofCase()

Returns
Type	Description
AdEvent.TargetingTypeOneofCase

getTargetingTypeString()

public abstract String getTargetingTypeString()

String value for targeting type.

string targeting_type_string = 26;

Returns
Type	Description
String	The targetingTypeString.

getTargetingTypeStringBytes()

public abstract ByteString getTargetingTypeStringBytes()

String value for targeting type.

string targeting_type_string = 26;

Returns
Type	Description
ByteString	The bytes for targetingTypeString.

getTargetingTypeValue()

public abstract int getTargetingTypeValue()

Enum value for targeting type.

.google.ads.datamanager.v1.TargetingType targeting_type = 25;

Returns
Type	Description
int	The enum numeric value on the wire for targetingType.

getTimestamp()

public abstract Timestamp getTimestamp()

Required. The time the event occurred.

.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Timestamp	The timestamp.

getTimestampOrBuilder()

public abstract TimestampOrBuilder getTimestampOrBuilder()

Required. The time the event occurred.

.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TimestampOrBuilder

getUserData()

public abstract UserData getUserData()

Optional. Multiple pieces of user-provided data, representing the user the event is associated with.

It is possible to provide multiple instances of the same type of data (e.g. email address). The more data provided, the more likely a match will be found.

.google.ads.datamanager.v1.UserData user_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserData	The userData.

getUserDataOrBuilder()

public abstract UserDataOrBuilder getUserDataOrBuilder()

Optional. Multiple pieces of user-provided data, representing the user the event is associated with.

It is possible to provide multiple instances of the same type of data (e.g. email address). The more data provided, the more likely a match will be found.

.google.ads.datamanager.v1.UserData user_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserDataOrBuilder

getViewabilityInfo()

public abstract ViewabilityInfo getViewabilityInfo()

Required. Details of the viewability of the ad served.

.google.ads.datamanager.v1.ViewabilityInfo viewability_info = 32 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ViewabilityInfo	The viewabilityInfo.

getViewabilityInfoOrBuilder()

public abstract ViewabilityInfoOrBuilder getViewabilityInfoOrBuilder()

Required. Details of the viewability of the ad served.

.google.ads.datamanager.v1.ViewabilityInfo viewability_info = 32 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ViewabilityInfoOrBuilder

hasAdFormat()

public abstract boolean hasAdFormat()

Enum value for ad format.

.google.ads.datamanager.v1.AdFormat ad_format = 16;

Returns
Type	Description
boolean	Whether the adFormat field is set.

hasAdFormatString()

public abstract boolean hasAdFormatString()

String value for ad format.

string ad_format_string = 17;

Returns
Type	Description
boolean	Whether the adFormatString field is set.

hasAdPlacement()

public abstract boolean hasAdPlacement()

Enum value for ad placement.

.google.ads.datamanager.v1.AdPlacement ad_placement = 18;

Returns
Type	Description
boolean	Whether the adPlacement field is set.

hasAdPlacementString()

public abstract boolean hasAdPlacementString()

String value for ad placement.

string ad_placement_string = 19;

Returns
Type	Description
boolean	Whether the adPlacementString field is set.

hasAdType()

public abstract boolean hasAdType()

Enum value for ad type.

.google.ads.datamanager.v1.AdType ad_type = 14;

Returns
Type	Description
boolean	Whether the adType field is set.

hasAdTypeString()

public abstract boolean hasAdTypeString()

String value for ad type.

string ad_type_string = 15;

Returns
Type	Description
boolean	Whether the adTypeString field is set.

hasDeviceInfo()

public abstract boolean hasDeviceInfo()

Optional. Information gathered about the device being used when the ad event happened.

.google.ads.datamanager.v1.DeviceInfo device_info = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the deviceInfo field is set.

hasEventSubtype()

public abstract boolean hasEventSubtype()

Enum value for event subtype.

.google.ads.datamanager.v1.AdEvent.EventSubtype event_subtype = 3;

Returns
Type	Description
boolean	Whether the eventSubtype field is set.

hasEventSubtypeString()

public abstract boolean hasEventSubtypeString()

String value for event subtype.

string event_subtype_string = 4;

Returns
Type	Description
boolean	Whether the eventSubtypeString field is set.

hasMeasurementAllowed()

public abstract boolean hasMeasurementAllowed()

Optional. Represents if the row is allowed to be used for measurement purposes, as governed by applicable privacy laws within regional jurisdiction.

optional bool measurement_allowed = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the measurementAllowed field is set.

hasPlatform()

public abstract boolean hasPlatform()

Enum value for platform.

.google.ads.datamanager.v1.Platform platform = 29;

Returns
Type	Description
boolean	Whether the platform field is set.

hasPlatformString()

public abstract boolean hasPlatformString()

String value for platform.

string platform_string = 30;

Returns
Type	Description
boolean	Whether the platformString field is set.

hasPlatformType()

public abstract boolean hasPlatformType()

Enum value for platform type.

.google.ads.datamanager.v1.PlatformType platform_type = 27;

Returns
Type	Description
boolean	Whether the platformType field is set.

hasPlatformTypeString()

public abstract boolean hasPlatformTypeString()

String value for platform type.

string platform_type_string = 28;

Returns
Type	Description
boolean	Whether the platformTypeString field is set.

hasTargetingType()

public abstract boolean hasTargetingType()

Enum value for targeting type.

.google.ads.datamanager.v1.TargetingType targeting_type = 25;

Returns
Type	Description
boolean	Whether the targetingType field is set.

hasTargetingTypeString()

public abstract boolean hasTargetingTypeString()

String value for targeting type.

string targeting_type_string = 26;

Returns
Type	Description
boolean	Whether the targetingTypeString field is set.

hasTimestamp()

public abstract boolean hasTimestamp()

Required. The time the event occurred.

.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the timestamp field is set.

hasUserData()

public abstract boolean hasUserData()

Optional. Multiple pieces of user-provided data, representing the user the event is associated with.

It is possible to provide multiple instances of the same type of data (e.g. email address). The more data provided, the more likely a match will be found.

.google.ads.datamanager.v1.UserData user_data = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the userData field is set.

hasViewabilityInfo()

public abstract boolean hasViewabilityInfo()

Required. Details of the viewability of the ad served.

.google.ads.datamanager.v1.ViewabilityInfo viewability_info = 32 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the viewabilityInfo field is set.