Interface AdGroupOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
AdGroup
,AdGroup.Builder
public interface AdGroupOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AdGroupAdRotationModeEnum.AdGroupAdRotationMode
getAdRotationMode()
The ad rotation mode of the ad group.int
getAdRotationModeValue()
The ad rotation mode of the ad group.AdGroup.AudienceSetting
getAudienceSetting()
Immutable.AdGroup.AudienceSettingOrBuilder
getAudienceSettingOrBuilder()
Immutable.java.lang.String
getBaseAdGroup()
Output only.com.google.protobuf.ByteString
getBaseAdGroupBytes()
Output only.java.lang.String
getCampaign()
Immutable.com.google.protobuf.ByteString
getCampaignBytes()
Immutable.long
getCpcBidMicros()
The maximum CPC (cost-per-click) bid.long
getCpmBidMicros()
The maximum CPM (cost-per-thousand viewable impressions) bid.long
getCpvBidMicros()
The CPV (cost-per-view) bid.TargetingDimensionEnum.TargetingDimension
getDisplayCustomBidDimension()
Allows advertisers to specify a targeting dimension on which to place absolute bids.int
getDisplayCustomBidDimensionValue()
Allows advertisers to specify a targeting dimension on which to place absolute bids.long
getEffectiveCpcBidMicros()
Output only.long
getEffectiveTargetCpaMicros()
Output only.BiddingSourceEnum.BiddingSource
getEffectiveTargetCpaSource()
Output only.int
getEffectiveTargetCpaSourceValue()
Output only.double
getEffectiveTargetRoas()
Output only.BiddingSourceEnum.BiddingSource
getEffectiveTargetRoasSource()
Output only.int
getEffectiveTargetRoasSourceValue()
Output only.AssetFieldTypeEnum.AssetFieldType
getExcludedParentAssetFieldTypes(int index)
The asset field types that should be excluded from this ad group.int
getExcludedParentAssetFieldTypesCount()
The asset field types that should be excluded from this ad group.java.util.List<AssetFieldTypeEnum.AssetFieldType>
getExcludedParentAssetFieldTypesList()
The asset field types that should be excluded from this ad group.int
getExcludedParentAssetFieldTypesValue(int index)
The asset field types that should be excluded from this ad group.java.util.List<java.lang.Integer>
getExcludedParentAssetFieldTypesValueList()
The asset field types that should be excluded from this ad group.AssetSetTypeEnum.AssetSetType
getExcludedParentAssetSetTypes(int index)
The asset set types that should be excluded from this ad group.int
getExcludedParentAssetSetTypesCount()
The asset set types that should be excluded from this ad group.java.util.List<AssetSetTypeEnum.AssetSetType>
getExcludedParentAssetSetTypesList()
The asset set types that should be excluded from this ad group.int
getExcludedParentAssetSetTypesValue(int index)
The asset set types that should be excluded from this ad group.java.util.List<java.lang.Integer>
getExcludedParentAssetSetTypesValueList()
The asset set types that should be excluded from this ad group.java.lang.String
getFinalUrlSuffix()
URL template for appending params to Final URL.com.google.protobuf.ByteString
getFinalUrlSuffixBytes()
URL template for appending params to Final URL.long
getId()
Output only.java.lang.String
getLabels(int index)
Output only.com.google.protobuf.ByteString
getLabelsBytes(int index)
Output only.int
getLabelsCount()
Output only.java.util.List<java.lang.String>
getLabelsList()
Output only.java.lang.String
getName()
The name of the ad group.com.google.protobuf.ByteString
getNameBytes()
The name of the ad group.boolean
getOptimizedTargetingEnabled()
True if optimized targeting is enabled.long
getPercentCpcBidMicros()
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service.java.lang.String
getResourceName()
Immutable.com.google.protobuf.ByteString
getResourceNameBytes()
Immutable.AdGroupStatusEnum.AdGroupStatus
getStatus()
The status of the ad group.int
getStatusValue()
The status of the ad group.long
getTargetCpaMicros()
The target CPA (cost-per-acquisition).long
getTargetCpmMicros()
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.TargetingSetting
getTargetingSetting()
Setting for targeting related features.TargetingSettingOrBuilder
getTargetingSettingOrBuilder()
Setting for targeting related features.double
getTargetRoas()
The target ROAS (return-on-ad-spend) override.java.lang.String
getTrackingUrlTemplate()
The URL template for constructing a tracking URL.com.google.protobuf.ByteString
getTrackingUrlTemplateBytes()
The URL template for constructing a tracking URL.AdGroupTypeEnum.AdGroupType
getType()
Immutable.int
getTypeValue()
Immutable.CustomParameter
getUrlCustomParameters(int index)
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.int
getUrlCustomParametersCount()
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.java.util.List<CustomParameter>
getUrlCustomParametersList()
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.CustomParameterOrBuilder
getUrlCustomParametersOrBuilder(int index)
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.java.util.List<? extends CustomParameterOrBuilder>
getUrlCustomParametersOrBuilderList()
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.boolean
hasAudienceSetting()
Immutable.boolean
hasBaseAdGroup()
Output only.boolean
hasCampaign()
Immutable.boolean
hasCpcBidMicros()
The maximum CPC (cost-per-click) bid.boolean
hasCpmBidMicros()
The maximum CPM (cost-per-thousand viewable impressions) bid.boolean
hasCpvBidMicros()
The CPV (cost-per-view) bid.boolean
hasEffectiveCpcBidMicros()
Output only.boolean
hasEffectiveTargetCpaMicros()
Output only.boolean
hasEffectiveTargetRoas()
Output only.boolean
hasFinalUrlSuffix()
URL template for appending params to Final URL.boolean
hasId()
Output only.boolean
hasName()
The name of the ad group.boolean
hasPercentCpcBidMicros()
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service.boolean
hasTargetCpaMicros()
The target CPA (cost-per-acquisition).boolean
hasTargetCpmMicros()
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.boolean
hasTargetingSetting()
Setting for targeting related features.boolean
hasTargetRoas()
The target ROAS (return-on-ad-spend) override.boolean
hasTrackingUrlTemplate()
The URL template for constructing a tracking URL.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getResourceName
java.lang.String getResourceName()
Immutable. The resource name of the ad group. Ad group resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Returns:
- The resourceName.
-
getResourceNameBytes
com.google.protobuf.ByteString getResourceNameBytes()
Immutable. The resource name of the ad group. Ad group resource names have the form: `customers/{customer_id}/adGroups/{ad_group_id}`
string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Returns:
- The bytes for resourceName.
-
hasId
boolean hasId()
Output only. The ID of the ad group.
optional int64 id = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the id field is set.
-
getId
long getId()
Output only. The ID of the ad group.
optional int64 id = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The id.
-
hasName
boolean hasName()
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
optional string name = 35;
- Returns:
- Whether the name field is set.
-
getName
java.lang.String getName()
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
optional string name = 35;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()
The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.
optional string name = 35;
- Returns:
- The bytes for name.
-
getStatusValue
int getStatusValue()
The status of the ad group.
.google.ads.googleads.v14.enums.AdGroupStatusEnum.AdGroupStatus status = 5;
- Returns:
- The enum numeric value on the wire for status.
-
getStatus
AdGroupStatusEnum.AdGroupStatus getStatus()
The status of the ad group.
.google.ads.googleads.v14.enums.AdGroupStatusEnum.AdGroupStatus status = 5;
- Returns:
- The status.
-
getTypeValue
int getTypeValue()
Immutable. The type of the ad group.
.google.ads.googleads.v14.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];
- Returns:
- The enum numeric value on the wire for type.
-
getType
AdGroupTypeEnum.AdGroupType getType()
Immutable. The type of the ad group.
.google.ads.googleads.v14.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];
- Returns:
- The type.
-
getAdRotationModeValue
int getAdRotationModeValue()
The ad rotation mode of the ad group.
.google.ads.googleads.v14.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;
- Returns:
- The enum numeric value on the wire for adRotationMode.
-
getAdRotationMode
AdGroupAdRotationModeEnum.AdGroupAdRotationMode getAdRotationMode()
The ad rotation mode of the ad group.
.google.ads.googleads.v14.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;
- Returns:
- The adRotationMode.
-
hasBaseAdGroup
boolean hasBaseAdGroup()
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
optional string base_ad_group = 36 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
- Returns:
- Whether the baseAdGroup field is set.
-
getBaseAdGroup
java.lang.String getBaseAdGroup()
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
optional string base_ad_group = 36 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
- Returns:
- The baseAdGroup.
-
getBaseAdGroupBytes
com.google.protobuf.ByteString getBaseAdGroupBytes()
Output only. For draft or experiment ad groups, this field is the resource name of the base ad group from which this ad group was created. If a draft or experiment ad group does not have a base ad group, then this field is null. For base ad groups, this field equals the ad group resource name. This field is read-only.
optional string base_ad_group = 36 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
- Returns:
- The bytes for baseAdGroup.
-
hasTrackingUrlTemplate
boolean hasTrackingUrlTemplate()
The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;
- Returns:
- Whether the trackingUrlTemplate field is set.
-
getTrackingUrlTemplate
java.lang.String getTrackingUrlTemplate()
The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;
- Returns:
- The trackingUrlTemplate.
-
getTrackingUrlTemplateBytes
com.google.protobuf.ByteString getTrackingUrlTemplateBytes()
The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;
- Returns:
- The bytes for trackingUrlTemplate.
-
getUrlCustomParametersList
java.util.List<CustomParameter> getUrlCustomParametersList()
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated .google.ads.googleads.v14.common.CustomParameter url_custom_parameters = 6;
-
getUrlCustomParameters
CustomParameter getUrlCustomParameters(int index)
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated .google.ads.googleads.v14.common.CustomParameter url_custom_parameters = 6;
-
getUrlCustomParametersCount
int getUrlCustomParametersCount()
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated .google.ads.googleads.v14.common.CustomParameter url_custom_parameters = 6;
-
getUrlCustomParametersOrBuilderList
java.util.List<? extends CustomParameterOrBuilder> getUrlCustomParametersOrBuilderList()
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated .google.ads.googleads.v14.common.CustomParameter url_custom_parameters = 6;
-
getUrlCustomParametersOrBuilder
CustomParameterOrBuilder getUrlCustomParametersOrBuilder(int index)
The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
repeated .google.ads.googleads.v14.common.CustomParameter url_custom_parameters = 6;
-
hasCampaign
boolean hasCampaign()
Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Returns:
- Whether the campaign field is set.
-
getCampaign
java.lang.String getCampaign()
Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Returns:
- The campaign.
-
getCampaignBytes
com.google.protobuf.ByteString getCampaignBytes()
Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
- Returns:
- The bytes for campaign.
-
hasCpcBidMicros
boolean hasCpcBidMicros()
The maximum CPC (cost-per-click) bid.
optional int64 cpc_bid_micros = 39;
- Returns:
- Whether the cpcBidMicros field is set.
-
getCpcBidMicros
long getCpcBidMicros()
The maximum CPC (cost-per-click) bid.
optional int64 cpc_bid_micros = 39;
- Returns:
- The cpcBidMicros.
-
hasEffectiveCpcBidMicros
boolean hasEffectiveCpcBidMicros()
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.
optional int64 effective_cpc_bid_micros = 57 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the effectiveCpcBidMicros field is set.
-
getEffectiveCpcBidMicros
long getEffectiveCpcBidMicros()
Output only. Value will be same as that of the CPC (cost-per-click) bid value when the bidding strategy is one of manual cpc, enhanced cpc, page one promoted or target outrank share, otherwise the value will be null.
optional int64 effective_cpc_bid_micros = 57 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The effectiveCpcBidMicros.
-
hasCpmBidMicros
boolean hasCpmBidMicros()
The maximum CPM (cost-per-thousand viewable impressions) bid.
optional int64 cpm_bid_micros = 40;
- Returns:
- Whether the cpmBidMicros field is set.
-
getCpmBidMicros
long getCpmBidMicros()
The maximum CPM (cost-per-thousand viewable impressions) bid.
optional int64 cpm_bid_micros = 40;
- Returns:
- The cpmBidMicros.
-
hasTargetCpaMicros
boolean hasTargetCpaMicros()
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.
optional int64 target_cpa_micros = 41;
- Returns:
- Whether the targetCpaMicros field is set.
-
getTargetCpaMicros
long getTargetCpaMicros()
The target CPA (cost-per-acquisition). If the ad group's campaign bidding strategy is TargetCpa or MaximizeConversions (with its target_cpa field set), then this field overrides the target CPA specified in the campaign's bidding strategy. Otherwise, this value is ignored.
optional int64 target_cpa_micros = 41;
- Returns:
- The targetCpaMicros.
-
hasCpvBidMicros
boolean hasCpvBidMicros()
The CPV (cost-per-view) bid.
optional int64 cpv_bid_micros = 42;
- Returns:
- Whether the cpvBidMicros field is set.
-
getCpvBidMicros
long getCpvBidMicros()
The CPV (cost-per-view) bid.
optional int64 cpv_bid_micros = 42;
- Returns:
- The cpvBidMicros.
-
hasTargetCpmMicros
boolean hasTargetCpmMicros()
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
optional int64 target_cpm_micros = 43;
- Returns:
- Whether the targetCpmMicros field is set.
-
getTargetCpmMicros
long getTargetCpmMicros()
Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.
optional int64 target_cpm_micros = 43;
- Returns:
- The targetCpmMicros.
-
hasTargetRoas
boolean hasTargetRoas()
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.
optional double target_roas = 44;
- Returns:
- Whether the targetRoas field is set.
-
getTargetRoas
double getTargetRoas()
The target ROAS (return-on-ad-spend) override. If the ad group's campaign bidding strategy is TargetRoas or MaximizeConversionValue (with its target_roas field set), then this field overrides the target ROAS specified in the campaign's bidding strategy. Otherwise, this value is ignored.
optional double target_roas = 44;
- Returns:
- The targetRoas.
-
hasPercentCpcBidMicros
boolean hasPercentCpcBidMicros()
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].
optional int64 percent_cpc_bid_micros = 45;
- Returns:
- Whether the percentCpcBidMicros field is set.
-
getPercentCpcBidMicros
long getPercentCpcBidMicros()
The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service. The valid range for the fraction is [0,1) and the value stored here is 1,000,000 * [fraction].
optional int64 percent_cpc_bid_micros = 45;
- Returns:
- The percentCpcBidMicros.
-
getOptimizedTargetingEnabled
boolean getOptimizedTargetingEnabled()
True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
bool optimized_targeting_enabled = 59;
- Returns:
- The optimizedTargetingEnabled.
-
getDisplayCustomBidDimensionValue
int getDisplayCustomBidDimensionValue()
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.
.google.ads.googleads.v14.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;
- Returns:
- The enum numeric value on the wire for displayCustomBidDimension.
-
getDisplayCustomBidDimension
TargetingDimensionEnum.TargetingDimension getDisplayCustomBidDimension()
Allows advertisers to specify a targeting dimension on which to place absolute bids. This is only applicable for campaigns that target only the display network and not search.
.google.ads.googleads.v14.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;
- Returns:
- The displayCustomBidDimension.
-
hasFinalUrlSuffix
boolean hasFinalUrlSuffix()
URL template for appending params to Final URL.
optional string final_url_suffix = 46;
- Returns:
- Whether the finalUrlSuffix field is set.
-
getFinalUrlSuffix
java.lang.String getFinalUrlSuffix()
URL template for appending params to Final URL.
optional string final_url_suffix = 46;
- Returns:
- The finalUrlSuffix.
-
getFinalUrlSuffixBytes
com.google.protobuf.ByteString getFinalUrlSuffixBytes()
URL template for appending params to Final URL.
optional string final_url_suffix = 46;
- Returns:
- The bytes for finalUrlSuffix.
-
hasTargetingSetting
boolean hasTargetingSetting()
Setting for targeting related features.
.google.ads.googleads.v14.common.TargetingSetting targeting_setting = 25;
- Returns:
- Whether the targetingSetting field is set.
-
getTargetingSetting
TargetingSetting getTargetingSetting()
Setting for targeting related features.
.google.ads.googleads.v14.common.TargetingSetting targeting_setting = 25;
- Returns:
- The targetingSetting.
-
getTargetingSettingOrBuilder
TargetingSettingOrBuilder getTargetingSettingOrBuilder()
Setting for targeting related features.
.google.ads.googleads.v14.common.TargetingSetting targeting_setting = 25;
-
hasAudienceSetting
boolean hasAudienceSetting()
Immutable. Setting for audience related features.
.google.ads.googleads.v14.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE];
- Returns:
- Whether the audienceSetting field is set.
-
getAudienceSetting
AdGroup.AudienceSetting getAudienceSetting()
Immutable. Setting for audience related features.
.google.ads.googleads.v14.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE];
- Returns:
- The audienceSetting.
-
getAudienceSettingOrBuilder
AdGroup.AudienceSettingOrBuilder getAudienceSettingOrBuilder()
Immutable. Setting for audience related features.
.google.ads.googleads.v14.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE];
-
hasEffectiveTargetCpaMicros
boolean hasEffectiveTargetCpaMicros()
Output only. The effective target CPA (cost-per-acquisition). This field is read-only.
optional int64 effective_target_cpa_micros = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the effectiveTargetCpaMicros field is set.
-
getEffectiveTargetCpaMicros
long getEffectiveTargetCpaMicros()
Output only. The effective target CPA (cost-per-acquisition). This field is read-only.
optional int64 effective_target_cpa_micros = 47 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The effectiveTargetCpaMicros.
-
getEffectiveTargetCpaSourceValue
int getEffectiveTargetCpaSourceValue()
Output only. Source of the effective target CPA. This field is read-only.
.google.ads.googleads.v14.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The enum numeric value on the wire for effectiveTargetCpaSource.
-
getEffectiveTargetCpaSource
BiddingSourceEnum.BiddingSource getEffectiveTargetCpaSource()
Output only. Source of the effective target CPA. This field is read-only.
.google.ads.googleads.v14.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The effectiveTargetCpaSource.
-
hasEffectiveTargetRoas
boolean hasEffectiveTargetRoas()
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.
optional double effective_target_roas = 48 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- Whether the effectiveTargetRoas field is set.
-
getEffectiveTargetRoas
double getEffectiveTargetRoas()
Output only. The effective target ROAS (return-on-ad-spend). This field is read-only.
optional double effective_target_roas = 48 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The effectiveTargetRoas.
-
getEffectiveTargetRoasSourceValue
int getEffectiveTargetRoasSourceValue()
Output only. Source of the effective target ROAS. This field is read-only.
.google.ads.googleads.v14.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The enum numeric value on the wire for effectiveTargetRoasSource.
-
getEffectiveTargetRoasSource
BiddingSourceEnum.BiddingSource getEffectiveTargetRoasSource()
Output only. Source of the effective target ROAS. This field is read-only.
.google.ads.googleads.v14.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Returns:
- The effectiveTargetRoasSource.
-
getLabelsList
java.util.List<java.lang.String> getLabelsList()
Output only. The resource names of labels attached to this ad group.
repeated string labels = 49 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
- Returns:
- A list containing the labels.
-
getLabelsCount
int getLabelsCount()
Output only. The resource names of labels attached to this ad group.
repeated string labels = 49 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
- Returns:
- The count of labels.
-
getLabels
java.lang.String getLabels(int index)
Output only. The resource names of labels attached to this ad group.
repeated string labels = 49 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
- Parameters:
index
- The index of the element to return.- Returns:
- The labels at the given index.
-
getLabelsBytes
com.google.protobuf.ByteString getLabelsBytes(int index)
Output only. The resource names of labels attached to this ad group.
repeated string labels = 49 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the labels at the given index.
-
getExcludedParentAssetFieldTypesList
java.util.List<AssetFieldTypeEnum.AssetFieldType> getExcludedParentAssetFieldTypesList()
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.
repeated .google.ads.googleads.v14.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
- Returns:
- A list containing the excludedParentAssetFieldTypes.
-
getExcludedParentAssetFieldTypesCount
int getExcludedParentAssetFieldTypesCount()
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.
repeated .google.ads.googleads.v14.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
- Returns:
- The count of excludedParentAssetFieldTypes.
-
getExcludedParentAssetFieldTypes
AssetFieldTypeEnum.AssetFieldType getExcludedParentAssetFieldTypes(int index)
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.
repeated .google.ads.googleads.v14.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
- Parameters:
index
- The index of the element to return.- Returns:
- The excludedParentAssetFieldTypes at the given index.
-
getExcludedParentAssetFieldTypesValueList
java.util.List<java.lang.Integer> getExcludedParentAssetFieldTypesValueList()
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.
repeated .google.ads.googleads.v14.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
- Returns:
- A list containing the enum numeric values on the wire for excludedParentAssetFieldTypes.
-
getExcludedParentAssetFieldTypesValue
int getExcludedParentAssetFieldTypesValue(int index)
The asset field types that should be excluded from this ad group. Asset links with these field types will not be inherited by this ad group from the upper levels.
repeated .google.ads.googleads.v14.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
- Parameters:
index
- The index of the value to return.- Returns:
- The enum numeric value on the wire of excludedParentAssetFieldTypes at the given index.
-
getExcludedParentAssetSetTypesList
java.util.List<AssetSetTypeEnum.AssetSetType> getExcludedParentAssetSetTypesList()
The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.
repeated .google.ads.googleads.v14.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;
- Returns:
- A list containing the excludedParentAssetSetTypes.
-
getExcludedParentAssetSetTypesCount
int getExcludedParentAssetSetTypesCount()
The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.
repeated .google.ads.googleads.v14.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;
- Returns:
- The count of excludedParentAssetSetTypes.
-
getExcludedParentAssetSetTypes
AssetSetTypeEnum.AssetSetType getExcludedParentAssetSetTypes(int index)
The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.
repeated .google.ads.googleads.v14.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;
- Parameters:
index
- The index of the element to return.- Returns:
- The excludedParentAssetSetTypes at the given index.
-
getExcludedParentAssetSetTypesValueList
java.util.List<java.lang.Integer> getExcludedParentAssetSetTypesValueList()
The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.
repeated .google.ads.googleads.v14.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;
- Returns:
- A list containing the enum numeric values on the wire for excludedParentAssetSetTypes.
-
getExcludedParentAssetSetTypesValue
int getExcludedParentAssetSetTypesValue(int index)
The asset set types that should be excluded from this ad group. Asset set links with these types will not be inherited by this ad group from the upper levels. Location group types (GMB_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, and STATIC_LOCATION_GROUP) are child types of LOCATION_SYNC. Therefore, if LOCATION_SYNC is set for this field, all location group asset sets are not allowed to be linked to this ad group, and all Location Extension (LE) and Affiliate Location Extensions (ALE) will not be served under this ad group. Only LOCATION_SYNC is currently supported.
repeated .google.ads.googleads.v14.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;
- Parameters:
index
- The index of the value to return.- Returns:
- The enum numeric value on the wire of excludedParentAssetSetTypes at the given index.
-
-