public static final class AdEvent.Builder extends GeneratedMessage.Builder<AdEvent.Builder> implements AdEventOrBuilderAn ad event.
Protobuf type google.ads.datamanager.v1.AdEvent
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AdEvent.BuilderImplements
AdEventOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public AdEvent build()| Returns | |
|---|---|
| Type | Description |
AdEvent |
|
buildPartial()
public AdEvent buildPartial()| Returns | |
|---|---|
| Type | Description |
AdEvent |
|
clear()
public AdEvent.Builder clear()| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearAdFormat()
public AdEvent.Builder clearAdFormat()Enum value for ad format.
.google.ads.datamanager.v1.AdFormat ad_format = 16;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdFormatOneof()
public AdEvent.Builder clearAdFormatOneof()| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearAdFormatString()
public AdEvent.Builder clearAdFormatString()String value for ad format.
string ad_format_string = 17;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdGroupId()
public AdEvent.Builder clearAdGroupId()Optional. The ID of the associated ad group.
string ad_group_id = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdHeight()
public AdEvent.Builder clearAdHeight()Optional. The height of the ad in pixels.
int32 ad_height = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdId()
public AdEvent.Builder clearAdId()Optional. The ID of the associated ad within the group.
string ad_id = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdPlacement()
public AdEvent.Builder clearAdPlacement()Enum value for ad placement.
.google.ads.datamanager.v1.AdPlacement ad_placement = 18;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdPlacementOneof()
public AdEvent.Builder clearAdPlacementOneof()| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearAdPlacementString()
public AdEvent.Builder clearAdPlacementString()String value for ad placement.
string ad_placement_string = 19;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdType()
public AdEvent.Builder clearAdType()Enum value for ad type.
.google.ads.datamanager.v1.AdType ad_type = 14;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdTypeOneof()
public AdEvent.Builder clearAdTypeOneof()| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearAdTypeString()
public AdEvent.Builder clearAdTypeString()String value for ad type.
string ad_type_string = 15;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdWidth()
public AdEvent.Builder clearAdWidth()Optional. The width of the ad in pixels.
int32 ad_width = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearAdvertiserId()
public AdEvent.Builder clearAdvertiserId()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 |
AdEvent.Builder |
This builder for chaining. |
clearAttributionHint()
public AdEvent.Builder clearAttributionHint()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 |
AdEvent.Builder |
This builder for chaining. |
clearCampaignId()
public AdEvent.Builder clearCampaignId()Required. The ID of the associated campaign.
string campaign_id = 10 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearCampaignName()
public AdEvent.Builder clearCampaignName()Required. The name of the associated campaign.
string campaign_name = 11 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearDeviceInfo()
public AdEvent.Builder clearDeviceInfo()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 |
AdEvent.Builder |
|
clearEventId()
public AdEvent.Builder clearEventId()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 |
AdEvent.Builder |
This builder for chaining. |
clearEventSubtype()
public AdEvent.Builder clearEventSubtype()Enum value for event subtype.
.google.ads.datamanager.v1.AdEvent.EventSubtype event_subtype = 3;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearEventSubtypeOneof()
public AdEvent.Builder clearEventSubtypeOneof()| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearEventSubtypeString()
public AdEvent.Builder clearEventSubtypeString()String value for event subtype.
string event_subtype_string = 4;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearEventType()
public AdEvent.Builder clearEventType()Required. The type of the event.
.google.ads.datamanager.v1.AdEvent.EventType event_type = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearMeasurementAllowed()
public AdEvent.Builder clearMeasurementAllowed()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 |
AdEvent.Builder |
This builder for chaining. |
clearMedium()
public AdEvent.Builder clearMedium()Required. The medium of the ad, akin to the Google Analytics medium.
string medium = 24 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearMobileDeviceId()
public AdEvent.Builder clearMobileDeviceId()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 |
AdEvent.Builder |
This builder for chaining. |
clearPlatform()
public AdEvent.Builder clearPlatform()Enum value for platform.
.google.ads.datamanager.v1.Platform platform = 29;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearPlatformOneof()
public AdEvent.Builder clearPlatformOneof()| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearPlatformString()
public AdEvent.Builder clearPlatformString()String value for platform.
string platform_string = 30;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearPlatformType()
public AdEvent.Builder clearPlatformType()Enum value for platform type.
.google.ads.datamanager.v1.PlatformType platform_type = 27;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearPlatformTypeOneof()
public AdEvent.Builder clearPlatformTypeOneof()| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearPlatformTypeString()
public AdEvent.Builder clearPlatformTypeString()String value for platform type.
string platform_type_string = 28;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearRegionCode()
public AdEvent.Builder clearRegionCode()Required. The ISO 3166-2 country plus subdivision.
string region_code = 22 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearSource()
public AdEvent.Builder clearSource()Required. The platform source of the ad, akin to the Google Analytics source.
string source = 23 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearTargetingType()
public AdEvent.Builder clearTargetingType()Enum value for targeting type.
.google.ads.datamanager.v1.TargetingType targeting_type = 25;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearTargetingTypeOneof()
public AdEvent.Builder clearTargetingTypeOneof()| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearTargetingTypeString()
public AdEvent.Builder clearTargetingTypeString()String value for targeting type.
string targeting_type_string = 26;
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
clearTimestamp()
public AdEvent.Builder clearTimestamp()Required. The time the event occurred.
.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
clearUserData()
public AdEvent.Builder clearUserData()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 |
AdEvent.Builder |
|
clearViewabilityInfo()
public AdEvent.Builder clearViewabilityInfo()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 |
AdEvent.Builder |
|
getAdFormat()
public AdFormat getAdFormat()Enum value for ad format.
.google.ads.datamanager.v1.AdFormat ad_format = 16;
| Returns | |
|---|---|
| Type | Description |
AdFormat |
The adFormat. |
getAdFormatOneofCase()
public AdEvent.AdFormatOneofCase getAdFormatOneofCase()| Returns | |
|---|---|
| Type | Description |
AdEvent.AdFormatOneofCase |
|
getAdFormatString()
public String getAdFormatString()String value for ad format.
string ad_format_string = 17;
| Returns | |
|---|---|
| Type | Description |
String |
The adFormatString. |
getAdFormatStringBytes()
public ByteString getAdFormatStringBytes()String value for ad format.
string ad_format_string = 17;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for adFormatString. |
getAdFormatValue()
public 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 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 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 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 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 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 AdPlacement getAdPlacement()Enum value for ad placement.
.google.ads.datamanager.v1.AdPlacement ad_placement = 18;
| Returns | |
|---|---|
| Type | Description |
AdPlacement |
The adPlacement. |
getAdPlacementOneofCase()
public AdEvent.AdPlacementOneofCase getAdPlacementOneofCase()| Returns | |
|---|---|
| Type | Description |
AdEvent.AdPlacementOneofCase |
|
getAdPlacementString()
public String getAdPlacementString()String value for ad placement.
string ad_placement_string = 19;
| Returns | |
|---|---|
| Type | Description |
String |
The adPlacementString. |
getAdPlacementStringBytes()
public ByteString getAdPlacementStringBytes()String value for ad placement.
string ad_placement_string = 19;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for adPlacementString. |
getAdPlacementValue()
public 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 AdType getAdType()Enum value for ad type.
.google.ads.datamanager.v1.AdType ad_type = 14;
| Returns | |
|---|---|
| Type | Description |
AdType |
The adType. |
getAdTypeOneofCase()
public AdEvent.AdTypeOneofCase getAdTypeOneofCase()| Returns | |
|---|---|
| Type | Description |
AdEvent.AdTypeOneofCase |
|
getAdTypeString()
public String getAdTypeString()String value for ad type.
string ad_type_string = 15;
| Returns | |
|---|---|
| Type | Description |
String |
The adTypeString. |
getAdTypeStringBytes()
public ByteString getAdTypeStringBytes()String value for ad type.
string ad_type_string = 15;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for adTypeString. |
getAdTypeValue()
public 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 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 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 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 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 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 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 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 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 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. |
getDefaultInstanceForType()
public AdEvent getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AdEvent |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDeviceInfo()
public 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. |
getDeviceInfoBuilder()
public DeviceInfo.Builder getDeviceInfoBuilder()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.Builder |
|
getDeviceInfoOrBuilder()
public 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 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 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 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 AdEvent.EventSubtypeOneofCase getEventSubtypeOneofCase()| Returns | |
|---|---|
| Type | Description |
AdEvent.EventSubtypeOneofCase |
|
getEventSubtypeString()
public String getEventSubtypeString()String value for event subtype.
string event_subtype_string = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The eventSubtypeString. |
getEventSubtypeStringBytes()
public ByteString getEventSubtypeStringBytes()String value for event subtype.
string event_subtype_string = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for eventSubtypeString. |
getEventSubtypeValue()
public 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 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 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 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 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 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 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 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 Platform getPlatform()Enum value for platform.
.google.ads.datamanager.v1.Platform platform = 29;
| Returns | |
|---|---|
| Type | Description |
Platform |
The platform. |
getPlatformOneofCase()
public AdEvent.PlatformOneofCase getPlatformOneofCase()| Returns | |
|---|---|
| Type | Description |
AdEvent.PlatformOneofCase |
|
getPlatformString()
public String getPlatformString()String value for platform.
string platform_string = 30;
| Returns | |
|---|---|
| Type | Description |
String |
The platformString. |
getPlatformStringBytes()
public ByteString getPlatformStringBytes()String value for platform.
string platform_string = 30;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for platformString. |
getPlatformType()
public PlatformType getPlatformType()Enum value for platform type.
.google.ads.datamanager.v1.PlatformType platform_type = 27;
| Returns | |
|---|---|
| Type | Description |
PlatformType |
The platformType. |
getPlatformTypeOneofCase()
public AdEvent.PlatformTypeOneofCase getPlatformTypeOneofCase()| Returns | |
|---|---|
| Type | Description |
AdEvent.PlatformTypeOneofCase |
|
getPlatformTypeString()
public String getPlatformTypeString()String value for platform type.
string platform_type_string = 28;
| Returns | |
|---|---|
| Type | Description |
String |
The platformTypeString. |
getPlatformTypeStringBytes()
public ByteString getPlatformTypeStringBytes()String value for platform type.
string platform_type_string = 28;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for platformTypeString. |
getPlatformTypeValue()
public 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 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 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 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 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 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 TargetingType getTargetingType()Enum value for targeting type.
.google.ads.datamanager.v1.TargetingType targeting_type = 25;
| Returns | |
|---|---|
| Type | Description |
TargetingType |
The targetingType. |
getTargetingTypeOneofCase()
public AdEvent.TargetingTypeOneofCase getTargetingTypeOneofCase()| Returns | |
|---|---|
| Type | Description |
AdEvent.TargetingTypeOneofCase |
|
getTargetingTypeString()
public String getTargetingTypeString()String value for targeting type.
string targeting_type_string = 26;
| Returns | |
|---|---|
| Type | Description |
String |
The targetingTypeString. |
getTargetingTypeStringBytes()
public ByteString getTargetingTypeStringBytes()String value for targeting type.
string targeting_type_string = 26;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for targetingTypeString. |
getTargetingTypeValue()
public 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 Timestamp getTimestamp()Required. The time the event occurred.
.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The timestamp. |
getTimestampBuilder()
public Timestamp.Builder getTimestampBuilder()Required. The time the event occurred.
.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getTimestampOrBuilder()
public TimestampOrBuilder getTimestampOrBuilder()Required. The time the event occurred.
.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getUserData()
public 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. |
getUserDataBuilder()
public UserData.Builder getUserDataBuilder()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.Builder |
|
getUserDataOrBuilder()
public 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 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. |
getViewabilityInfoBuilder()
public ViewabilityInfo.Builder getViewabilityInfoBuilder()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.Builder |
|
getViewabilityInfoOrBuilder()
public 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 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 boolean hasAdFormatString()String value for ad format.
string ad_format_string = 17;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adFormatString field is set. |
hasAdPlacement()
public 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 boolean hasAdPlacementString()String value for ad placement.
string ad_placement_string = 19;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adPlacementString field is set. |
hasAdType()
public 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 boolean hasAdTypeString()String value for ad type.
string ad_type_string = 15;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adTypeString field is set. |
hasDeviceInfo()
public 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 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 boolean hasEventSubtypeString()String value for event subtype.
string event_subtype_string = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the eventSubtypeString field is set. |
hasMeasurementAllowed()
public 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 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 boolean hasPlatformString()String value for platform.
string platform_string = 30;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the platformString field is set. |
hasPlatformType()
public 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 boolean hasPlatformTypeString()String value for platform type.
string platform_type_string = 28;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the platformTypeString field is set. |
hasTargetingType()
public 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 boolean hasTargetingTypeString()String value for targeting type.
string targeting_type_string = 26;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the targetingTypeString field is set. |
hasTimestamp()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDeviceInfo(DeviceInfo value)
public AdEvent.Builder mergeDeviceInfo(DeviceInfo value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
DeviceInfo |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
mergeFrom(AdEvent other)
public AdEvent.Builder mergeFrom(AdEvent other)| Parameter | |
|---|---|
| Name | Description |
other |
AdEvent |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AdEvent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AdEvent.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
mergeTimestamp(Timestamp value)
public AdEvent.Builder mergeTimestamp(Timestamp value)Required. The time the event occurred.
.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
mergeUserData(UserData value)
public AdEvent.Builder mergeUserData(UserData value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
UserData |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
mergeViewabilityInfo(ViewabilityInfo value)
public AdEvent.Builder mergeViewabilityInfo(ViewabilityInfo value)Required. Details of the viewability of the ad served.
.google.ads.datamanager.v1.ViewabilityInfo viewability_info = 32 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ViewabilityInfo |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
setAdFormat(AdFormat value)
public AdEvent.Builder setAdFormat(AdFormat value)Enum value for ad format.
.google.ads.datamanager.v1.AdFormat ad_format = 16;
| Parameter | |
|---|---|
| Name | Description |
value |
AdFormatThe adFormat to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdFormatString(String value)
public AdEvent.Builder setAdFormatString(String value)String value for ad format.
string ad_format_string = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adFormatString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdFormatStringBytes(ByteString value)
public AdEvent.Builder setAdFormatStringBytes(ByteString value)String value for ad format.
string ad_format_string = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adFormatString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdFormatValue(int value)
public AdEvent.Builder setAdFormatValue(int value)Enum value for ad format.
.google.ads.datamanager.v1.AdFormat ad_format = 16;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for adFormat to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdGroupId(String value)
public AdEvent.Builder setAdGroupId(String value)Optional. The ID of the associated ad group.
string ad_group_id = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adGroupId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdGroupIdBytes(ByteString value)
public AdEvent.Builder setAdGroupIdBytes(ByteString value)Optional. The ID of the associated ad group.
string ad_group_id = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adGroupId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdHeight(int value)
public AdEvent.Builder setAdHeight(int value)Optional. The height of the ad in pixels.
int32 ad_height = 20 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe adHeight to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdId(String value)
public AdEvent.Builder setAdId(String value)Optional. The ID of the associated ad within the group.
string ad_id = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdIdBytes(ByteString value)
public AdEvent.Builder setAdIdBytes(ByteString value)Optional. The ID of the associated ad within the group.
string ad_id = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdPlacement(AdPlacement value)
public AdEvent.Builder setAdPlacement(AdPlacement value)Enum value for ad placement.
.google.ads.datamanager.v1.AdPlacement ad_placement = 18;
| Parameter | |
|---|---|
| Name | Description |
value |
AdPlacementThe adPlacement to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdPlacementString(String value)
public AdEvent.Builder setAdPlacementString(String value)String value for ad placement.
string ad_placement_string = 19;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adPlacementString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdPlacementStringBytes(ByteString value)
public AdEvent.Builder setAdPlacementStringBytes(ByteString value)String value for ad placement.
string ad_placement_string = 19;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adPlacementString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdPlacementValue(int value)
public AdEvent.Builder setAdPlacementValue(int value)Enum value for ad placement.
.google.ads.datamanager.v1.AdPlacement ad_placement = 18;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for adPlacement to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdType(AdType value)
public AdEvent.Builder setAdType(AdType value)Enum value for ad type.
.google.ads.datamanager.v1.AdType ad_type = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
AdTypeThe adType to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdTypeString(String value)
public AdEvent.Builder setAdTypeString(String value)String value for ad type.
string ad_type_string = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adTypeString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdTypeStringBytes(ByteString value)
public AdEvent.Builder setAdTypeStringBytes(ByteString value)String value for ad type.
string ad_type_string = 15;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adTypeString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdTypeValue(int value)
public AdEvent.Builder setAdTypeValue(int value)Enum value for ad type.
.google.ads.datamanager.v1.AdType ad_type = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for adType to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdWidth(int value)
public AdEvent.Builder setAdWidth(int value)Optional. The width of the ad in pixels.
int32 ad_width = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe adWidth to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdvertiserId(String value)
public AdEvent.Builder setAdvertiserId(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe advertiserId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAdvertiserIdBytes(ByteString value)
public AdEvent.Builder setAdvertiserIdBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for advertiserId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAttributionHint(AttributionHint value)
public AdEvent.Builder setAttributionHint(AttributionHint value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
AttributionHintThe attributionHint to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setAttributionHintValue(int value)
public AdEvent.Builder setAttributionHintValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for attributionHint to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setCampaignId(String value)
public AdEvent.Builder setCampaignId(String value)Required. The ID of the associated campaign.
string campaign_id = 10 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe campaignId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setCampaignIdBytes(ByteString value)
public AdEvent.Builder setCampaignIdBytes(ByteString value)Required. The ID of the associated campaign.
string campaign_id = 10 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for campaignId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setCampaignName(String value)
public AdEvent.Builder setCampaignName(String value)Required. The name of the associated campaign.
string campaign_name = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe campaignName to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setCampaignNameBytes(ByteString value)
public AdEvent.Builder setCampaignNameBytes(ByteString value)Required. The name of the associated campaign.
string campaign_name = 11 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for campaignName to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setDeviceInfo(DeviceInfo value)
public AdEvent.Builder setDeviceInfo(DeviceInfo value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
DeviceInfo |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
setDeviceInfo(DeviceInfo.Builder builderForValue)
public AdEvent.Builder setDeviceInfo(DeviceInfo.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DeviceInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
setEventId(String value)
public AdEvent.Builder setEventId(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe eventId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setEventIdBytes(ByteString value)
public AdEvent.Builder setEventIdBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for eventId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setEventSubtype(AdEvent.EventSubtype value)
public AdEvent.Builder setEventSubtype(AdEvent.EventSubtype value)Enum value for event subtype.
.google.ads.datamanager.v1.AdEvent.EventSubtype event_subtype = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
AdEvent.EventSubtypeThe eventSubtype to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setEventSubtypeString(String value)
public AdEvent.Builder setEventSubtypeString(String value)String value for event subtype.
string event_subtype_string = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe eventSubtypeString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setEventSubtypeStringBytes(ByteString value)
public AdEvent.Builder setEventSubtypeStringBytes(ByteString value)String value for event subtype.
string event_subtype_string = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for eventSubtypeString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setEventSubtypeValue(int value)
public AdEvent.Builder setEventSubtypeValue(int value)Enum value for event subtype.
.google.ads.datamanager.v1.AdEvent.EventSubtype event_subtype = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for eventSubtype to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setEventType(AdEvent.EventType value)
public AdEvent.Builder setEventType(AdEvent.EventType value)Required. The type of the event.
.google.ads.datamanager.v1.AdEvent.EventType event_type = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
AdEvent.EventTypeThe eventType to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setEventTypeValue(int value)
public AdEvent.Builder setEventTypeValue(int value)Required. The type of the event.
.google.ads.datamanager.v1.AdEvent.EventType event_type = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for eventType to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setMeasurementAllowed(boolean value)
public AdEvent.Builder setMeasurementAllowed(boolean value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe measurementAllowed to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setMedium(String value)
public AdEvent.Builder setMedium(String value)Required. The medium of the ad, akin to the Google Analytics medium.
string medium = 24 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe medium to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setMediumBytes(ByteString value)
public AdEvent.Builder setMediumBytes(ByteString value)Required. The medium of the ad, akin to the Google Analytics medium.
string medium = 24 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for medium to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setMobileDeviceId(String value)
public AdEvent.Builder setMobileDeviceId(String value)Optional. The device ID of the device that the ad was served to.
string mobile_device_id = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe mobileDeviceId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setMobileDeviceIdBytes(ByteString value)
public AdEvent.Builder setMobileDeviceIdBytes(ByteString value)Optional. The device ID of the device that the ad was served to.
string mobile_device_id = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for mobileDeviceId to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setPlatform(Platform value)
public AdEvent.Builder setPlatform(Platform value)Enum value for platform.
.google.ads.datamanager.v1.Platform platform = 29;
| Parameter | |
|---|---|
| Name | Description |
value |
PlatformThe platform to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setPlatformString(String value)
public AdEvent.Builder setPlatformString(String value)String value for platform.
string platform_string = 30;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe platformString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setPlatformStringBytes(ByteString value)
public AdEvent.Builder setPlatformStringBytes(ByteString value)String value for platform.
string platform_string = 30;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for platformString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setPlatformType(PlatformType value)
public AdEvent.Builder setPlatformType(PlatformType value)Enum value for platform type.
.google.ads.datamanager.v1.PlatformType platform_type = 27;
| Parameter | |
|---|---|
| Name | Description |
value |
PlatformTypeThe platformType to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setPlatformTypeString(String value)
public AdEvent.Builder setPlatformTypeString(String value)String value for platform type.
string platform_type_string = 28;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe platformTypeString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setPlatformTypeStringBytes(ByteString value)
public AdEvent.Builder setPlatformTypeStringBytes(ByteString value)String value for platform type.
string platform_type_string = 28;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for platformTypeString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setPlatformTypeValue(int value)
public AdEvent.Builder setPlatformTypeValue(int value)Enum value for platform type.
.google.ads.datamanager.v1.PlatformType platform_type = 27;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for platformType to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setPlatformValue(int value)
public AdEvent.Builder setPlatformValue(int value)Enum value for platform.
.google.ads.datamanager.v1.Platform platform = 29;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for platform to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setRegionCode(String value)
public AdEvent.Builder setRegionCode(String value)Required. The ISO 3166-2 country plus subdivision.
string region_code = 22 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe regionCode to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setRegionCodeBytes(ByteString value)
public AdEvent.Builder setRegionCodeBytes(ByteString value)Required. The ISO 3166-2 country plus subdivision.
string region_code = 22 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for regionCode to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setSource(String value)
public AdEvent.Builder setSource(String value)Required. The platform source of the ad, akin to the Google Analytics source.
string source = 23 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe source to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setSourceBytes(ByteString value)
public AdEvent.Builder setSourceBytes(ByteString value)Required. The platform source of the ad, akin to the Google Analytics source.
string source = 23 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for source to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setTargetingType(TargetingType value)
public AdEvent.Builder setTargetingType(TargetingType value)Enum value for targeting type.
.google.ads.datamanager.v1.TargetingType targeting_type = 25;
| Parameter | |
|---|---|
| Name | Description |
value |
TargetingTypeThe targetingType to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setTargetingTypeString(String value)
public AdEvent.Builder setTargetingTypeString(String value)String value for targeting type.
string targeting_type_string = 26;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe targetingTypeString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setTargetingTypeStringBytes(ByteString value)
public AdEvent.Builder setTargetingTypeStringBytes(ByteString value)String value for targeting type.
string targeting_type_string = 26;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for targetingTypeString to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setTargetingTypeValue(int value)
public AdEvent.Builder setTargetingTypeValue(int value)Enum value for targeting type.
.google.ads.datamanager.v1.TargetingType targeting_type = 25;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for targetingType to set. |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
This builder for chaining. |
setTimestamp(Timestamp value)
public AdEvent.Builder setTimestamp(Timestamp value)Required. The time the event occurred.
.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
setTimestamp(Timestamp.Builder builderForValue)
public AdEvent.Builder setTimestamp(Timestamp.Builder builderForValue)Required. The time the event occurred.
.google.protobuf.Timestamp timestamp = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
setUserData(UserData value)
public AdEvent.Builder setUserData(UserData value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
UserData |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
setUserData(UserData.Builder builderForValue)
public AdEvent.Builder setUserData(UserData.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UserData.Builder |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
setViewabilityInfo(ViewabilityInfo value)
public AdEvent.Builder setViewabilityInfo(ViewabilityInfo value)Required. Details of the viewability of the ad served.
.google.ads.datamanager.v1.ViewabilityInfo viewability_info = 32 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ViewabilityInfo |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|
setViewabilityInfo(ViewabilityInfo.Builder builderForValue)
public AdEvent.Builder setViewabilityInfo(ViewabilityInfo.Builder builderForValue)Required. Details of the viewability of the ad served.
.google.ads.datamanager.v1.ViewabilityInfo viewability_info = 32 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ViewabilityInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
AdEvent.Builder |
|