Package com.google.ads.googleads.v10.resources

Class AdGroup

  • All Implemented Interfaces:
    AdGroupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class AdGroup
extends com.google.protobuf.GeneratedMessageV3
implements AdGroupOrBuilder
     An ad group.
    Protobuf type google.ads.googleads.v10.resources.AdGroup
    See Also:
    Serialized Form

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AD_ROTATION_MODE_FIELD_NUMBER

        public static final int AD_ROTATION_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BASE_AD_GROUP_FIELD_NUMBER

        public static final int BASE_AD_GROUP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRACKING_URL_TEMPLATE_FIELD_NUMBER

        public static final int TRACKING_URL_TEMPLATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • URL_CUSTOM_PARAMETERS_FIELD_NUMBER

        public static final int URL_CUSTOM_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CPC_BID_MICROS_FIELD_NUMBER

        public static final int CPC_BID_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EFFECTIVE_CPC_BID_MICROS_FIELD_NUMBER

        public static final int EFFECTIVE_CPC_BID_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CPM_BID_MICROS_FIELD_NUMBER

        public static final int CPM_BID_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_CPA_MICROS_FIELD_NUMBER

        public static final int TARGET_CPA_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CPV_BID_MICROS_FIELD_NUMBER

        public static final int CPV_BID_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_CPM_MICROS_FIELD_NUMBER

        public static final int TARGET_CPM_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_ROAS_FIELD_NUMBER

        public static final int TARGET_ROAS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PERCENT_CPC_BID_MICROS_FIELD_NUMBER

        public static final int PERCENT_CPC_BID_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPLORER_AUTO_OPTIMIZER_SETTING_FIELD_NUMBER

        public static final int EXPLORER_AUTO_OPTIMIZER_SETTING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_CUSTOM_BID_DIMENSION_FIELD_NUMBER

        public static final int DISPLAY_CUSTOM_BID_DIMENSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FINAL_URL_SUFFIX_FIELD_NUMBER

        public static final int FINAL_URL_SUFFIX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGETING_SETTING_FIELD_NUMBER

        public static final int TARGETING_SETTING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUDIENCE_SETTING_FIELD_NUMBER

        public static final int AUDIENCE_SETTING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EFFECTIVE_TARGET_CPA_MICROS_FIELD_NUMBER

        public static final int EFFECTIVE_TARGET_CPA_MICROS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EFFECTIVE_TARGET_CPA_SOURCE_FIELD_NUMBER

        public static final int EFFECTIVE_TARGET_CPA_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EFFECTIVE_TARGET_ROAS_FIELD_NUMBER

        public static final int EFFECTIVE_TARGET_ROAS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EFFECTIVE_TARGET_ROAS_SOURCE_FIELD_NUMBER

        public static final int EFFECTIVE_TARGET_ROAS_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXCLUDED_PARENT_ASSET_FIELD_TYPES_FIELD_NUMBER

        public static final int EXCLUDED_PARENT_ASSET_FIELD_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the ad group.
 Ad group resource names have the form:
 `customers/{customer_id}/adGroups/{ad_group_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface AdGroupOrBuilder
        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:
        getResourceNameBytes in interface AdGroupOrBuilder
        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:
        hasId in interface AdGroupOrBuilder
        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:
        getId in interface AdGroupOrBuilder
        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:
        hasName in interface AdGroupOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public java.lang.String getName()
         The name of the ad group.
 This field is required and should not be empty when creating new ad
 groups.
 It must contain fewer than 255 UTF-8 full-width characters.
 It must not contain any null (code point 0x0), NL line feed
 (code point 0xA) or carriage return (code point 0xD) characters.
        optional string name = 35;
        Specified by:
        getName in interface AdGroupOrBuilder
        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:
        getNameBytes in interface AdGroupOrBuilder
        Returns:
        The bytes for name.

      • getStatusValue

        public int getStatusValue()
         The status of the ad group.
        .google.ads.googleads.v10.enums.AdGroupStatusEnum.AdGroupStatus status = 5;
        Specified by:
        getStatusValue in interface AdGroupOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getTypeValue

        public int getTypeValue()
         Immutable. The type of the ad group.
        .google.ads.googleads.v10.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTypeValue in interface AdGroupOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getType

        public AdGroupTypeEnum.AdGroupType getType()
         Immutable. The type of the ad group.
        .google.ads.googleads.v10.enums.AdGroupTypeEnum.AdGroupType type = 12 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getType in interface AdGroupOrBuilder
        Returns:
        The type.

      • getAdRotationModeValue

        public int getAdRotationModeValue()
         The ad rotation mode of the ad group.
        .google.ads.googleads.v10.enums.AdGroupAdRotationModeEnum.AdGroupAdRotationMode ad_rotation_mode = 22;
        Specified by:
        getAdRotationModeValue in interface AdGroupOrBuilder
        Returns:
        The enum numeric value on the wire for 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:
        hasBaseAdGroup in interface AdGroupOrBuilder
        Returns:
        Whether the baseAdGroup field is set.

      • getBaseAdGroup

        public java.lang.String getBaseAdGroup()
         Output only. For draft or experiment ad groups, this field is the resource name of the
 base ad group from which this ad group was created. If a draft or
 experiment ad group does not have a base ad group, then this field is null.
 For base ad groups, this field equals the ad group resource name.
 This field is read-only.
        optional string base_ad_group = 36 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getBaseAdGroup in interface AdGroupOrBuilder
        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:
        getBaseAdGroupBytes in interface AdGroupOrBuilder
        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:
        hasTrackingUrlTemplate in interface AdGroupOrBuilder
        Returns:
        Whether the trackingUrlTemplate field is set.

      • getTrackingUrlTemplate

        public java.lang.String getTrackingUrlTemplate()
         The URL template for constructing a tracking URL.
        optional string tracking_url_template = 37;
        Specified by:
        getTrackingUrlTemplate in interface AdGroupOrBuilder
        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:
        getTrackingUrlTemplateBytes in interface AdGroupOrBuilder
        Returns:
        The bytes for trackingUrlTemplate.

      • getUrlCustomParametersList

        public java.util.List<CustomParameter> getUrlCustomParametersList()
         The list of mappings used to substitute custom parameter tags in a
 `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 6;
        Specified by:
        getUrlCustomParametersList in interface AdGroupOrBuilder

      • getUrlCustomParametersOrBuilderList

        public java.util.List<? extends CustomParameterOrBuilder> getUrlCustomParametersOrBuilderList()
         The list of mappings used to substitute custom parameter tags in a
 `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 6;
        Specified by:
        getUrlCustomParametersOrBuilderList in interface AdGroupOrBuilder

      • 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.v10.common.CustomParameter url_custom_parameters = 6;
        Specified by:
        getUrlCustomParametersCount in interface AdGroupOrBuilder

      • getUrlCustomParameters

        public CustomParameter getUrlCustomParameters​(int index)
         The list of mappings used to substitute custom parameter tags in a
 `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 6;
        Specified by:
        getUrlCustomParameters in interface AdGroupOrBuilder

      • getUrlCustomParametersOrBuilder

        public CustomParameterOrBuilder getUrlCustomParametersOrBuilder​(int index)
         The list of mappings used to substitute custom parameter tags in a
 `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
        repeated .google.ads.googleads.v10.common.CustomParameter url_custom_parameters = 6;
        Specified by:
        getUrlCustomParametersOrBuilder in interface AdGroupOrBuilder

      • 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:
        hasCampaign in interface AdGroupOrBuilder
        Returns:
        Whether the campaign field is set.

      • getCampaign

        public java.lang.String getCampaign()
         Immutable. The campaign to which the ad group belongs.
        optional string campaign = 38 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getCampaign in interface AdGroupOrBuilder
        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:
        getCampaignBytes in interface AdGroupOrBuilder
        Returns:
        The bytes for campaign.

      • hasCpcBidMicros

        public boolean hasCpcBidMicros()
         The maximum CPC (cost-per-click) bid.
        optional int64 cpc_bid_micros = 39;
        Specified by:
        hasCpcBidMicros in interface AdGroupOrBuilder
        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:
        getCpcBidMicros in interface AdGroupOrBuilder
        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:
        hasEffectiveCpcBidMicros in interface AdGroupOrBuilder
        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:
        getEffectiveCpcBidMicros in interface AdGroupOrBuilder
        Returns:
        The effectiveCpcBidMicros.

      • hasCpmBidMicros

        public boolean hasCpmBidMicros()
         The maximum CPM (cost-per-thousand viewable impressions) bid.
        optional int64 cpm_bid_micros = 40;
        Specified by:
        hasCpmBidMicros in interface AdGroupOrBuilder
        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:
        getCpmBidMicros in interface AdGroupOrBuilder
        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:
        hasTargetCpaMicros in interface AdGroupOrBuilder
        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:
        getTargetCpaMicros in interface AdGroupOrBuilder
        Returns:
        The targetCpaMicros.

      • hasCpvBidMicros

        public boolean hasCpvBidMicros()
         Output only. The CPV (cost-per-view) bid.
        optional int64 cpv_bid_micros = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCpvBidMicros in interface AdGroupOrBuilder
        Returns:
        Whether the cpvBidMicros field is set.

      • getCpvBidMicros

        public long getCpvBidMicros()
         Output only. The CPV (cost-per-view) bid.
        optional int64 cpv_bid_micros = 42 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCpvBidMicros in interface AdGroupOrBuilder
        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:
        hasTargetCpmMicros in interface AdGroupOrBuilder
        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:
        getTargetCpmMicros in interface AdGroupOrBuilder
        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:
        hasTargetRoas in interface AdGroupOrBuilder
        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:
        getTargetRoas in interface AdGroupOrBuilder
        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:
        hasPercentCpcBidMicros in interface AdGroupOrBuilder
        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:
        getPercentCpcBidMicros in interface AdGroupOrBuilder
        Returns:
        The percentCpcBidMicros.

      • hasExplorerAutoOptimizerSetting

        public boolean hasExplorerAutoOptimizerSetting()
         Settings for the Display Campaign Optimizer, initially termed "Explorer".
        .google.ads.googleads.v10.common.ExplorerAutoOptimizerSetting explorer_auto_optimizer_setting = 21;
        Specified by:
        hasExplorerAutoOptimizerSetting in interface AdGroupOrBuilder
        Returns:
        Whether the explorerAutoOptimizerSetting field is set.

      • getExplorerAutoOptimizerSetting

        public ExplorerAutoOptimizerSetting getExplorerAutoOptimizerSetting()
         Settings for the Display Campaign Optimizer, initially termed "Explorer".
        .google.ads.googleads.v10.common.ExplorerAutoOptimizerSetting explorer_auto_optimizer_setting = 21;
        Specified by:
        getExplorerAutoOptimizerSetting in interface AdGroupOrBuilder
        Returns:
        The explorerAutoOptimizerSetting.

      • 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.v10.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;
        Specified by:
        getDisplayCustomBidDimensionValue in interface AdGroupOrBuilder
        Returns:
        The enum numeric value on the wire for displayCustomBidDimension.

      • getDisplayCustomBidDimension

        public TargetingDimensionEnum.TargetingDimension getDisplayCustomBidDimension()
         Allows advertisers to specify a targeting dimension on which to place
 absolute bids. This is only applicable for campaigns that target only the
 display network and not search.
        .google.ads.googleads.v10.enums.TargetingDimensionEnum.TargetingDimension display_custom_bid_dimension = 23;
        Specified by:
        getDisplayCustomBidDimension in interface AdGroupOrBuilder
        Returns:
        The displayCustomBidDimension.

      • hasFinalUrlSuffix

        public boolean hasFinalUrlSuffix()
         URL template for appending params to Final URL.
        optional string final_url_suffix = 46;
        Specified by:
        hasFinalUrlSuffix in interface AdGroupOrBuilder
        Returns:
        Whether the finalUrlSuffix field is set.

      • getFinalUrlSuffix

        public java.lang.String getFinalUrlSuffix()
         URL template for appending params to Final URL.
        optional string final_url_suffix = 46;
        Specified by:
        getFinalUrlSuffix in interface AdGroupOrBuilder
        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:
        getFinalUrlSuffixBytes in interface AdGroupOrBuilder
        Returns:
        The bytes for finalUrlSuffix.

      • hasTargetingSetting

        public boolean hasTargetingSetting()
         Setting for targeting related features.
        .google.ads.googleads.v10.common.TargetingSetting targeting_setting = 25;
        Specified by:
        hasTargetingSetting in interface AdGroupOrBuilder
        Returns:
        Whether the targetingSetting field is set.

      • getTargetingSetting

        public TargetingSetting getTargetingSetting()
         Setting for targeting related features.
        .google.ads.googleads.v10.common.TargetingSetting targeting_setting = 25;
        Specified by:
        getTargetingSetting in interface AdGroupOrBuilder
        Returns:
        The targetingSetting.

      • hasAudienceSetting

        public boolean hasAudienceSetting()
         Immutable. Setting for audience related features.
        .google.ads.googleads.v10.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasAudienceSetting in interface AdGroupOrBuilder
        Returns:
        Whether the audienceSetting field is set.

      • getAudienceSetting

        public AdGroup.AudienceSetting getAudienceSetting()
         Immutable. Setting for audience related features.
        .google.ads.googleads.v10.resources.AdGroup.AudienceSetting audience_setting = 56 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAudienceSetting in interface AdGroupOrBuilder
        Returns:
        The audienceSetting.

      • 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:
        hasEffectiveTargetCpaMicros in interface AdGroupOrBuilder
        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:
        getEffectiveTargetCpaMicros in interface AdGroupOrBuilder
        Returns:
        The effectiveTargetCpaMicros.

      • getEffectiveTargetCpaSourceValue

        public int getEffectiveTargetCpaSourceValue()
         Output only. Source of the effective target CPA.
 This field is read-only.
        .google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveTargetCpaSourceValue in interface AdGroupOrBuilder
        Returns:
        The enum numeric value on the wire for effectiveTargetCpaSource.

      • getEffectiveTargetCpaSource

        public BiddingSourceEnum.BiddingSource getEffectiveTargetCpaSource()
         Output only. Source of the effective target CPA.
 This field is read-only.
        .google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_target_cpa_source = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveTargetCpaSource in interface AdGroupOrBuilder
        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:
        hasEffectiveTargetRoas in interface AdGroupOrBuilder
        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:
        getEffectiveTargetRoas in interface AdGroupOrBuilder
        Returns:
        The effectiveTargetRoas.

      • getEffectiveTargetRoasSourceValue

        public int getEffectiveTargetRoasSourceValue()
         Output only. Source of the effective target ROAS.
 This field is read-only.
        .google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveTargetRoasSourceValue in interface AdGroupOrBuilder
        Returns:
        The enum numeric value on the wire for effectiveTargetRoasSource.

      • getEffectiveTargetRoasSource

        public BiddingSourceEnum.BiddingSource getEffectiveTargetRoasSource()
         Output only. Source of the effective target ROAS.
 This field is read-only.
        .google.ads.googleads.v10.enums.BiddingSourceEnum.BiddingSource effective_target_roas_source = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveTargetRoasSource in interface AdGroupOrBuilder
        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:
        getLabelsList in interface AdGroupOrBuilder
        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:
        getLabelsCount in interface AdGroupOrBuilder
        Returns:
        The count of labels.

      • getLabels

        public java.lang.String getLabels​(int index)
         Output only. The resource names of labels attached to this ad group.
        repeated string labels = 49 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getLabels in interface AdGroupOrBuilder
        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:
        getLabelsBytes in interface AdGroupOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the labels at the given index.

      • getExcludedParentAssetFieldTypesList

        public java.util.List<AssetFieldTypeEnum.AssetFieldType> getExcludedParentAssetFieldTypesList()
         The asset field types that should be excluded from this ad group. Asset
 links with these field types will not be inherited by this ad group from
 the upper levels.
        repeated .google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
        Specified by:
        getExcludedParentAssetFieldTypesList in interface AdGroupOrBuilder
        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.v10.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
        Specified by:
        getExcludedParentAssetFieldTypesCount in interface AdGroupOrBuilder
        Returns:
        The count of excludedParentAssetFieldTypes.

      • getExcludedParentAssetFieldTypes

        public AssetFieldTypeEnum.AssetFieldType getExcludedParentAssetFieldTypes​(int index)
         The asset field types that should be excluded from this ad group. Asset
 links with these field types will not be inherited by this ad group from
 the upper levels.
        repeated .google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
        Specified by:
        getExcludedParentAssetFieldTypes in interface AdGroupOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The excludedParentAssetFieldTypes at the given index.

      • getExcludedParentAssetFieldTypesValueList

        public java.util.List<java.lang.Integer> getExcludedParentAssetFieldTypesValueList()
         The asset field types that should be excluded from this ad group. Asset
 links with these field types will not be inherited by this ad group from
 the upper levels.
        repeated .google.ads.googleads.v10.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
        Specified by:
        getExcludedParentAssetFieldTypesValueList in interface AdGroupOrBuilder
        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.v10.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 54;
        Specified by:
        getExcludedParentAssetFieldTypesValue in interface AdGroupOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of excludedParentAssetFieldTypes at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AdGroup parseFrom​(java.nio.ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdGroup parseFrom​(java.nio.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

        public static AdGroup parseFrom​(java.io.InputStream input)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static AdGroup parseFrom​(java.io.InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static AdGroup parseDelimitedFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static AdGroup parseDelimitedFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static AdGroup parseFrom​(com.google.protobuf.CodedInputStream input)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static AdGroup parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public AdGroup.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public AdGroup.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AdGroup.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static AdGroup getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<AdGroup> parser()

      • getParserForType

        public com.google.protobuf.Parser<AdGroup> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AdGroup getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder