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()`	Output only.
`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.
`ExplorerAutoOptimizerSetting`	`getExplorerAutoOptimizerSetting()`	Settings for the Display Campaign Optimizer, initially termed "Explorer".
`ExplorerAutoOptimizerSettingOrBuilder`	`getExplorerAutoOptimizerSettingOrBuilder()`	Settings for the Display Campaign Optimizer, initially termed "Explorer".
`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.
`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()`	Output only.
`boolean`	`hasEffectiveCpcBidMicros()`	Output only.
`boolean`	`hasEffectiveTargetCpaMicros()`	Output only.
`boolean`	`hasEffectiveTargetRoas()`	Output only.
`boolean`	`hasExplorerAutoOptimizerSetting()`	Settings for the Display Campaign Optimizer, initially termed "Explorer".
`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.MessageLiteOrBuilder
isInitialized

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.v10.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.v10.enums.AdGroupStatusEnum.AdGroupStatus status = 5;
Returns:

The status.

getTypeValue
```
int getTypeValue()
```
```
 Immutable. The type of the ad group.
 
```
.google.ads.googleads.v10.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.v10.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.v10.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.v10.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.