Class AdGroup.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
com.google.ads.googleads.v18.resources.AdGroup.Builder
- All Implemented Interfaces:
AdGroupOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- AdGroup
public static final class AdGroup.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
implements AdGroupOrBuilder
An ad group.Protobuf type
google.ads.googleads.v18.resources.AdGroup-
Method Summary
Modifier and TypeMethodDescriptionaddAllExcludedParentAssetFieldTypes(Iterable<? extends AssetFieldTypeEnum.AssetFieldType> values) The asset field types that should be excluded from this ad group.The asset field types that should be excluded from this ad group.addAllExcludedParentAssetSetTypes(Iterable<? extends AssetSetTypeEnum.AssetSetType> values) The asset set types that should be excluded from this ad group.The asset set types that should be excluded from this ad group.addAllLabels(Iterable<String> values) Output only.addAllPrimaryStatusReasons(Iterable<? extends AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason> values) Output only.Output only.addAllUrlCustomParameters(Iterable<? extends CustomParameter> values) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.The asset field types that should be excluded from this ad group.addExcludedParentAssetFieldTypesValue(int value) The asset field types that should be excluded from this ad group.The asset set types that should be excluded from this ad group.addExcludedParentAssetSetTypesValue(int value) The asset set types that should be excluded from this ad group.Output only.addLabelsBytes(com.google.protobuf.ByteString value) Output only.Output only.addPrimaryStatusReasonsValue(int value) Output only.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) addUrlCustomParameters(int index, CustomParameter value) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.addUrlCustomParameters(int index, CustomParameter.Builder builderForValue) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.addUrlCustomParameters(CustomParameter.Builder builderForValue) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.addUrlCustomParametersBuilder(int index) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.build()clear()The ad rotation mode of the ad group.Immutable.Output only.Immutable.The maximum CPC (cost-per-click) bid.The maximum CPM (cost-per-thousand viewable impressions) bid.The CPV (cost-per-view) bid.Allows advertisers to specify a targeting dimension on which to place absolute bids.Output only.Output only.Output only.Output only.Output only.When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true.The asset field types that should be excluded from this ad group.The asset set types that should be excluded from this ad group.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) URL template for appending params to Final URL.The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.clearId()Output only.Output only.The name of the ad group.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) True if optimized targeting is enabled.The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service.Output only.Output only.Immutable.The status of the ad group.The target CPA (cost-per-acquisition).Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.Average amount in micros that the advertiser is willing to pay for every ad view.Setting for targeting related features.The target ROAS (return-on-ad-spend) override.The URL template for constructing a tracking URL.Immutable.The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.clone()The ad rotation mode of the ad group.intThe ad rotation mode of the ad group.Immutable.Immutable.Immutable.Output only.com.google.protobuf.ByteStringOutput only.Immutable.com.google.protobuf.ByteStringImmutable.longThe maximum CPC (cost-per-click) bid.longThe maximum CPM (cost-per-thousand viewable impressions) bid.longThe CPV (cost-per-view) bid.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorAllows advertisers to specify a targeting dimension on which to place absolute bids.intAllows advertisers to specify a targeting dimension on which to place absolute bids.longOutput only.longOutput only.Output only.intOutput only.doubleOutput only.Output only.intOutput only.booleanWhen this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true.getExcludedParentAssetFieldTypes(int index) The asset field types that should be excluded from this ad group.intThe asset field types that should be excluded from this ad group.The asset field types that should be excluded from this ad group.intgetExcludedParentAssetFieldTypesValue(int index) The asset field types that should be excluded from this ad group.The asset field types that should be excluded from this ad group.getExcludedParentAssetSetTypes(int index) The asset set types that should be excluded from this ad group.intThe asset set types that should be excluded from this ad group.The asset set types that should be excluded from this ad group.intgetExcludedParentAssetSetTypesValue(int index) The asset set types that should be excluded from this ad group.The asset set types that should be excluded from this ad group.URL template for appending params to Final URL.com.google.protobuf.ByteStringURL template for appending params to Final URL.longThe fixed amount in micros that the advertiser pays for every thousand impressions of the ad.longgetId()Output only.getLabels(int index) Output only.com.google.protobuf.ByteStringgetLabelsBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput only.getName()The name of the ad group.com.google.protobuf.ByteStringThe name of the ad group.booleanTrue if optimized targeting is enabled.longThe percent cpc bid amount, expressed as a fraction of the advertised price for some good or service.Output only.getPrimaryStatusReasons(int index) Output only.intOutput only.Output only.intgetPrimaryStatusReasonsValue(int index) Output only.Output only.intOutput only.Immutable.com.google.protobuf.ByteStringImmutable.The status of the ad group.intThe status of the ad group.longThe target CPA (cost-per-acquisition).longAverage amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.longAverage amount in micros that the advertiser is willing to pay for every ad view.Setting for targeting related features.Setting for targeting related features.Setting for targeting related features.doubleThe target ROAS (return-on-ad-spend) override.The URL template for constructing a tracking URL.com.google.protobuf.ByteStringThe URL template for constructing a tracking URL.getType()Immutable.intImmutable.getUrlCustomParameters(int index) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.getUrlCustomParametersBuilder(int index) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.intThe list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.getUrlCustomParametersOrBuilder(int index) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.List<? extends CustomParameterOrBuilder>The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.booleanImmutable.booleanOutput only.booleanImmutable.booleanThe maximum CPC (cost-per-click) bid.booleanThe maximum CPM (cost-per-thousand viewable impressions) bid.booleanThe CPV (cost-per-view) bid.booleanOutput only.booleanOutput only.booleanOutput only.booleanURL template for appending params to Final URL.booleanThe fixed amount in micros that the advertiser pays for every thousand impressions of the ad.booleanhasId()Output only.booleanhasName()The name of the ad group.booleanThe percent cpc bid amount, expressed as a fraction of the advertised price for some good or service.booleanThe target CPA (cost-per-acquisition).booleanAverage amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.booleanAverage amount in micros that the advertiser is willing to pay for every ad view.booleanSetting for targeting related features.booleanThe target ROAS (return-on-ad-spend) override.booleanThe URL template for constructing a tracking URL.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanImmutable.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) Setting for targeting related features.final AdGroup.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) removeUrlCustomParameters(int index) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.The ad rotation mode of the ad group.setAdRotationModeValue(int value) The ad rotation mode of the ad group.Immutable.setAudienceSetting(AdGroup.AudienceSetting.Builder builderForValue) Immutable.setBaseAdGroup(String value) Output only.setBaseAdGroupBytes(com.google.protobuf.ByteString value) Output only.setCampaign(String value) Immutable.setCampaignBytes(com.google.protobuf.ByteString value) Immutable.setCpcBidMicros(long value) The maximum CPC (cost-per-click) bid.setCpmBidMicros(long value) The maximum CPM (cost-per-thousand viewable impressions) bid.setCpvBidMicros(long value) The CPV (cost-per-view) bid.Allows advertisers to specify a targeting dimension on which to place absolute bids.setDisplayCustomBidDimensionValue(int value) Allows advertisers to specify a targeting dimension on which to place absolute bids.setEffectiveCpcBidMicros(long value) Output only.setEffectiveTargetCpaMicros(long value) Output only.Output only.setEffectiveTargetCpaSourceValue(int value) Output only.setEffectiveTargetRoas(double value) Output only.Output only.setEffectiveTargetRoasSourceValue(int value) Output only.setExcludeDemographicExpansion(boolean value) When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true.setExcludedParentAssetFieldTypes(int index, AssetFieldTypeEnum.AssetFieldType value) The asset field types that should be excluded from this ad group.setExcludedParentAssetFieldTypesValue(int index, int value) The asset field types that should be excluded from this ad group.setExcludedParentAssetSetTypes(int index, AssetSetTypeEnum.AssetSetType value) The asset set types that should be excluded from this ad group.setExcludedParentAssetSetTypesValue(int index, int value) The asset set types that should be excluded from this ad group.setFinalUrlSuffix(String value) URL template for appending params to Final URL.setFinalUrlSuffixBytes(com.google.protobuf.ByteString value) URL template for appending params to Final URL.setFixedCpmMicros(long value) The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.setId(long value) Output only.Output only.The name of the ad group.setNameBytes(com.google.protobuf.ByteString value) The name of the ad group.setOptimizedTargetingEnabled(boolean value) True if optimized targeting is enabled.setPercentCpcBidMicros(long value) The percent cpc bid amount, expressed as a fraction of the advertised price for some good or service.Output only.Output only.setPrimaryStatusReasonsValue(int index, int value) Output only.setPrimaryStatusValue(int value) Output only.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setResourceName(String value) Immutable.setResourceNameBytes(com.google.protobuf.ByteString value) Immutable.The status of the ad group.setStatusValue(int value) The status of the ad group.setTargetCpaMicros(long value) The target CPA (cost-per-acquisition).setTargetCpmMicros(long value) Average amount in micros that the advertiser is willing to pay for every thousand times the ad is shown.setTargetCpvMicros(long value) Average amount in micros that the advertiser is willing to pay for every ad view.Setting for targeting related features.setTargetingSetting(TargetingSetting.Builder builderForValue) Setting for targeting related features.setTargetRoas(double value) The target ROAS (return-on-ad-spend) override.setTrackingUrlTemplate(String value) The URL template for constructing a tracking URL.setTrackingUrlTemplateBytes(com.google.protobuf.ByteString value) The URL template for constructing a tracking URL.Immutable.setTypeValue(int value) Immutable.final AdGroup.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setUrlCustomParameters(int index, CustomParameter value) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.setUrlCustomParameters(int index, CustomParameter.Builder builderForValue) The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
setField
public AdGroup.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
setRepeatedField
public AdGroup.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
addRepeatedField
public AdGroup.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AdGroup.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
mergeFrom
public AdGroup.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<AdGroup.Builder>- Throws:
IOException
-
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) = { ... }- Specified by:
getResourceNamein interfaceAdGroupOrBuilder- Returns:
- The resourceName.
-
getResourceNameBytes
public 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) = { ... }- Specified by:
getResourceNameBytesin interfaceAdGroupOrBuilder- Returns:
- The bytes for resourceName.
-
setResourceName
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) = { ... }- Parameters:
value- The resourceName to set.- Returns:
- This builder for chaining.
-
clearResourceName
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:
- This builder for chaining.
-
setResourceNameBytes
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) = { ... }- Parameters:
value- The bytes for resourceName to set.- Returns:
- This builder for chaining.
-
hasId
public boolean hasId()Output only. The ID of the ad group.
optional int64 id = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasIdin interfaceAdGroupOrBuilder- Returns:
- Whether the id field is set.
-
getId
public long getId()Output only. The ID of the ad group.
optional int64 id = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getIdin interfaceAdGroupOrBuilder- Returns:
- The id.
-
setId
Output only. The ID of the ad group.
optional int64 id = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The id to set.- Returns:
- This builder for chaining.
-
clearId
Output only. The ID of the ad group.
optional int64 id = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasName
public 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;- Specified by:
hasNamein interfaceAdGroupOrBuilder- Returns:
- Whether the name field is set.
-
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;- Specified by:
getNamein interfaceAdGroupOrBuilder- Returns:
- The name.
-
getNameBytes
public 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;- Specified by:
getNameBytesin interfaceAdGroupOrBuilder- Returns:
- The bytes for name.
-
setName
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;- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
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:
- This builder for chaining.
-
setNameBytes
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;- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
getStatusValue
public int getStatusValue()The status of the ad group.
.google.ads.googleads.v18.enums.AdGroupStatusEnum.AdGroupStatus status = 5;- Specified by:
getStatusValuein interfaceAdGroupOrBuilder- Returns:
- The enum numeric value on the wire for status.
-
setStatusValue
The status of the ad group.
.google.ads.googleads.v18.enums.AdGroupStatusEnum.AdGroupStatus status = 5;- Parameters:
value- The enum numeric value on the wire for status to set.- Returns:
- This builder for chaining.
-
getStatus
The status of the ad group.
.google.ads.googleads.v18.enums.AdGroupStatusEnum.AdGroupStatus status = 5;- Specified by:
getStatusin interfaceAdGroupOrBuilder- Returns:
- The status.
-
setStatus
The status of the ad group.
.google.ads.googleads.v18.enums.AdGroupStatusEnum.AdGroupStatus status = 5;- Parameters:
value- The status to set.- Returns:
- This builder for chaining.
-
clearStatus
The status of the ad group.
.google.ads.googleads.v18.enums.AdGroupStatusEnum.AdGroupStatus status = 5;- Returns:
- This builder for chaining.
-
getTypeValue
public int getTypeValue()Immutable. The type of the ad group.
.google.ads.googleads.v18.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getTypeValuein interfaceAdGroupOrBuilder- Returns:
- The enum numeric value on the wire for type.
-
setTypeValue
Immutable. The type of the ad group.
.google.ads.googleads.v18.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];- Parameters:
value- The enum numeric value on the wire for type to set.- Returns:
- This builder for chaining.
-
getType
Immutable. The type of the ad group.
.google.ads.googleads.v18.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getTypein interfaceAdGroupOrBuilder- Returns:
- The type.
-
setType
Immutable. The type of the ad group.
.google.ads.googleads.v18.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];- Parameters:
value- The type to set.- Returns:
- This builder for chaining.
-
clearType
Immutable. The type of the ad group.
.google.ads.googleads.v18.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];- Returns:
- This builder for chaining.
-
getAdRotationModeValue
public int getAdRotationModeValue()The ad rotation mode of the ad group.
.google.ads.googleads.v18.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;- Specified by:
getAdRotationModeValuein interfaceAdGroupOrBuilder- Returns:
- The enum numeric value on the wire for adRotationMode.
-
setAdRotationModeValue
The ad rotation mode of the ad group.
.google.ads.googleads.v18.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;- Parameters:
value- The enum numeric value on the wire for adRotationMode to set.- Returns:
- This builder for chaining.
-
getAdRotationMode
The ad rotation mode of the ad group.
.google.ads.googleads.v18.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;- Specified by:
getAdRotationModein interfaceAdGroupOrBuilder- Returns:
- The adRotationMode.
-
setAdRotationMode
The ad rotation mode of the ad group.
.google.ads.googleads.v18.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;- Parameters:
value- The adRotationMode to set.- Returns:
- This builder for chaining.
-
clearAdRotationMode
The ad rotation mode of the ad group.
.google.ads.googleads.v18.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;- Returns:
- This builder for chaining.
-
hasBaseAdGroup
public 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) = { ... }- Specified by:
hasBaseAdGroupin interfaceAdGroupOrBuilder- Returns:
- Whether the baseAdGroup field is set.
-
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) = { ... }- Specified by:
getBaseAdGroupin interfaceAdGroupOrBuilder- Returns:
- The baseAdGroup.
-
getBaseAdGroupBytes
public 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) = { ... }- Specified by:
getBaseAdGroupBytesin interfaceAdGroupOrBuilder- Returns:
- The bytes for baseAdGroup.
-
setBaseAdGroup
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) = { ... }- Parameters:
value- The baseAdGroup to set.- Returns:
- This builder for chaining.
-
clearBaseAdGroup
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:
- This builder for chaining.
-
setBaseAdGroupBytes
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) = { ... }- Parameters:
value- The bytes for baseAdGroup to set.- Returns:
- This builder for chaining.
-
hasTrackingUrlTemplate
public boolean hasTrackingUrlTemplate()The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;- Specified by:
hasTrackingUrlTemplatein interfaceAdGroupOrBuilder- Returns:
- Whether the trackingUrlTemplate field is set.
-
getTrackingUrlTemplate
The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;- Specified by:
getTrackingUrlTemplatein interfaceAdGroupOrBuilder- Returns:
- The trackingUrlTemplate.
-
getTrackingUrlTemplateBytes
public com.google.protobuf.ByteString getTrackingUrlTemplateBytes()The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;- Specified by:
getTrackingUrlTemplateBytesin interfaceAdGroupOrBuilder- Returns:
- The bytes for trackingUrlTemplate.
-
setTrackingUrlTemplate
The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;- Parameters:
value- The trackingUrlTemplate to set.- Returns:
- This builder for chaining.
-
clearTrackingUrlTemplate
The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;- Returns:
- This builder for chaining.
-
setTrackingUrlTemplateBytes
The URL template for constructing a tracking URL.
optional string tracking_url_template = 37;- Parameters:
value- The bytes for trackingUrlTemplate to set.- Returns:
- This builder for chaining.
-
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.v18.common.CustomParameter url_custom_parameters = 6;- Specified by:
getUrlCustomParametersListin interfaceAdGroupOrBuilder
-
getUrlCustomParametersCount
public 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.v18.common.CustomParameter url_custom_parameters = 6;- Specified by:
getUrlCustomParametersCountin interfaceAdGroupOrBuilder
-
getUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6;- Specified by:
getUrlCustomParametersin interfaceAdGroupOrBuilder
-
setUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
setUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
addUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
addUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
addUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
addUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
addAllUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
clearUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
removeUrlCustomParameters
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.v18.common.CustomParameter url_custom_parameters = 6; -
getUrlCustomParametersBuilder
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.v18.common.CustomParameter url_custom_parameters = 6; -
getUrlCustomParametersOrBuilder
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.v18.common.CustomParameter url_custom_parameters = 6;- Specified by:
getUrlCustomParametersOrBuilderin interfaceAdGroupOrBuilder
-
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.v18.common.CustomParameter url_custom_parameters = 6;- Specified by:
getUrlCustomParametersOrBuilderListin interfaceAdGroupOrBuilder
-
addUrlCustomParametersBuilder
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.v18.common.CustomParameter url_custom_parameters = 6; -
addUrlCustomParametersBuilder
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.v18.common.CustomParameter url_custom_parameters = 6; -
getUrlCustomParametersBuilderList
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.v18.common.CustomParameter url_custom_parameters = 6; -
hasCampaign
public boolean hasCampaign()Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Specified by:
hasCampaignin interfaceAdGroupOrBuilder- Returns:
- Whether the campaign field is set.
-
getCampaign
Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Specified by:
getCampaignin interfaceAdGroupOrBuilder- Returns:
- The campaign.
-
getCampaignBytes
public 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) = { ... }- Specified by:
getCampaignBytesin interfaceAdGroupOrBuilder- Returns:
- The bytes for campaign.
-
setCampaign
Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Parameters:
value- The campaign to set.- Returns:
- This builder for chaining.
-
clearCampaign
Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setCampaignBytes
Immutable. The campaign to which the ad group belongs.
optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for campaign to set.- Returns:
- This builder for chaining.
-
hasCpcBidMicros
public boolean hasCpcBidMicros()The maximum CPC (cost-per-click) bid.
optional int64 cpc_bid_micros = 39;- Specified by:
hasCpcBidMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the cpcBidMicros field is set.
-
getCpcBidMicros
public long getCpcBidMicros()The maximum CPC (cost-per-click) bid.
optional int64 cpc_bid_micros = 39;- Specified by:
getCpcBidMicrosin interfaceAdGroupOrBuilder- Returns:
- The cpcBidMicros.
-
setCpcBidMicros
The maximum CPC (cost-per-click) bid.
optional int64 cpc_bid_micros = 39;- Parameters:
value- The cpcBidMicros to set.- Returns:
- This builder for chaining.
-
clearCpcBidMicros
The maximum CPC (cost-per-click) bid.
optional int64 cpc_bid_micros = 39;- Returns:
- This builder for chaining.
-
hasEffectiveCpcBidMicros
public 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];- Specified by:
hasEffectiveCpcBidMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the effectiveCpcBidMicros field is set.
-
getEffectiveCpcBidMicros
public 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];- Specified by:
getEffectiveCpcBidMicrosin interfaceAdGroupOrBuilder- Returns:
- The effectiveCpcBidMicros.
-
setEffectiveCpcBidMicros
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];- Parameters:
value- The effectiveCpcBidMicros to set.- Returns:
- This builder for chaining.
-
clearEffectiveCpcBidMicros
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:
- This builder for chaining.
-
hasCpmBidMicros
public boolean hasCpmBidMicros()The maximum CPM (cost-per-thousand viewable impressions) bid.
optional int64 cpm_bid_micros = 40;- Specified by:
hasCpmBidMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the cpmBidMicros field is set.
-
getCpmBidMicros
public long getCpmBidMicros()The maximum CPM (cost-per-thousand viewable impressions) bid.
optional int64 cpm_bid_micros = 40;- Specified by:
getCpmBidMicrosin interfaceAdGroupOrBuilder- Returns:
- The cpmBidMicros.
-
setCpmBidMicros
The maximum CPM (cost-per-thousand viewable impressions) bid.
optional int64 cpm_bid_micros = 40;- Parameters:
value- The cpmBidMicros to set.- Returns:
- This builder for chaining.
-
clearCpmBidMicros
The maximum CPM (cost-per-thousand viewable impressions) bid.
optional int64 cpm_bid_micros = 40;- Returns:
- This builder for chaining.
-
hasTargetCpaMicros
public 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;- Specified by:
hasTargetCpaMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the targetCpaMicros field is set.
-
getTargetCpaMicros
public 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;- Specified by:
getTargetCpaMicrosin interfaceAdGroupOrBuilder- Returns:
- The targetCpaMicros.
-
setTargetCpaMicros
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;- Parameters:
value- The targetCpaMicros to set.- Returns:
- This builder for chaining.
-
clearTargetCpaMicros
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:
- This builder for chaining.
-
hasCpvBidMicros
public boolean hasCpvBidMicros()The CPV (cost-per-view) bid.
optional int64 cpv_bid_micros = 42;- Specified by:
hasCpvBidMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the cpvBidMicros field is set.
-
getCpvBidMicros
public long getCpvBidMicros()The CPV (cost-per-view) bid.
optional int64 cpv_bid_micros = 42;- Specified by:
getCpvBidMicrosin interfaceAdGroupOrBuilder- Returns:
- The cpvBidMicros.
-
setCpvBidMicros
The CPV (cost-per-view) bid.
optional int64 cpv_bid_micros = 42;- Parameters:
value- The cpvBidMicros to set.- Returns:
- This builder for chaining.
-
clearCpvBidMicros
The CPV (cost-per-view) bid.
optional int64 cpv_bid_micros = 42;- Returns:
- This builder for chaining.
-
hasTargetCpmMicros
public 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;- Specified by:
hasTargetCpmMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the targetCpmMicros field is set.
-
getTargetCpmMicros
public 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;- Specified by:
getTargetCpmMicrosin interfaceAdGroupOrBuilder- Returns:
- The targetCpmMicros.
-
setTargetCpmMicros
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;- Parameters:
value- The targetCpmMicros to set.- Returns:
- This builder for chaining.
-
clearTargetCpmMicros
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:
- This builder for chaining.
-
hasTargetRoas
public 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;- Specified by:
hasTargetRoasin interfaceAdGroupOrBuilder- Returns:
- Whether the targetRoas field is set.
-
getTargetRoas
public 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;- Specified by:
getTargetRoasin interfaceAdGroupOrBuilder- Returns:
- The targetRoas.
-
setTargetRoas
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;- Parameters:
value- The targetRoas to set.- Returns:
- This builder for chaining.
-
clearTargetRoas
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:
- This builder for chaining.
-
hasPercentCpcBidMicros
public 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;- Specified by:
hasPercentCpcBidMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the percentCpcBidMicros field is set.
-
getPercentCpcBidMicros
public 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;- Specified by:
getPercentCpcBidMicrosin interfaceAdGroupOrBuilder- Returns:
- The percentCpcBidMicros.
-
setPercentCpcBidMicros
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;- Parameters:
value- The percentCpcBidMicros to set.- Returns:
- This builder for chaining.
-
clearPercentCpcBidMicros
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:
- This builder for chaining.
-
hasFixedCpmMicros
public boolean hasFixedCpmMicros()The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.
optional int64 fixed_cpm_micros = 64;- Specified by:
hasFixedCpmMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the fixedCpmMicros field is set.
-
getFixedCpmMicros
public long getFixedCpmMicros()The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.
optional int64 fixed_cpm_micros = 64;- Specified by:
getFixedCpmMicrosin interfaceAdGroupOrBuilder- Returns:
- The fixedCpmMicros.
-
setFixedCpmMicros
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.
optional int64 fixed_cpm_micros = 64;- Parameters:
value- The fixedCpmMicros to set.- Returns:
- This builder for chaining.
-
clearFixedCpmMicros
The fixed amount in micros that the advertiser pays for every thousand impressions of the ad.
optional int64 fixed_cpm_micros = 64;- Returns:
- This builder for chaining.
-
hasTargetCpvMicros
public boolean hasTargetCpvMicros()Average amount in micros that the advertiser is willing to pay for every ad view.
optional int64 target_cpv_micros = 65;- Specified by:
hasTargetCpvMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the targetCpvMicros field is set.
-
getTargetCpvMicros
public long getTargetCpvMicros()Average amount in micros that the advertiser is willing to pay for every ad view.
optional int64 target_cpv_micros = 65;- Specified by:
getTargetCpvMicrosin interfaceAdGroupOrBuilder- Returns:
- The targetCpvMicros.
-
setTargetCpvMicros
Average amount in micros that the advertiser is willing to pay for every ad view.
optional int64 target_cpv_micros = 65;- Parameters:
value- The targetCpvMicros to set.- Returns:
- This builder for chaining.
-
clearTargetCpvMicros
Average amount in micros that the advertiser is willing to pay for every ad view.
optional int64 target_cpv_micros = 65;- Returns:
- This builder for chaining.
-
getOptimizedTargetingEnabled
public boolean getOptimizedTargetingEnabled()True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
bool optimized_targeting_enabled = 59;- Specified by:
getOptimizedTargetingEnabledin interfaceAdGroupOrBuilder- Returns:
- The optimizedTargetingEnabled.
-
setOptimizedTargetingEnabled
True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
bool optimized_targeting_enabled = 59;- Parameters:
value- The optimizedTargetingEnabled to set.- Returns:
- This builder for chaining.
-
clearOptimizedTargetingEnabled
True if optimized targeting is enabled. Optimized Targeting is the replacement for Audience Expansion.
bool optimized_targeting_enabled = 59;- Returns:
- This builder for chaining.
-
getExcludeDemographicExpansion
public boolean getExcludeDemographicExpansion()When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.
bool exclude_demographic_expansion = 67;- Specified by:
getExcludeDemographicExpansionin interfaceAdGroupOrBuilder- Returns:
- The excludeDemographicExpansion.
-
setExcludeDemographicExpansion
When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.
bool exclude_demographic_expansion = 67;- Parameters:
value- The excludeDemographicExpansion to set.- Returns:
- This builder for chaining.
-
clearExcludeDemographicExpansion
When this value is true, demographics will be excluded from the types of targeting which are expanded when optimized_targeting_enabled is true. When optimized_targeting_enabled is false, this field is ignored. Default is false.
bool exclude_demographic_expansion = 67;- Returns:
- This builder for chaining.
-
getDisplayCustomBidDimensionValue
public 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.v18.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;- Specified by:
getDisplayCustomBidDimensionValuein interfaceAdGroupOrBuilder- Returns:
- The enum numeric value on the wire for displayCustomBidDimension.
-
setDisplayCustomBidDimensionValue
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.v18.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;- Parameters:
value- The enum numeric value on the wire for displayCustomBidDimension to set.- Returns:
- This builder for chaining.
-
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.v18.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;- Specified by:
getDisplayCustomBidDimensionin interfaceAdGroupOrBuilder- Returns:
- The displayCustomBidDimension.
-
setDisplayCustomBidDimension
public AdGroup.Builder setDisplayCustomBidDimension(TargetingDimensionEnum.TargetingDimension value) 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.v18.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;- Parameters:
value- The displayCustomBidDimension to set.- Returns:
- This builder for chaining.
-
clearDisplayCustomBidDimension
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.v18.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;- Returns:
- This builder for chaining.
-
hasFinalUrlSuffix
public boolean hasFinalUrlSuffix()URL template for appending params to Final URL.
optional string final_url_suffix = 46;- Specified by:
hasFinalUrlSuffixin interfaceAdGroupOrBuilder- Returns:
- Whether the finalUrlSuffix field is set.
-
getFinalUrlSuffix
URL template for appending params to Final URL.
optional string final_url_suffix = 46;- Specified by:
getFinalUrlSuffixin interfaceAdGroupOrBuilder- Returns:
- The finalUrlSuffix.
-
getFinalUrlSuffixBytes
public com.google.protobuf.ByteString getFinalUrlSuffixBytes()URL template for appending params to Final URL.
optional string final_url_suffix = 46;- Specified by:
getFinalUrlSuffixBytesin interfaceAdGroupOrBuilder- Returns:
- The bytes for finalUrlSuffix.
-
setFinalUrlSuffix
URL template for appending params to Final URL.
optional string final_url_suffix = 46;- Parameters:
value- The finalUrlSuffix to set.- Returns:
- This builder for chaining.
-
clearFinalUrlSuffix
URL template for appending params to Final URL.
optional string final_url_suffix = 46;- Returns:
- This builder for chaining.
-
setFinalUrlSuffixBytes
URL template for appending params to Final URL.
optional string final_url_suffix = 46;- Parameters:
value- The bytes for finalUrlSuffix to set.- Returns:
- This builder for chaining.
-
hasTargetingSetting
public boolean hasTargetingSetting()Setting for targeting related features.
.google.ads.googleads.v18.common.TargetingSetting targeting_setting = 25;- Specified by:
hasTargetingSettingin interfaceAdGroupOrBuilder- Returns:
- Whether the targetingSetting field is set.
-
getTargetingSetting
Setting for targeting related features.
.google.ads.googleads.v18.common.TargetingSetting targeting_setting = 25;- Specified by:
getTargetingSettingin interfaceAdGroupOrBuilder- Returns:
- The targetingSetting.
-
setTargetingSetting
Setting for targeting related features.
.google.ads.googleads.v18.common.TargetingSetting targeting_setting = 25; -
setTargetingSetting
Setting for targeting related features.
.google.ads.googleads.v18.common.TargetingSetting targeting_setting = 25; -
mergeTargetingSetting
Setting for targeting related features.
.google.ads.googleads.v18.common.TargetingSetting targeting_setting = 25; -
clearTargetingSetting
Setting for targeting related features.
.google.ads.googleads.v18.common.TargetingSetting targeting_setting = 25; -
getTargetingSettingBuilder
Setting for targeting related features.
.google.ads.googleads.v18.common.TargetingSetting targeting_setting = 25; -
getTargetingSettingOrBuilder
Setting for targeting related features.
.google.ads.googleads.v18.common.TargetingSetting targeting_setting = 25;- Specified by:
getTargetingSettingOrBuilderin interfaceAdGroupOrBuilder
-
hasAudienceSetting
public boolean hasAudienceSetting()Immutable. Setting for audience related features.
.google.ads.googleads.v18.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
hasAudienceSettingin interfaceAdGroupOrBuilder- Returns:
- Whether the audienceSetting field is set.
-
getAudienceSetting
Immutable. Setting for audience related features.
.google.ads.googleads.v18.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getAudienceSettingin interfaceAdGroupOrBuilder- Returns:
- The audienceSetting.
-
setAudienceSetting
Immutable. Setting for audience related features.
.google.ads.googleads.v18.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE]; -
setAudienceSetting
Immutable. Setting for audience related features.
.google.ads.googleads.v18.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE]; -
mergeAudienceSetting
Immutable. Setting for audience related features.
.google.ads.googleads.v18.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE]; -
clearAudienceSetting
Immutable. Setting for audience related features.
.google.ads.googleads.v18.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE]; -
getAudienceSettingBuilder
Immutable. Setting for audience related features.
.google.ads.googleads.v18.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE]; -
getAudienceSettingOrBuilder
Immutable. Setting for audience related features.
.google.ads.googleads.v18.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getAudienceSettingOrBuilderin interfaceAdGroupOrBuilder
-
hasEffectiveTargetCpaMicros
public 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];- Specified by:
hasEffectiveTargetCpaMicrosin interfaceAdGroupOrBuilder- Returns:
- Whether the effectiveTargetCpaMicros field is set.
-
getEffectiveTargetCpaMicros
public 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];- Specified by:
getEffectiveTargetCpaMicrosin interfaceAdGroupOrBuilder- Returns:
- The effectiveTargetCpaMicros.
-
setEffectiveTargetCpaMicros
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];- Parameters:
value- The effectiveTargetCpaMicros to set.- Returns:
- This builder for chaining.
-
clearEffectiveTargetCpaMicros
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:
- This builder for chaining.
-
getEffectiveTargetCpaSourceValue
public int getEffectiveTargetCpaSourceValue()Output only. Source of the effective target CPA. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEffectiveTargetCpaSourceValuein interfaceAdGroupOrBuilder- Returns:
- The enum numeric value on the wire for effectiveTargetCpaSource.
-
setEffectiveTargetCpaSourceValue
Output only. Source of the effective target CPA. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for effectiveTargetCpaSource to set.- Returns:
- This builder for chaining.
-
getEffectiveTargetCpaSource
Output only. Source of the effective target CPA. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEffectiveTargetCpaSourcein interfaceAdGroupOrBuilder- Returns:
- The effectiveTargetCpaSource.
-
setEffectiveTargetCpaSource
Output only. Source of the effective target CPA. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The effectiveTargetCpaSource to set.- Returns:
- This builder for chaining.
-
clearEffectiveTargetCpaSource
Output only. Source of the effective target CPA. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
hasEffectiveTargetRoas
public 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];- Specified by:
hasEffectiveTargetRoasin interfaceAdGroupOrBuilder- Returns:
- Whether the effectiveTargetRoas field is set.
-
getEffectiveTargetRoas
public 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];- Specified by:
getEffectiveTargetRoasin interfaceAdGroupOrBuilder- Returns:
- The effectiveTargetRoas.
-
setEffectiveTargetRoas
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];- Parameters:
value- The effectiveTargetRoas to set.- Returns:
- This builder for chaining.
-
clearEffectiveTargetRoas
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:
- This builder for chaining.
-
getEffectiveTargetRoasSourceValue
public int getEffectiveTargetRoasSourceValue()Output only. Source of the effective target ROAS. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEffectiveTargetRoasSourceValuein interfaceAdGroupOrBuilder- Returns:
- The enum numeric value on the wire for effectiveTargetRoasSource.
-
setEffectiveTargetRoasSourceValue
Output only. Source of the effective target ROAS. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for effectiveTargetRoasSource to set.- Returns:
- This builder for chaining.
-
getEffectiveTargetRoasSource
Output only. Source of the effective target ROAS. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEffectiveTargetRoasSourcein interfaceAdGroupOrBuilder- Returns:
- The effectiveTargetRoasSource.
-
setEffectiveTargetRoasSource
Output only. Source of the effective target ROAS. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The effectiveTargetRoasSource to set.- Returns:
- This builder for chaining.
-
clearEffectiveTargetRoasSource
Output only. Source of the effective target ROAS. This field is read-only.
.google.ads.googleads.v18.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getLabelsList
public com.google.protobuf.ProtocolStringList 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) = { ... }- Specified by:
getLabelsListin interfaceAdGroupOrBuilder- Returns:
- A list containing the labels.
-
getLabelsCount
public 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) = { ... }- Specified by:
getLabelsCountin interfaceAdGroupOrBuilder- Returns:
- The count of labels.
-
getLabels
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) = { ... }- Specified by:
getLabelsin interfaceAdGroupOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The labels at the given index.
-
getLabelsBytes
public 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) = { ... }- Specified by:
getLabelsBytesin interfaceAdGroupOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the labels at the given index.
-
setLabels
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 to set the value at.value- The labels to set.- Returns:
- This builder for chaining.
-
addLabels
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:
value- The labels to add.- Returns:
- This builder for chaining.
-
addAllLabels
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:
values- The labels to add.- Returns:
- This builder for chaining.
-
clearLabels
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:
- This builder for chaining.
-
addLabelsBytes
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:
value- The bytes of the labels to add.- Returns:
- This builder for chaining.
-
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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Specified by:
getExcludedParentAssetFieldTypesListin interfaceAdGroupOrBuilder- Returns:
- A list containing the excludedParentAssetFieldTypes.
-
getExcludedParentAssetFieldTypesCount
public 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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Specified by:
getExcludedParentAssetFieldTypesCountin interfaceAdGroupOrBuilder- Returns:
- The count of excludedParentAssetFieldTypes.
-
getExcludedParentAssetFieldTypes
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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Specified by:
getExcludedParentAssetFieldTypesin interfaceAdGroupOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The excludedParentAssetFieldTypes at the given index.
-
setExcludedParentAssetFieldTypes
public AdGroup.Builder setExcludedParentAssetFieldTypes(int index, AssetFieldTypeEnum.AssetFieldType value) 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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Parameters:
index- The index to set the value at.value- The excludedParentAssetFieldTypes to set.- Returns:
- This builder for chaining.
-
addExcludedParentAssetFieldTypes
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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Parameters:
value- The excludedParentAssetFieldTypes to add.- Returns:
- This builder for chaining.
-
addAllExcludedParentAssetFieldTypes
public AdGroup.Builder addAllExcludedParentAssetFieldTypes(Iterable<? extends AssetFieldTypeEnum.AssetFieldType> values) 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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Parameters:
values- The excludedParentAssetFieldTypes to add.- Returns:
- This builder for chaining.
-
clearExcludedParentAssetFieldTypes
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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Returns:
- This builder for chaining.
-
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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Specified by:
getExcludedParentAssetFieldTypesValueListin interfaceAdGroupOrBuilder- Returns:
- A list containing the enum numeric values on the wire for excludedParentAssetFieldTypes.
-
getExcludedParentAssetFieldTypesValue
public 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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Specified by:
getExcludedParentAssetFieldTypesValuein interfaceAdGroupOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of excludedParentAssetFieldTypes at the given index.
-
setExcludedParentAssetFieldTypesValue
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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Parameters:
index- The index to set the value at.value- The enum numeric value on the wire for excludedParentAssetFieldTypes to set.- Returns:
- This builder for chaining.
-
addExcludedParentAssetFieldTypesValue
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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Parameters:
value- The enum numeric value on the wire for excludedParentAssetFieldTypes to add.- Returns:
- This builder for chaining.
-
addAllExcludedParentAssetFieldTypesValue
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.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;- Parameters:
values- The enum numeric values on the wire for excludedParentAssetFieldTypes to add.- Returns:
- This builder for chaining.
-
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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Specified by:
getExcludedParentAssetSetTypesListin interfaceAdGroupOrBuilder- Returns:
- A list containing the excludedParentAssetSetTypes.
-
getExcludedParentAssetSetTypesCount
public 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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Specified by:
getExcludedParentAssetSetTypesCountin interfaceAdGroupOrBuilder- Returns:
- The count of excludedParentAssetSetTypes.
-
getExcludedParentAssetSetTypes
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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Specified by:
getExcludedParentAssetSetTypesin interfaceAdGroupOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The excludedParentAssetSetTypes at the given index.
-
setExcludedParentAssetSetTypes
public AdGroup.Builder setExcludedParentAssetSetTypes(int index, AssetSetTypeEnum.AssetSetType value) 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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Parameters:
index- The index to set the value at.value- The excludedParentAssetSetTypes to set.- Returns:
- This builder for chaining.
-
addExcludedParentAssetSetTypes
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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Parameters:
value- The excludedParentAssetSetTypes to add.- Returns:
- This builder for chaining.
-
addAllExcludedParentAssetSetTypes
public AdGroup.Builder addAllExcludedParentAssetSetTypes(Iterable<? extends AssetSetTypeEnum.AssetSetType> values) 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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Parameters:
values- The excludedParentAssetSetTypes to add.- Returns:
- This builder for chaining.
-
clearExcludedParentAssetSetTypes
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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Returns:
- This builder for chaining.
-
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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Specified by:
getExcludedParentAssetSetTypesValueListin interfaceAdGroupOrBuilder- Returns:
- A list containing the enum numeric values on the wire for excludedParentAssetSetTypes.
-
getExcludedParentAssetSetTypesValue
public 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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Specified by:
getExcludedParentAssetSetTypesValuein interfaceAdGroupOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of excludedParentAssetSetTypes at the given index.
-
setExcludedParentAssetSetTypesValue
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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Parameters:
index- The index to set the value at.value- The enum numeric value on the wire for excludedParentAssetSetTypes to set.- Returns:
- This builder for chaining.
-
addExcludedParentAssetSetTypesValue
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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Parameters:
value- The enum numeric value on the wire for excludedParentAssetSetTypes to add.- Returns:
- This builder for chaining.
-
addAllExcludedParentAssetSetTypesValue
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.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 58;- Parameters:
values- The enum numeric values on the wire for excludedParentAssetSetTypes to add.- Returns:
- This builder for chaining.
-
getPrimaryStatusValue
public int getPrimaryStatusValue()Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
.google.ads.googleads.v18.enums.AdGroupPrimaryStatusEnum.AdGroupPrimaryStatus primary_status = 62 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPrimaryStatusValuein interfaceAdGroupOrBuilder- Returns:
- The enum numeric value on the wire for primaryStatus.
-
setPrimaryStatusValue
Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
.google.ads.googleads.v18.enums.AdGroupPrimaryStatusEnum.AdGroupPrimaryStatus primary_status = 62 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for primaryStatus to set.- Returns:
- This builder for chaining.
-
getPrimaryStatus
Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
.google.ads.googleads.v18.enums.AdGroupPrimaryStatusEnum.AdGroupPrimaryStatus primary_status = 62 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPrimaryStatusin interfaceAdGroupOrBuilder- Returns:
- The primaryStatus.
-
setPrimaryStatus
Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
.google.ads.googleads.v18.enums.AdGroupPrimaryStatusEnum.AdGroupPrimaryStatus primary_status = 62 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The primaryStatus to set.- Returns:
- This builder for chaining.
-
clearPrimaryStatus
Output only. Provides aggregated view into why an ad group is not serving or not serving optimally.
.google.ads.googleads.v18.enums.AdGroupPrimaryStatusEnum.AdGroupPrimaryStatus primary_status = 62 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getPrimaryStatusReasonsList
public List<AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason> getPrimaryStatusReasonsList()Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPrimaryStatusReasonsListin interfaceAdGroupOrBuilder- Returns:
- A list containing the primaryStatusReasons.
-
getPrimaryStatusReasonsCount
public int getPrimaryStatusReasonsCount()Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPrimaryStatusReasonsCountin interfaceAdGroupOrBuilder- Returns:
- The count of primaryStatusReasons.
-
getPrimaryStatusReasons
Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPrimaryStatusReasonsin interfaceAdGroupOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The primaryStatusReasons at the given index.
-
setPrimaryStatusReasons
public AdGroup.Builder setPrimaryStatusReasons(int index, AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason value) Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
index- The index to set the value at.value- The primaryStatusReasons to set.- Returns:
- This builder for chaining.
-
addPrimaryStatusReasons
public AdGroup.Builder addPrimaryStatusReasons(AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason value) Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The primaryStatusReasons to add.- Returns:
- This builder for chaining.
-
addAllPrimaryStatusReasons
public AdGroup.Builder addAllPrimaryStatusReasons(Iterable<? extends AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason> values) Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
values- The primaryStatusReasons to add.- Returns:
- This builder for chaining.
-
clearPrimaryStatusReasons
Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- This builder for chaining.
-
getPrimaryStatusReasonsValueList
Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPrimaryStatusReasonsValueListin interfaceAdGroupOrBuilder- Returns:
- A list containing the enum numeric values on the wire for primaryStatusReasons.
-
getPrimaryStatusReasonsValue
public int getPrimaryStatusReasonsValue(int index) Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getPrimaryStatusReasonsValuein interfaceAdGroupOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of primaryStatusReasons at the given index.
-
setPrimaryStatusReasonsValue
Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
index- The index to set the value at.value- The enum numeric value on the wire for primaryStatusReasons to set.- Returns:
- This builder for chaining.
-
addPrimaryStatusReasonsValue
Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
value- The enum numeric value on the wire for primaryStatusReasons to add.- Returns:
- This builder for chaining.
-
addAllPrimaryStatusReasonsValue
Output only. Provides reasons for why an ad group is not serving or not serving optimally.
repeated .google.ads.googleads.v18.enums.AdGroupPrimaryStatusReasonEnum.AdGroupPrimaryStatusReason primary_status_reasons = 63 [(.google.api.field_behavior) = OUTPUT_ONLY];- Parameters:
values- The enum numeric values on the wire for primaryStatusReasons to add.- Returns:
- This builder for chaining.
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<AdGroup.Builder>
-