Class AdGroup
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.AdGroup
- All Implemented Interfaces:
AdGroupOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
public final class AdGroup
extends com.google.protobuf.GeneratedMessageV3
implements AdGroupOrBuilder
An ad group.Protobuf type
google.ads.googleads.v18.resources.AdGroup- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classSettings for the audience targeting.static interfacestatic final classAn ad group.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanThe ad rotation mode of the ad group.intThe ad rotation mode of the ad group.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 AdGroupstatic final com.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.com.google.protobuf.Parser<AdGroup>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.intThe 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.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`.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.inthashCode()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 booleanstatic AdGroup.Builderstatic AdGroup.BuildernewBuilder(AdGroup prototype) protected AdGroup.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static AdGroupparseDelimitedFrom(InputStream input) static AdGroupparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AdGroupparseFrom(byte[] data) static AdGroupparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AdGroupparseFrom(com.google.protobuf.ByteString data) static AdGroupparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AdGroupparseFrom(com.google.protobuf.CodedInputStream input) static AdGroupparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AdGroupparseFrom(InputStream input) static AdGroupparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AdGroupparseFrom(ByteBuffer data) static AdGroupparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<AdGroup>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
RESOURCE_NAME_FIELD_NUMBER
public static final int RESOURCE_NAME_FIELD_NUMBER- See Also:
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER- See Also:
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER- See Also:
-
AD_ROTATION_MODE_FIELD_NUMBER
public static final int AD_ROTATION_MODE_FIELD_NUMBER- See Also:
-
BASE_AD_GROUP_FIELD_NUMBER
public static final int BASE_AD_GROUP_FIELD_NUMBER- See Also:
-
TRACKING_URL_TEMPLATE_FIELD_NUMBER
public static final int TRACKING_URL_TEMPLATE_FIELD_NUMBER- See Also:
-
URL_CUSTOM_PARAMETERS_FIELD_NUMBER
public static final int URL_CUSTOM_PARAMETERS_FIELD_NUMBER- See Also:
-
CAMPAIGN_FIELD_NUMBER
public static final int CAMPAIGN_FIELD_NUMBER- See Also:
-
CPC_BID_MICROS_FIELD_NUMBER
public static final int CPC_BID_MICROS_FIELD_NUMBER- See Also:
-
EFFECTIVE_CPC_BID_MICROS_FIELD_NUMBER
public static final int EFFECTIVE_CPC_BID_MICROS_FIELD_NUMBER- See Also:
-
CPM_BID_MICROS_FIELD_NUMBER
public static final int CPM_BID_MICROS_FIELD_NUMBER- See Also:
-
TARGET_CPA_MICROS_FIELD_NUMBER
public static final int TARGET_CPA_MICROS_FIELD_NUMBER- See Also:
-
CPV_BID_MICROS_FIELD_NUMBER
public static final int CPV_BID_MICROS_FIELD_NUMBER- See Also:
-
TARGET_CPM_MICROS_FIELD_NUMBER
public static final int TARGET_CPM_MICROS_FIELD_NUMBER- See Also:
-
TARGET_ROAS_FIELD_NUMBER
public static final int TARGET_ROAS_FIELD_NUMBER- See Also:
-
PERCENT_CPC_BID_MICROS_FIELD_NUMBER
public static final int PERCENT_CPC_BID_MICROS_FIELD_NUMBER- See Also:
-
FIXED_CPM_MICROS_FIELD_NUMBER
public static final int FIXED_CPM_MICROS_FIELD_NUMBER- See Also:
-
TARGET_CPV_MICROS_FIELD_NUMBER
public static final int TARGET_CPV_MICROS_FIELD_NUMBER- See Also:
-
OPTIMIZED_TARGETING_ENABLED_FIELD_NUMBER
public static final int OPTIMIZED_TARGETING_ENABLED_FIELD_NUMBER- See Also:
-
EXCLUDE_DEMOGRAPHIC_EXPANSION_FIELD_NUMBER
public static final int EXCLUDE_DEMOGRAPHIC_EXPANSION_FIELD_NUMBER- See Also:
-
DISPLAY_CUSTOM_BID_DIMENSION_FIELD_NUMBER
public static final int DISPLAY_CUSTOM_BID_DIMENSION_FIELD_NUMBER- See Also:
-
FINAL_URL_SUFFIX_FIELD_NUMBER
public static final int FINAL_URL_SUFFIX_FIELD_NUMBER- See Also:
-
TARGETING_SETTING_FIELD_NUMBER
public static final int TARGETING_SETTING_FIELD_NUMBER- See Also:
-
AUDIENCE_SETTING_FIELD_NUMBER
public static final int AUDIENCE_SETTING_FIELD_NUMBER- See Also:
-
EFFECTIVE_TARGET_CPA_MICROS_FIELD_NUMBER
public static final int EFFECTIVE_TARGET_CPA_MICROS_FIELD_NUMBER- See Also:
-
EFFECTIVE_TARGET_CPA_SOURCE_FIELD_NUMBER
public static final int EFFECTIVE_TARGET_CPA_SOURCE_FIELD_NUMBER- See Also:
-
EFFECTIVE_TARGET_ROAS_FIELD_NUMBER
public static final int EFFECTIVE_TARGET_ROAS_FIELD_NUMBER- See Also:
-
EFFECTIVE_TARGET_ROAS_SOURCE_FIELD_NUMBER
public static final int EFFECTIVE_TARGET_ROAS_SOURCE_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
EXCLUDED_PARENT_ASSET_FIELD_TYPES_FIELD_NUMBER
public static final int EXCLUDED_PARENT_ASSET_FIELD_TYPES_FIELD_NUMBER- See Also:
-
EXCLUDED_PARENT_ASSET_SET_TYPES_FIELD_NUMBER
public static final int EXCLUDED_PARENT_ASSET_SET_TYPES_FIELD_NUMBER- See Also:
-
PRIMARY_STATUS_FIELD_NUMBER
public static final int PRIMARY_STATUS_FIELD_NUMBER- See Also:
-
PRIMARY_STATUS_REASONS_FIELD_NUMBER
public static final int PRIMARY_STATUS_REASONS_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
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
-
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.
-
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.
-
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.
-
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.
-
getStatus
The status of the ad group.
.google.ads.googleads.v18.enums.AdGroupStatusEnum.AdGroupStatus status = 5;- Specified by:
getStatusin interfaceAdGroupOrBuilder- Returns:
- The status.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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
-
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
-
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
-
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
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static AdGroup parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AdGroup parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AdGroup parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AdGroup parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AdGroup parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AdGroup parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static AdGroup parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static AdGroup parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static AdGroup parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected AdGroup.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-