Interface CampaignOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Campaign, Campaign.Builder

public interface CampaignOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getResourceName

      String getResourceName()
       Immutable. The resource name of the campaign.
       Campaign resource names have the form:
      
       `customers/{customer_id}/campaigns/{campaign_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The resourceName.
    • getResourceNameBytes

      com.google.protobuf.ByteString getResourceNameBytes()
       Immutable. The resource name of the campaign.
       Campaign resource names have the form:
      
       `customers/{customer_id}/campaigns/{campaign_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for resourceName.
    • hasId

      boolean hasId()
       Output only. The ID of the campaign.
       
      optional int64 id = 59 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the id field is set.
    • getId

      long getId()
       Output only. The ID of the campaign.
       
      optional int64 id = 59 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.
    • hasName

      boolean hasName()
       The name of the campaign.
      
       This field is required and should not be empty when creating new
       campaigns.
      
       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 = 58;
      Returns:
      Whether the name field is set.
    • getName

      String getName()
       The name of the campaign.
      
       This field is required and should not be empty when creating new
       campaigns.
      
       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 = 58;
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the campaign.
      
       This field is required and should not be empty when creating new
       campaigns.
      
       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 = 58;
      Returns:
      The bytes for name.
    • getPrimaryStatusValue

      int getPrimaryStatusValue()
       Output only. The primary status of the campaign.
      
       Provides insight into why a campaign is not serving or not serving
       optimally. Modification to the campaign and its related entities might take
       a while to be reflected in this status.
       
      .google.ads.googleads.v18.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus primary_status = 81 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for primaryStatus.
    • getPrimaryStatus

       Output only. The primary status of the campaign.
      
       Provides insight into why a campaign is not serving or not serving
       optimally. Modification to the campaign and its related entities might take
       a while to be reflected in this status.
       
      .google.ads.googleads.v18.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus primary_status = 81 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The primaryStatus.
    • getPrimaryStatusReasonsList

       Output only. The primary status reasons of the campaign.
      
       Provides insight into why a campaign is not serving or not serving
       optimally. These reasons are aggregated to determine an overall
       CampaignPrimaryStatus.
       
      repeated .google.ads.googleads.v18.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the primaryStatusReasons.
    • getPrimaryStatusReasonsCount

      int getPrimaryStatusReasonsCount()
       Output only. The primary status reasons of the campaign.
      
       Provides insight into why a campaign is not serving or not serving
       optimally. These reasons are aggregated to determine an overall
       CampaignPrimaryStatus.
       
      repeated .google.ads.googleads.v18.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of primaryStatusReasons.
    • getPrimaryStatusReasons

       Output only. The primary status reasons of the campaign.
      
       Provides insight into why a campaign is not serving or not serving
       optimally. These reasons are aggregated to determine an overall
       CampaignPrimaryStatus.
       
      repeated .google.ads.googleads.v18.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The primaryStatusReasons at the given index.
    • getPrimaryStatusReasonsValueList

      List<Integer> getPrimaryStatusReasonsValueList()
       Output only. The primary status reasons of the campaign.
      
       Provides insight into why a campaign is not serving or not serving
       optimally. These reasons are aggregated to determine an overall
       CampaignPrimaryStatus.
       
      repeated .google.ads.googleads.v18.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the enum numeric values on the wire for primaryStatusReasons.
    • getPrimaryStatusReasonsValue

      int getPrimaryStatusReasonsValue(int index)
       Output only. The primary status reasons of the campaign.
      
       Provides insight into why a campaign is not serving or not serving
       optimally. These reasons are aggregated to determine an overall
       CampaignPrimaryStatus.
       
      repeated .google.ads.googleads.v18.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of primaryStatusReasons at the given index.
    • getStatusValue

      int getStatusValue()
       The status of the campaign.
      
       When a new campaign is added, the status defaults to ENABLED.
       
      .google.ads.googleads.v18.enums.CampaignStatusEnum.CampaignStatus status = 5;
      Returns:
      The enum numeric value on the wire for status.
    • getStatus

       The status of the campaign.
      
       When a new campaign is added, the status defaults to ENABLED.
       
      .google.ads.googleads.v18.enums.CampaignStatusEnum.CampaignStatus status = 5;
      Returns:
      The status.
    • getServingStatusValue

      int getServingStatusValue()
       Output only. The ad serving status of the campaign.
       
      .google.ads.googleads.v18.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for servingStatus.
    • getServingStatus

       Output only. The ad serving status of the campaign.
       
      .google.ads.googleads.v18.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The servingStatus.
    • getBiddingStrategySystemStatusValue

      int getBiddingStrategySystemStatusValue()
       Output only. The system status of the campaign's bidding strategy.
       
      .google.ads.googleads.v18.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for biddingStrategySystemStatus.
    • getBiddingStrategySystemStatus

       Output only. The system status of the campaign's bidding strategy.
       
      .google.ads.googleads.v18.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The biddingStrategySystemStatus.
    • getAdServingOptimizationStatusValue

      int getAdServingOptimizationStatusValue()
       The ad serving optimization status of the campaign.
       
      .google.ads.googleads.v18.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8;
      Returns:
      The enum numeric value on the wire for adServingOptimizationStatus.
    • getAdServingOptimizationStatus

       The ad serving optimization status of the campaign.
       
      .google.ads.googleads.v18.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8;
      Returns:
      The adServingOptimizationStatus.
    • getAdvertisingChannelTypeValue

      int getAdvertisingChannelTypeValue()
       Immutable. The primary serving target for ads within the campaign.
       The targeting options can be refined in `network_settings`.
      
       This field is required and should not be empty when creating new
       campaigns.
      
       Can be set only when creating campaigns.
       After the campaign is created, the field can not be changed.
       
      .google.ads.googleads.v18.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for advertisingChannelType.
    • getAdvertisingChannelType

       Immutable. The primary serving target for ads within the campaign.
       The targeting options can be refined in `network_settings`.
      
       This field is required and should not be empty when creating new
       campaigns.
      
       Can be set only when creating campaigns.
       After the campaign is created, the field can not be changed.
       
      .google.ads.googleads.v18.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The advertisingChannelType.
    • getAdvertisingChannelSubTypeValue

      int getAdvertisingChannelSubTypeValue()
       Immutable. Optional refinement to `advertising_channel_type`.
       Must be a valid sub-type of the parent channel type.
      
       Can be set only when creating campaigns.
       After campaign is created, the field can not be changed.
       
      .google.ads.googleads.v18.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for advertisingChannelSubType.
    • getAdvertisingChannelSubType

       Immutable. Optional refinement to `advertising_channel_type`.
       Must be a valid sub-type of the parent channel type.
      
       Can be set only when creating campaigns.
       After campaign is created, the field can not be changed.
       
      .google.ads.googleads.v18.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The advertisingChannelSubType.
    • hasTrackingUrlTemplate

      boolean hasTrackingUrlTemplate()
       The URL template for constructing a tracking URL.
       
      optional string tracking_url_template = 60;
      Returns:
      Whether the trackingUrlTemplate field is set.
    • getTrackingUrlTemplate

      String getTrackingUrlTemplate()
       The URL template for constructing a tracking URL.
       
      optional string tracking_url_template = 60;
      Returns:
      The trackingUrlTemplate.
    • getTrackingUrlTemplateBytes

      com.google.protobuf.ByteString getTrackingUrlTemplateBytes()
       The URL template for constructing a tracking URL.
       
      optional string tracking_url_template = 60;
      Returns:
      The bytes for trackingUrlTemplate.
    • getUrlCustomParametersList

      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.v18.common.CustomParameter url_custom_parameters = 12;
    • getUrlCustomParameters

      CustomParameter getUrlCustomParameters(int index)
       The list of mappings used to substitute custom parameter tags in a
       `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
       
      repeated .google.ads.googleads.v18.common.CustomParameter url_custom_parameters = 12;
    • getUrlCustomParametersCount

      int getUrlCustomParametersCount()
       The list of mappings used to substitute custom parameter tags in a
       `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
       
      repeated .google.ads.googleads.v18.common.CustomParameter url_custom_parameters = 12;
    • getUrlCustomParametersOrBuilderList

      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.v18.common.CustomParameter url_custom_parameters = 12;
    • getUrlCustomParametersOrBuilder

      CustomParameterOrBuilder getUrlCustomParametersOrBuilder(int index)
       The list of mappings used to substitute custom parameter tags in a
       `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
       
      repeated .google.ads.googleads.v18.common.CustomParameter url_custom_parameters = 12;
    • hasLocalServicesCampaignSettings

      boolean hasLocalServicesCampaignSettings()
       The Local Services Campaign related settings.
       
      .google.ads.googleads.v18.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75;
      Returns:
      Whether the localServicesCampaignSettings field is set.
    • getLocalServicesCampaignSettings

      Campaign.LocalServicesCampaignSettings getLocalServicesCampaignSettings()
       The Local Services Campaign related settings.
       
      .google.ads.googleads.v18.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75;
      Returns:
      The localServicesCampaignSettings.
    • getLocalServicesCampaignSettingsOrBuilder

      Campaign.LocalServicesCampaignSettingsOrBuilder getLocalServicesCampaignSettingsOrBuilder()
       The Local Services Campaign related settings.
       
      .google.ads.googleads.v18.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75;
    • hasTravelCampaignSettings

      boolean hasTravelCampaignSettings()
       Settings for Travel campaign.
       
      .google.ads.googleads.v18.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85;
      Returns:
      Whether the travelCampaignSettings field is set.
    • getTravelCampaignSettings

      Campaign.TravelCampaignSettings getTravelCampaignSettings()
       Settings for Travel campaign.
       
      .google.ads.googleads.v18.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85;
      Returns:
      The travelCampaignSettings.
    • getTravelCampaignSettingsOrBuilder

      Campaign.TravelCampaignSettingsOrBuilder getTravelCampaignSettingsOrBuilder()
       Settings for Travel campaign.
       
      .google.ads.googleads.v18.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85;
    • hasDemandGenCampaignSettings

      boolean hasDemandGenCampaignSettings()
       Settings for Demand Gen campaign.
       
      .google.ads.googleads.v18.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91;
      Returns:
      Whether the demandGenCampaignSettings field is set.
    • getDemandGenCampaignSettings

      Campaign.DemandGenCampaignSettings getDemandGenCampaignSettings()
       Settings for Demand Gen campaign.
       
      .google.ads.googleads.v18.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91;
      Returns:
      The demandGenCampaignSettings.
    • getDemandGenCampaignSettingsOrBuilder

      Campaign.DemandGenCampaignSettingsOrBuilder getDemandGenCampaignSettingsOrBuilder()
       Settings for Demand Gen campaign.
       
      .google.ads.googleads.v18.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91;
    • hasVideoCampaignSettings

      boolean hasVideoCampaignSettings()
       Settings for Video campaign.
       
      .google.ads.googleads.v18.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94;
      Returns:
      Whether the videoCampaignSettings field is set.
    • getVideoCampaignSettings

      Campaign.VideoCampaignSettings getVideoCampaignSettings()
       Settings for Video campaign.
       
      .google.ads.googleads.v18.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94;
      Returns:
      The videoCampaignSettings.
    • getVideoCampaignSettingsOrBuilder

      Campaign.VideoCampaignSettingsOrBuilder getVideoCampaignSettingsOrBuilder()
       Settings for Video campaign.
       
      .google.ads.googleads.v18.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94;
    • hasRealTimeBiddingSetting

      boolean hasRealTimeBiddingSetting()
       Settings for Real-Time Bidding, a feature only available for campaigns
       targeting the Ad Exchange network.
       
      .google.ads.googleads.v18.common.RealTimeBiddingSetting real_time_bidding_setting = 39;
      Returns:
      Whether the realTimeBiddingSetting field is set.
    • getRealTimeBiddingSetting

      RealTimeBiddingSetting getRealTimeBiddingSetting()
       Settings for Real-Time Bidding, a feature only available for campaigns
       targeting the Ad Exchange network.
       
      .google.ads.googleads.v18.common.RealTimeBiddingSetting real_time_bidding_setting = 39;
      Returns:
      The realTimeBiddingSetting.
    • getRealTimeBiddingSettingOrBuilder

      RealTimeBiddingSettingOrBuilder getRealTimeBiddingSettingOrBuilder()
       Settings for Real-Time Bidding, a feature only available for campaigns
       targeting the Ad Exchange network.
       
      .google.ads.googleads.v18.common.RealTimeBiddingSetting real_time_bidding_setting = 39;
    • hasNetworkSettings

      boolean hasNetworkSettings()
       The network settings for the campaign.
       
      .google.ads.googleads.v18.resources.Campaign.NetworkSettings network_settings = 14;
      Returns:
      Whether the networkSettings field is set.
    • getNetworkSettings

      Campaign.NetworkSettings getNetworkSettings()
       The network settings for the campaign.
       
      .google.ads.googleads.v18.resources.Campaign.NetworkSettings network_settings = 14;
      Returns:
      The networkSettings.
    • getNetworkSettingsOrBuilder

      Campaign.NetworkSettingsOrBuilder getNetworkSettingsOrBuilder()
       The network settings for the campaign.
       
      .google.ads.googleads.v18.resources.Campaign.NetworkSettings network_settings = 14;
    • hasHotelSetting

      boolean hasHotelSetting()
       Immutable. The hotel setting for the campaign.
       
      .google.ads.googleads.v18.resources.Campaign.HotelSettingInfo hotel_setting = 32 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the hotelSetting field is set.
    • getHotelSetting

      Campaign.HotelSettingInfo getHotelSetting()
       Immutable. The hotel setting for the campaign.
       
      .google.ads.googleads.v18.resources.Campaign.HotelSettingInfo hotel_setting = 32 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The hotelSetting.
    • getHotelSettingOrBuilder

      Campaign.HotelSettingInfoOrBuilder getHotelSettingOrBuilder()
       Immutable. The hotel setting for the campaign.
       
      .google.ads.googleads.v18.resources.Campaign.HotelSettingInfo hotel_setting = 32 [(.google.api.field_behavior) = IMMUTABLE];
    • hasDynamicSearchAdsSetting

      boolean hasDynamicSearchAdsSetting()
       The setting for controlling Dynamic Search Ads (DSA).
       
      .google.ads.googleads.v18.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
      Returns:
      Whether the dynamicSearchAdsSetting field is set.
    • getDynamicSearchAdsSetting

      Campaign.DynamicSearchAdsSetting getDynamicSearchAdsSetting()
       The setting for controlling Dynamic Search Ads (DSA).
       
      .google.ads.googleads.v18.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
      Returns:
      The dynamicSearchAdsSetting.
    • getDynamicSearchAdsSettingOrBuilder

      Campaign.DynamicSearchAdsSettingOrBuilder getDynamicSearchAdsSettingOrBuilder()
       The setting for controlling Dynamic Search Ads (DSA).
       
      .google.ads.googleads.v18.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
    • hasShoppingSetting

      boolean hasShoppingSetting()
       The setting for controlling Shopping campaigns.
       
      .google.ads.googleads.v18.resources.Campaign.ShoppingSetting shopping_setting = 36;
      Returns:
      Whether the shoppingSetting field is set.
    • getShoppingSetting

      Campaign.ShoppingSetting getShoppingSetting()
       The setting for controlling Shopping campaigns.
       
      .google.ads.googleads.v18.resources.Campaign.ShoppingSetting shopping_setting = 36;
      Returns:
      The shoppingSetting.
    • getShoppingSettingOrBuilder

      Campaign.ShoppingSettingOrBuilder getShoppingSettingOrBuilder()
       The setting for controlling Shopping campaigns.
       
      .google.ads.googleads.v18.resources.Campaign.ShoppingSetting shopping_setting = 36;
    • hasTargetingSetting

      boolean hasTargetingSetting()
       Setting for targeting related features.
       
      .google.ads.googleads.v18.common.TargetingSetting targeting_setting = 43;
      Returns:
      Whether the targetingSetting field is set.
    • getTargetingSetting

      TargetingSetting getTargetingSetting()
       Setting for targeting related features.
       
      .google.ads.googleads.v18.common.TargetingSetting targeting_setting = 43;
      Returns:
      The targetingSetting.
    • getTargetingSettingOrBuilder

      TargetingSettingOrBuilder getTargetingSettingOrBuilder()
       Setting for targeting related features.
       
      .google.ads.googleads.v18.common.TargetingSetting targeting_setting = 43;
    • hasAudienceSetting

      boolean hasAudienceSetting()
       Immutable. Setting for audience related features.
       
      optional .google.ads.googleads.v18.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the audienceSetting field is set.
    • getAudienceSetting

      Campaign.AudienceSetting getAudienceSetting()
       Immutable. Setting for audience related features.
       
      optional .google.ads.googleads.v18.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The audienceSetting.
    • getAudienceSettingOrBuilder

      Campaign.AudienceSettingOrBuilder getAudienceSettingOrBuilder()
       Immutable. Setting for audience related features.
       
      optional .google.ads.googleads.v18.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE];
    • hasGeoTargetTypeSetting

      boolean hasGeoTargetTypeSetting()
       The setting for ads geotargeting.
       
      .google.ads.googleads.v18.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47;
      Returns:
      Whether the geoTargetTypeSetting field is set.
    • getGeoTargetTypeSetting

      Campaign.GeoTargetTypeSetting getGeoTargetTypeSetting()
       The setting for ads geotargeting.
       
      .google.ads.googleads.v18.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47;
      Returns:
      The geoTargetTypeSetting.
    • getGeoTargetTypeSettingOrBuilder

      Campaign.GeoTargetTypeSettingOrBuilder getGeoTargetTypeSettingOrBuilder()
       The setting for ads geotargeting.
       
      .google.ads.googleads.v18.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47;
    • hasLocalCampaignSetting

      boolean hasLocalCampaignSetting()
       The setting for local campaign.
       
      .google.ads.googleads.v18.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50;
      Returns:
      Whether the localCampaignSetting field is set.
    • getLocalCampaignSetting

      Campaign.LocalCampaignSetting getLocalCampaignSetting()
       The setting for local campaign.
       
      .google.ads.googleads.v18.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50;
      Returns:
      The localCampaignSetting.
    • getLocalCampaignSettingOrBuilder

      Campaign.LocalCampaignSettingOrBuilder getLocalCampaignSettingOrBuilder()
       The setting for local campaign.
       
      .google.ads.googleads.v18.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50;
    • hasAppCampaignSetting

      boolean hasAppCampaignSetting()
       The setting related to App Campaign.
       
      .google.ads.googleads.v18.resources.Campaign.AppCampaignSetting app_campaign_setting = 51;
      Returns:
      Whether the appCampaignSetting field is set.
    • getAppCampaignSetting

      Campaign.AppCampaignSetting getAppCampaignSetting()
       The setting related to App Campaign.
       
      .google.ads.googleads.v18.resources.Campaign.AppCampaignSetting app_campaign_setting = 51;
      Returns:
      The appCampaignSetting.
    • getAppCampaignSettingOrBuilder

      Campaign.AppCampaignSettingOrBuilder getAppCampaignSettingOrBuilder()
       The setting related to App Campaign.
       
      .google.ads.googleads.v18.resources.Campaign.AppCampaignSetting app_campaign_setting = 51;
    • getLabelsList

      List<String> getLabelsList()
       Output only. The resource names of labels attached to this campaign.
       
      repeated string labels = 61 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the labels.
    • getLabelsCount

      int getLabelsCount()
       Output only. The resource names of labels attached to this campaign.
       
      repeated string labels = 61 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The count of labels.
    • getLabels

      String getLabels(int index)
       Output only. The resource names of labels attached to this campaign.
       
      repeated string labels = 61 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The labels at the given index.
    • getLabelsBytes

      com.google.protobuf.ByteString getLabelsBytes(int index)
       Output only. The resource names of labels attached to this campaign.
       
      repeated string labels = 61 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the labels at the given index.
    • getExperimentTypeValue

      int getExperimentTypeValue()
       Output only. The type of campaign: normal, draft, or experiment.
       
      .google.ads.googleads.v18.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for experimentType.
    • getExperimentType

       Output only. The type of campaign: normal, draft, or experiment.
       
      .google.ads.googleads.v18.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The experimentType.
    • hasBaseCampaign

      boolean hasBaseCampaign()
       Output only. The resource name of the base campaign of a draft or
       experiment campaign. For base campaigns, this is equal to `resource_name`.
      
       This field is read-only.
       
      optional string base_campaign = 56 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      Whether the baseCampaign field is set.
    • getBaseCampaign

      String getBaseCampaign()
       Output only. The resource name of the base campaign of a draft or
       experiment campaign. For base campaigns, this is equal to `resource_name`.
      
       This field is read-only.
       
      optional string base_campaign = 56 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The baseCampaign.
    • getBaseCampaignBytes

      com.google.protobuf.ByteString getBaseCampaignBytes()
       Output only. The resource name of the base campaign of a draft or
       experiment campaign. For base campaigns, this is equal to `resource_name`.
      
       This field is read-only.
       
      optional string base_campaign = 56 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for baseCampaign.
    • hasCampaignBudget

      boolean hasCampaignBudget()
       The resource name of the campaign budget of the campaign.
       
      optional string campaign_budget = 62 [(.google.api.resource_reference) = { ... }
      Returns:
      Whether the campaignBudget field is set.
    • getCampaignBudget

      String getCampaignBudget()
       The resource name of the campaign budget of the campaign.
       
      optional string campaign_budget = 62 [(.google.api.resource_reference) = { ... }
      Returns:
      The campaignBudget.
    • getCampaignBudgetBytes

      com.google.protobuf.ByteString getCampaignBudgetBytes()
       The resource name of the campaign budget of the campaign.
       
      optional string campaign_budget = 62 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for campaignBudget.
    • getBiddingStrategyTypeValue

      int getBiddingStrategyTypeValue()
       Output only. The type of bidding strategy.
      
       A bidding strategy can be created by setting either the bidding scheme to
       create a standard bidding strategy or the `bidding_strategy` field to
       create a portfolio bidding strategy.
      
       This field is read-only.
       
      .google.ads.googleads.v18.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for biddingStrategyType.
    • getBiddingStrategyType

       Output only. The type of bidding strategy.
      
       A bidding strategy can be created by setting either the bidding scheme to
       create a standard bidding strategy or the `bidding_strategy` field to
       create a portfolio bidding strategy.
      
       This field is read-only.
       
      .google.ads.googleads.v18.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The biddingStrategyType.
    • getAccessibleBiddingStrategy

      String getAccessibleBiddingStrategy()
       Output only. Resource name of AccessibleBiddingStrategy, a read-only view
       of the unrestricted attributes of the attached portfolio bidding strategy
       identified by 'bidding_strategy'. Empty, if the campaign does not use a
       portfolio strategy. Unrestricted strategy attributes are available to all
       customers with whom the strategy is shared and are read from the
       AccessibleBiddingStrategy resource. In contrast, restricted attributes are
       only available to the owner customer of the strategy and their managers.
       Restricted attributes can only be read from the BiddingStrategy resource.
       
      string accessible_bidding_strategy = 71 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The accessibleBiddingStrategy.
    • getAccessibleBiddingStrategyBytes

      com.google.protobuf.ByteString getAccessibleBiddingStrategyBytes()
       Output only. Resource name of AccessibleBiddingStrategy, a read-only view
       of the unrestricted attributes of the attached portfolio bidding strategy
       identified by 'bidding_strategy'. Empty, if the campaign does not use a
       portfolio strategy. Unrestricted strategy attributes are available to all
       customers with whom the strategy is shared and are read from the
       AccessibleBiddingStrategy resource. In contrast, restricted attributes are
       only available to the owner customer of the strategy and their managers.
       Restricted attributes can only be read from the BiddingStrategy resource.
       
      string accessible_bidding_strategy = 71 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for accessibleBiddingStrategy.
    • hasStartDate

      boolean hasStartDate()
       The date when campaign started in serving customer's timezone in YYYY-MM-DD
       format.
       
      optional string start_date = 63;
      Returns:
      Whether the startDate field is set.
    • getStartDate

      String getStartDate()
       The date when campaign started in serving customer's timezone in YYYY-MM-DD
       format.
       
      optional string start_date = 63;
      Returns:
      The startDate.
    • getStartDateBytes

      com.google.protobuf.ByteString getStartDateBytes()
       The date when campaign started in serving customer's timezone in YYYY-MM-DD
       format.
       
      optional string start_date = 63;
      Returns:
      The bytes for startDate.
    • hasCampaignGroup

      boolean hasCampaignGroup()
       The resource name of the campaign group that this campaign belongs to.
       
      optional string campaign_group = 76 [(.google.api.resource_reference) = { ... }
      Returns:
      Whether the campaignGroup field is set.
    • getCampaignGroup

      String getCampaignGroup()
       The resource name of the campaign group that this campaign belongs to.
       
      optional string campaign_group = 76 [(.google.api.resource_reference) = { ... }
      Returns:
      The campaignGroup.
    • getCampaignGroupBytes

      com.google.protobuf.ByteString getCampaignGroupBytes()
       The resource name of the campaign group that this campaign belongs to.
       
      optional string campaign_group = 76 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for campaignGroup.
    • hasEndDate

      boolean hasEndDate()
       The last day of the campaign in serving customer's timezone in YYYY-MM-DD
       format. On create, defaults to 2037-12-30, which means the campaign will
       run indefinitely. To set an existing campaign to run indefinitely, set this
       field to 2037-12-30.
       
      optional string end_date = 64;
      Returns:
      Whether the endDate field is set.
    • getEndDate

      String getEndDate()
       The last day of the campaign in serving customer's timezone in YYYY-MM-DD
       format. On create, defaults to 2037-12-30, which means the campaign will
       run indefinitely. To set an existing campaign to run indefinitely, set this
       field to 2037-12-30.
       
      optional string end_date = 64;
      Returns:
      The endDate.
    • getEndDateBytes

      com.google.protobuf.ByteString getEndDateBytes()
       The last day of the campaign in serving customer's timezone in YYYY-MM-DD
       format. On create, defaults to 2037-12-30, which means the campaign will
       run indefinitely. To set an existing campaign to run indefinitely, set this
       field to 2037-12-30.
       
      optional string end_date = 64;
      Returns:
      The bytes for endDate.
    • hasFinalUrlSuffix

      boolean hasFinalUrlSuffix()
       Suffix used to append query parameters to landing pages that are served
       with parallel tracking.
       
      optional string final_url_suffix = 65;
      Returns:
      Whether the finalUrlSuffix field is set.
    • getFinalUrlSuffix

      String getFinalUrlSuffix()
       Suffix used to append query parameters to landing pages that are served
       with parallel tracking.
       
      optional string final_url_suffix = 65;
      Returns:
      The finalUrlSuffix.
    • getFinalUrlSuffixBytes

      com.google.protobuf.ByteString getFinalUrlSuffixBytes()
       Suffix used to append query parameters to landing pages that are served
       with parallel tracking.
       
      optional string final_url_suffix = 65;
      Returns:
      The bytes for finalUrlSuffix.
    • getFrequencyCapsList

      List<FrequencyCapEntry> getFrequencyCapsList()
       A list that limits how often each user will see this campaign's ads.
       
      repeated .google.ads.googleads.v18.common.FrequencyCapEntry frequency_caps = 40;
    • getFrequencyCaps

      FrequencyCapEntry getFrequencyCaps(int index)
       A list that limits how often each user will see this campaign's ads.
       
      repeated .google.ads.googleads.v18.common.FrequencyCapEntry frequency_caps = 40;
    • getFrequencyCapsCount

      int getFrequencyCapsCount()
       A list that limits how often each user will see this campaign's ads.
       
      repeated .google.ads.googleads.v18.common.FrequencyCapEntry frequency_caps = 40;
    • getFrequencyCapsOrBuilderList

      List<? extends FrequencyCapEntryOrBuilder> getFrequencyCapsOrBuilderList()
       A list that limits how often each user will see this campaign's ads.
       
      repeated .google.ads.googleads.v18.common.FrequencyCapEntry frequency_caps = 40;
    • getFrequencyCapsOrBuilder

      FrequencyCapEntryOrBuilder getFrequencyCapsOrBuilder(int index)
       A list that limits how often each user will see this campaign's ads.
       
      repeated .google.ads.googleads.v18.common.FrequencyCapEntry frequency_caps = 40;
    • getVideoBrandSafetySuitabilityValue

      int getVideoBrandSafetySuitabilityValue()
       Brand Safety setting at the individual campaign level. Allows for selecting
       an inventory type to show your ads on content that is the right fit for
       your brand. See https://support.google.com/google-ads/answer/7515513.
       
      .google.ads.googleads.v18.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42;
      Returns:
      The enum numeric value on the wire for videoBrandSafetySuitability.
    • getVideoBrandSafetySuitability

      BrandSafetySuitabilityEnum.BrandSafetySuitability getVideoBrandSafetySuitability()
       Brand Safety setting at the individual campaign level. Allows for selecting
       an inventory type to show your ads on content that is the right fit for
       your brand. See https://support.google.com/google-ads/answer/7515513.
       
      .google.ads.googleads.v18.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42;
      Returns:
      The videoBrandSafetySuitability.
    • hasVanityPharma

      boolean hasVanityPharma()
       Describes how unbranded pharma ads will be displayed.
       
      .google.ads.googleads.v18.resources.Campaign.VanityPharma vanity_pharma = 44;
      Returns:
      Whether the vanityPharma field is set.
    • getVanityPharma

      Campaign.VanityPharma getVanityPharma()
       Describes how unbranded pharma ads will be displayed.
       
      .google.ads.googleads.v18.resources.Campaign.VanityPharma vanity_pharma = 44;
      Returns:
      The vanityPharma.
    • getVanityPharmaOrBuilder

      Campaign.VanityPharmaOrBuilder getVanityPharmaOrBuilder()
       Describes how unbranded pharma ads will be displayed.
       
      .google.ads.googleads.v18.resources.Campaign.VanityPharma vanity_pharma = 44;
    • hasSelectiveOptimization

      boolean hasSelectiveOptimization()
       Selective optimization setting for this campaign, which includes a set of
       conversion actions to optimize this campaign towards.
       This feature only applies to app campaigns that use MULTI_CHANNEL as
       AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as
       AdvertisingChannelSubType.
       
      .google.ads.googleads.v18.resources.Campaign.SelectiveOptimization selective_optimization = 45;
      Returns:
      Whether the selectiveOptimization field is set.
    • getSelectiveOptimization

      Campaign.SelectiveOptimization getSelectiveOptimization()
       Selective optimization setting for this campaign, which includes a set of
       conversion actions to optimize this campaign towards.
       This feature only applies to app campaigns that use MULTI_CHANNEL as
       AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as
       AdvertisingChannelSubType.
       
      .google.ads.googleads.v18.resources.Campaign.SelectiveOptimization selective_optimization = 45;
      Returns:
      The selectiveOptimization.
    • getSelectiveOptimizationOrBuilder

      Campaign.SelectiveOptimizationOrBuilder getSelectiveOptimizationOrBuilder()
       Selective optimization setting for this campaign, which includes a set of
       conversion actions to optimize this campaign towards.
       This feature only applies to app campaigns that use MULTI_CHANNEL as
       AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as
       AdvertisingChannelSubType.
       
      .google.ads.googleads.v18.resources.Campaign.SelectiveOptimization selective_optimization = 45;
    • hasOptimizationGoalSetting

      boolean hasOptimizationGoalSetting()
       Optimization goal setting for this campaign, which includes a set of
       optimization goal types.
       
      .google.ads.googleads.v18.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54;
      Returns:
      Whether the optimizationGoalSetting field is set.
    • getOptimizationGoalSetting

      Campaign.OptimizationGoalSetting getOptimizationGoalSetting()
       Optimization goal setting for this campaign, which includes a set of
       optimization goal types.
       
      .google.ads.googleads.v18.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54;
      Returns:
      The optimizationGoalSetting.
    • getOptimizationGoalSettingOrBuilder

      Campaign.OptimizationGoalSettingOrBuilder getOptimizationGoalSettingOrBuilder()
       Optimization goal setting for this campaign, which includes a set of
       optimization goal types.
       
      .google.ads.googleads.v18.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54;
    • hasTrackingSetting

      boolean hasTrackingSetting()
       Output only. Campaign-level settings for tracking information.
       
      .google.ads.googleads.v18.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the trackingSetting field is set.
    • getTrackingSetting

      Campaign.TrackingSetting getTrackingSetting()
       Output only. Campaign-level settings for tracking information.
       
      .google.ads.googleads.v18.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The trackingSetting.
    • getTrackingSettingOrBuilder

      Campaign.TrackingSettingOrBuilder getTrackingSettingOrBuilder()
       Output only. Campaign-level settings for tracking information.
       
      .google.ads.googleads.v18.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getPaymentModeValue

      int getPaymentModeValue()
       Payment mode for the campaign.
       
      .google.ads.googleads.v18.enums.PaymentModeEnum.PaymentMode payment_mode = 52;
      Returns:
      The enum numeric value on the wire for paymentMode.
    • getPaymentMode

      PaymentModeEnum.PaymentMode getPaymentMode()
       Payment mode for the campaign.
       
      .google.ads.googleads.v18.enums.PaymentModeEnum.PaymentMode payment_mode = 52;
      Returns:
      The paymentMode.
    • hasOptimizationScore

      boolean hasOptimizationScore()
       Output only. Optimization score of the campaign.
      
       Optimization score is an estimate of how well a campaign is set to perform.
       It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the
       campaign is performing at full potential. This field is null for unscored
       campaigns.
      
       See "About optimization score" at
       https://support.google.com/google-ads/answer/9061546.
      
       This field is read-only.
       
      optional double optimization_score = 66 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the optimizationScore field is set.
    • getOptimizationScore

      double getOptimizationScore()
       Output only. Optimization score of the campaign.
      
       Optimization score is an estimate of how well a campaign is set to perform.
       It ranges from 0% (0.0) to 100% (1.0), with 100% indicating that the
       campaign is performing at full potential. This field is null for unscored
       campaigns.
      
       See "About optimization score" at
       https://support.google.com/google-ads/answer/9061546.
      
       This field is read-only.
       
      optional double optimization_score = 66 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The optimizationScore.
    • getExcludedParentAssetFieldTypesList

      List<AssetFieldTypeEnum.AssetFieldType> getExcludedParentAssetFieldTypesList()
       The asset field types that should be excluded from this campaign. Asset
       links with these field types will not be inherited by this campaign from
       the upper level.
       
      repeated .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
      Returns:
      A list containing the excludedParentAssetFieldTypes.
    • getExcludedParentAssetFieldTypesCount

      int getExcludedParentAssetFieldTypesCount()
       The asset field types that should be excluded from this campaign. Asset
       links with these field types will not be inherited by this campaign from
       the upper level.
       
      repeated .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
      Returns:
      The count of excludedParentAssetFieldTypes.
    • getExcludedParentAssetFieldTypes

      AssetFieldTypeEnum.AssetFieldType getExcludedParentAssetFieldTypes(int index)
       The asset field types that should be excluded from this campaign. Asset
       links with these field types will not be inherited by this campaign from
       the upper level.
       
      repeated .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
      Parameters:
      index - The index of the element to return.
      Returns:
      The excludedParentAssetFieldTypes at the given index.
    • getExcludedParentAssetFieldTypesValueList

      List<Integer> getExcludedParentAssetFieldTypesValueList()
       The asset field types that should be excluded from this campaign. Asset
       links with these field types will not be inherited by this campaign from
       the upper level.
       
      repeated .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
      Returns:
      A list containing the enum numeric values on the wire for excludedParentAssetFieldTypes.
    • getExcludedParentAssetFieldTypesValue

      int getExcludedParentAssetFieldTypesValue(int index)
       The asset field types that should be excluded from this campaign. Asset
       links with these field types will not be inherited by this campaign from
       the upper level.
       
      repeated .google.ads.googleads.v18.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of excludedParentAssetFieldTypes at the given index.
    • getExcludedParentAssetSetTypesList

      List<AssetSetTypeEnum.AssetSetType> getExcludedParentAssetSetTypesList()
       The asset set types that should be excluded from this campaign. Asset set
       links with these types will not be inherited by this campaign from
       the upper level.
       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 campaign,
       and all Location Extension (LE) and Affiliate Location Extensions (ALE)
       will not be served under this campaign.
       Only LOCATION_SYNC is currently supported.
       
      repeated .google.ads.googleads.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
      Returns:
      A list containing the excludedParentAssetSetTypes.
    • getExcludedParentAssetSetTypesCount

      int getExcludedParentAssetSetTypesCount()
       The asset set types that should be excluded from this campaign. Asset set
       links with these types will not be inherited by this campaign from
       the upper level.
       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 campaign,
       and all Location Extension (LE) and Affiliate Location Extensions (ALE)
       will not be served under this campaign.
       Only LOCATION_SYNC is currently supported.
       
      repeated .google.ads.googleads.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
      Returns:
      The count of excludedParentAssetSetTypes.
    • getExcludedParentAssetSetTypes

      AssetSetTypeEnum.AssetSetType getExcludedParentAssetSetTypes(int index)
       The asset set types that should be excluded from this campaign. Asset set
       links with these types will not be inherited by this campaign from
       the upper level.
       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 campaign,
       and all Location Extension (LE) and Affiliate Location Extensions (ALE)
       will not be served under this campaign.
       Only LOCATION_SYNC is currently supported.
       
      repeated .google.ads.googleads.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
      Parameters:
      index - The index of the element to return.
      Returns:
      The excludedParentAssetSetTypes at the given index.
    • getExcludedParentAssetSetTypesValueList

      List<Integer> getExcludedParentAssetSetTypesValueList()
       The asset set types that should be excluded from this campaign. Asset set
       links with these types will not be inherited by this campaign from
       the upper level.
       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 campaign,
       and all Location Extension (LE) and Affiliate Location Extensions (ALE)
       will not be served under this campaign.
       Only LOCATION_SYNC is currently supported.
       
      repeated .google.ads.googleads.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
      Returns:
      A list containing the enum numeric values on the wire for excludedParentAssetSetTypes.
    • getExcludedParentAssetSetTypesValue

      int getExcludedParentAssetSetTypesValue(int index)
       The asset set types that should be excluded from this campaign. Asset set
       links with these types will not be inherited by this campaign from
       the upper level.
       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 campaign,
       and all Location Extension (LE) and Affiliate Location Extensions (ALE)
       will not be served under this campaign.
       Only LOCATION_SYNC is currently supported.
       
      repeated .google.ads.googleads.v18.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of excludedParentAssetSetTypes at the given index.
    • hasUrlExpansionOptOut

      boolean hasUrlExpansionOptOut()
       Represents opting out of URL expansion to more targeted URLs. If opted out
       (true), only the final URLs in the asset group or URLs specified in the
       advertiser's Google Merchant Center or business data feeds are targeted.
       If opted in (false), the entire domain will be targeted. This field can
       only be set for Performance Max campaigns, where the default value is
       false.
       
      optional bool url_expansion_opt_out = 72;
      Returns:
      Whether the urlExpansionOptOut field is set.
    • getUrlExpansionOptOut

      boolean getUrlExpansionOptOut()
       Represents opting out of URL expansion to more targeted URLs. If opted out
       (true), only the final URLs in the asset group or URLs specified in the
       advertiser's Google Merchant Center or business data feeds are targeted.
       If opted in (false), the entire domain will be targeted. This field can
       only be set for Performance Max campaigns, where the default value is
       false.
       
      optional bool url_expansion_opt_out = 72;
      Returns:
      The urlExpansionOptOut.
    • hasPerformanceMaxUpgrade

      boolean hasPerformanceMaxUpgrade()
       Output only. Information about campaigns being upgraded to Performance Max.
       
      .google.ads.googleads.v18.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the performanceMaxUpgrade field is set.
    • getPerformanceMaxUpgrade

      Campaign.PerformanceMaxUpgrade getPerformanceMaxUpgrade()
       Output only. Information about campaigns being upgraded to Performance Max.
       
      .google.ads.googleads.v18.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The performanceMaxUpgrade.
    • getPerformanceMaxUpgradeOrBuilder

      Campaign.PerformanceMaxUpgradeOrBuilder getPerformanceMaxUpgradeOrBuilder()
       Output only. Information about campaigns being upgraded to Performance Max.
       
      .google.ads.googleads.v18.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasHotelPropertyAssetSet

      boolean hasHotelPropertyAssetSet()
       Immutable. The resource name for a set of hotel properties for Performance
       Max for travel goals campaigns.
       
      optional string hotel_property_asset_set = 83 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      Whether the hotelPropertyAssetSet field is set.
    • getHotelPropertyAssetSet

      String getHotelPropertyAssetSet()
       Immutable. The resource name for a set of hotel properties for Performance
       Max for travel goals campaigns.
       
      optional string hotel_property_asset_set = 83 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The hotelPropertyAssetSet.
    • getHotelPropertyAssetSetBytes

      com.google.protobuf.ByteString getHotelPropertyAssetSetBytes()
       Immutable. The resource name for a set of hotel properties for Performance
       Max for travel goals campaigns.
       
      optional string hotel_property_asset_set = 83 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for hotelPropertyAssetSet.
    • hasListingType

      boolean hasListingType()
       Immutable. Listing type of ads served for this campaign.
       Field is restricted for usage with Performance Max campaigns.
       
      optional .google.ads.googleads.v18.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      Whether the listingType field is set.
    • getListingTypeValue

      int getListingTypeValue()
       Immutable. Listing type of ads served for this campaign.
       Field is restricted for usage with Performance Max campaigns.
       
      optional .google.ads.googleads.v18.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for listingType.
    • getListingType

      ListingTypeEnum.ListingType getListingType()
       Immutable. Listing type of ads served for this campaign.
       Field is restricted for usage with Performance Max campaigns.
       
      optional .google.ads.googleads.v18.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The listingType.
    • getAssetAutomationSettingsList

      List<Campaign.AssetAutomationSetting> getAssetAutomationSettingsList()
       Contains the opt-in/out status of each AssetAutomationType.
       See documentation of each asset automation type enum for default
       opt in/out behavior.
       
      repeated .google.ads.googleads.v18.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
    • getAssetAutomationSettings

      Campaign.AssetAutomationSetting getAssetAutomationSettings(int index)
       Contains the opt-in/out status of each AssetAutomationType.
       See documentation of each asset automation type enum for default
       opt in/out behavior.
       
      repeated .google.ads.googleads.v18.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
    • getAssetAutomationSettingsCount

      int getAssetAutomationSettingsCount()
       Contains the opt-in/out status of each AssetAutomationType.
       See documentation of each asset automation type enum for default
       opt in/out behavior.
       
      repeated .google.ads.googleads.v18.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
    • getAssetAutomationSettingsOrBuilderList

      List<? extends Campaign.AssetAutomationSettingOrBuilder> getAssetAutomationSettingsOrBuilderList()
       Contains the opt-in/out status of each AssetAutomationType.
       See documentation of each asset automation type enum for default
       opt in/out behavior.
       
      repeated .google.ads.googleads.v18.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
    • getAssetAutomationSettingsOrBuilder

      Campaign.AssetAutomationSettingOrBuilder getAssetAutomationSettingsOrBuilder(int index)
       Contains the opt-in/out status of each AssetAutomationType.
       See documentation of each asset automation type enum for default
       opt in/out behavior.
       
      repeated .google.ads.googleads.v18.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
    • getKeywordMatchTypeValue

      int getKeywordMatchTypeValue()
       Keyword match type of Campaign. Set to BROAD to set broad matching for all
       keywords in a campaign.
       
      .google.ads.googleads.v18.enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType keyword_match_type = 90;
      Returns:
      The enum numeric value on the wire for keywordMatchType.
    • getKeywordMatchType

       Keyword match type of Campaign. Set to BROAD to set broad matching for all
       keywords in a campaign.
       
      .google.ads.googleads.v18.enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType keyword_match_type = 90;
      Returns:
      The keywordMatchType.
    • hasBrandGuidelinesEnabled

      boolean hasBrandGuidelinesEnabled()
       Output only. Whether Brand Guidelines are enabled for this Campaign.
       Only applicable to Performance Max campaigns. If enabled, business name
       and logo assets must be linked as CampaignAssets instead of
       AssetGroupAssets.
       
      optional bool brand_guidelines_enabled = 96 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the brandGuidelinesEnabled field is set.
    • getBrandGuidelinesEnabled

      boolean getBrandGuidelinesEnabled()
       Output only. Whether Brand Guidelines are enabled for this Campaign.
       Only applicable to Performance Max campaigns. If enabled, business name
       and logo assets must be linked as CampaignAssets instead of
       AssetGroupAssets.
       
      optional bool brand_guidelines_enabled = 96 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The brandGuidelinesEnabled.
    • hasBiddingStrategy

      boolean hasBiddingStrategy()
       The resource name of the portfolio bidding strategy used by the campaign.
       
      string bidding_strategy = 67 [(.google.api.resource_reference) = { ... }
      Returns:
      Whether the biddingStrategy field is set.
    • getBiddingStrategy

      String getBiddingStrategy()
       The resource name of the portfolio bidding strategy used by the campaign.
       
      string bidding_strategy = 67 [(.google.api.resource_reference) = { ... }
      Returns:
      The biddingStrategy.
    • getBiddingStrategyBytes

      com.google.protobuf.ByteString getBiddingStrategyBytes()
       The resource name of the portfolio bidding strategy used by the campaign.
       
      string bidding_strategy = 67 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for biddingStrategy.
    • hasCommission

      boolean hasCommission()
       Commission is an automatic bidding strategy in which the advertiser pays
       a certain portion of the conversion value.
       
      .google.ads.googleads.v18.common.Commission commission = 49;
      Returns:
      Whether the commission field is set.
    • getCommission

      Commission getCommission()
       Commission is an automatic bidding strategy in which the advertiser pays
       a certain portion of the conversion value.
       
      .google.ads.googleads.v18.common.Commission commission = 49;
      Returns:
      The commission.
    • getCommissionOrBuilder

      CommissionOrBuilder getCommissionOrBuilder()
       Commission is an automatic bidding strategy in which the advertiser pays
       a certain portion of the conversion value.
       
      .google.ads.googleads.v18.common.Commission commission = 49;
    • hasManualCpa

      boolean hasManualCpa()
       Standard Manual CPA bidding strategy.
       Manual bidding strategy that allows advertiser to set the bid per
       advertiser-specified action. Supported only for Local Services campaigns.
       
      .google.ads.googleads.v18.common.ManualCpa manual_cpa = 74;
      Returns:
      Whether the manualCpa field is set.
    • getManualCpa

      ManualCpa getManualCpa()
       Standard Manual CPA bidding strategy.
       Manual bidding strategy that allows advertiser to set the bid per
       advertiser-specified action. Supported only for Local Services campaigns.
       
      .google.ads.googleads.v18.common.ManualCpa manual_cpa = 74;
      Returns:
      The manualCpa.
    • getManualCpaOrBuilder

      ManualCpaOrBuilder getManualCpaOrBuilder()
       Standard Manual CPA bidding strategy.
       Manual bidding strategy that allows advertiser to set the bid per
       advertiser-specified action. Supported only for Local Services campaigns.
       
      .google.ads.googleads.v18.common.ManualCpa manual_cpa = 74;
    • hasManualCpc

      boolean hasManualCpc()
       Standard Manual CPC bidding strategy.
       Manual click-based bidding where user pays per click.
       
      .google.ads.googleads.v18.common.ManualCpc manual_cpc = 24;
      Returns:
      Whether the manualCpc field is set.
    • getManualCpc

      ManualCpc getManualCpc()
       Standard Manual CPC bidding strategy.
       Manual click-based bidding where user pays per click.
       
      .google.ads.googleads.v18.common.ManualCpc manual_cpc = 24;
      Returns:
      The manualCpc.
    • getManualCpcOrBuilder

      ManualCpcOrBuilder getManualCpcOrBuilder()
       Standard Manual CPC bidding strategy.
       Manual click-based bidding where user pays per click.
       
      .google.ads.googleads.v18.common.ManualCpc manual_cpc = 24;
    • hasManualCpm

      boolean hasManualCpm()
       Standard Manual CPM bidding strategy.
       Manual impression-based bidding where user pays per thousand
       impressions.
       
      .google.ads.googleads.v18.common.ManualCpm manual_cpm = 25;
      Returns:
      Whether the manualCpm field is set.
    • getManualCpm

      ManualCpm getManualCpm()
       Standard Manual CPM bidding strategy.
       Manual impression-based bidding where user pays per thousand
       impressions.
       
      .google.ads.googleads.v18.common.ManualCpm manual_cpm = 25;
      Returns:
      The manualCpm.
    • getManualCpmOrBuilder

      ManualCpmOrBuilder getManualCpmOrBuilder()
       Standard Manual CPM bidding strategy.
       Manual impression-based bidding where user pays per thousand
       impressions.
       
      .google.ads.googleads.v18.common.ManualCpm manual_cpm = 25;
    • hasManualCpv

      boolean hasManualCpv()
       A bidding strategy that pays a configurable amount per video view.
       
      .google.ads.googleads.v18.common.ManualCpv manual_cpv = 37;
      Returns:
      Whether the manualCpv field is set.
    • getManualCpv

      ManualCpv getManualCpv()
       A bidding strategy that pays a configurable amount per video view.
       
      .google.ads.googleads.v18.common.ManualCpv manual_cpv = 37;
      Returns:
      The manualCpv.
    • getManualCpvOrBuilder

      ManualCpvOrBuilder getManualCpvOrBuilder()
       A bidding strategy that pays a configurable amount per video view.
       
      .google.ads.googleads.v18.common.ManualCpv manual_cpv = 37;
    • hasMaximizeConversions

      boolean hasMaximizeConversions()
       Standard Maximize Conversions bidding strategy that automatically
       maximizes number of conversions while spending your budget.
       
      .google.ads.googleads.v18.common.MaximizeConversions maximize_conversions = 30;
      Returns:
      Whether the maximizeConversions field is set.
    • getMaximizeConversions

      MaximizeConversions getMaximizeConversions()
       Standard Maximize Conversions bidding strategy that automatically
       maximizes number of conversions while spending your budget.
       
      .google.ads.googleads.v18.common.MaximizeConversions maximize_conversions = 30;
      Returns:
      The maximizeConversions.
    • getMaximizeConversionsOrBuilder

      MaximizeConversionsOrBuilder getMaximizeConversionsOrBuilder()
       Standard Maximize Conversions bidding strategy that automatically
       maximizes number of conversions while spending your budget.
       
      .google.ads.googleads.v18.common.MaximizeConversions maximize_conversions = 30;
    • hasMaximizeConversionValue

      boolean hasMaximizeConversionValue()
       Standard Maximize Conversion Value bidding strategy that automatically
       sets bids to maximize revenue while spending your budget.
       
      .google.ads.googleads.v18.common.MaximizeConversionValue maximize_conversion_value = 31;
      Returns:
      Whether the maximizeConversionValue field is set.
    • getMaximizeConversionValue

      MaximizeConversionValue getMaximizeConversionValue()
       Standard Maximize Conversion Value bidding strategy that automatically
       sets bids to maximize revenue while spending your budget.
       
      .google.ads.googleads.v18.common.MaximizeConversionValue maximize_conversion_value = 31;
      Returns:
      The maximizeConversionValue.
    • getMaximizeConversionValueOrBuilder

      MaximizeConversionValueOrBuilder getMaximizeConversionValueOrBuilder()
       Standard Maximize Conversion Value bidding strategy that automatically
       sets bids to maximize revenue while spending your budget.
       
      .google.ads.googleads.v18.common.MaximizeConversionValue maximize_conversion_value = 31;
    • hasTargetCpa

      boolean hasTargetCpa()
       Standard Target CPA bidding strategy that automatically sets bids to
       help get as many conversions as possible at the target
       cost-per-acquisition (CPA) you set.
       
      .google.ads.googleads.v18.common.TargetCpa target_cpa = 26;
      Returns:
      Whether the targetCpa field is set.
    • getTargetCpa

      TargetCpa getTargetCpa()
       Standard Target CPA bidding strategy that automatically sets bids to
       help get as many conversions as possible at the target
       cost-per-acquisition (CPA) you set.
       
      .google.ads.googleads.v18.common.TargetCpa target_cpa = 26;
      Returns:
      The targetCpa.
    • getTargetCpaOrBuilder

      TargetCpaOrBuilder getTargetCpaOrBuilder()
       Standard Target CPA bidding strategy that automatically sets bids to
       help get as many conversions as possible at the target
       cost-per-acquisition (CPA) you set.
       
      .google.ads.googleads.v18.common.TargetCpa target_cpa = 26;
    • hasTargetImpressionShare

      boolean hasTargetImpressionShare()
       Target Impression Share bidding strategy. An automated bidding strategy
       that sets bids to achieve a chosen percentage of impressions.
       
      .google.ads.googleads.v18.common.TargetImpressionShare target_impression_share = 48;
      Returns:
      Whether the targetImpressionShare field is set.
    • getTargetImpressionShare

      TargetImpressionShare getTargetImpressionShare()
       Target Impression Share bidding strategy. An automated bidding strategy
       that sets bids to achieve a chosen percentage of impressions.
       
      .google.ads.googleads.v18.common.TargetImpressionShare target_impression_share = 48;
      Returns:
      The targetImpressionShare.
    • getTargetImpressionShareOrBuilder

      TargetImpressionShareOrBuilder getTargetImpressionShareOrBuilder()
       Target Impression Share bidding strategy. An automated bidding strategy
       that sets bids to achieve a chosen percentage of impressions.
       
      .google.ads.googleads.v18.common.TargetImpressionShare target_impression_share = 48;
    • hasTargetRoas

      boolean hasTargetRoas()
       Standard Target ROAS bidding strategy that automatically maximizes
       revenue while averaging a specific target return on ad spend (ROAS).
       
      .google.ads.googleads.v18.common.TargetRoas target_roas = 29;
      Returns:
      Whether the targetRoas field is set.
    • getTargetRoas

      TargetRoas getTargetRoas()
       Standard Target ROAS bidding strategy that automatically maximizes
       revenue while averaging a specific target return on ad spend (ROAS).
       
      .google.ads.googleads.v18.common.TargetRoas target_roas = 29;
      Returns:
      The targetRoas.
    • getTargetRoasOrBuilder

      TargetRoasOrBuilder getTargetRoasOrBuilder()
       Standard Target ROAS bidding strategy that automatically maximizes
       revenue while averaging a specific target return on ad spend (ROAS).
       
      .google.ads.googleads.v18.common.TargetRoas target_roas = 29;
    • hasTargetSpend

      boolean hasTargetSpend()
       Standard Target Spend bidding strategy that automatically sets your bids
       to help get as many clicks as possible within your budget.
       
      .google.ads.googleads.v18.common.TargetSpend target_spend = 27;
      Returns:
      Whether the targetSpend field is set.
    • getTargetSpend

      TargetSpend getTargetSpend()
       Standard Target Spend bidding strategy that automatically sets your bids
       to help get as many clicks as possible within your budget.
       
      .google.ads.googleads.v18.common.TargetSpend target_spend = 27;
      Returns:
      The targetSpend.
    • getTargetSpendOrBuilder

      TargetSpendOrBuilder getTargetSpendOrBuilder()
       Standard Target Spend bidding strategy that automatically sets your bids
       to help get as many clicks as possible within your budget.
       
      .google.ads.googleads.v18.common.TargetSpend target_spend = 27;
    • hasPercentCpc

      boolean hasPercentCpc()
       Standard Percent Cpc bidding strategy where bids are a fraction of the
       advertised price for some good or service.
       
      .google.ads.googleads.v18.common.PercentCpc percent_cpc = 34;
      Returns:
      Whether the percentCpc field is set.
    • getPercentCpc

      PercentCpc getPercentCpc()
       Standard Percent Cpc bidding strategy where bids are a fraction of the
       advertised price for some good or service.
       
      .google.ads.googleads.v18.common.PercentCpc percent_cpc = 34;
      Returns:
      The percentCpc.
    • getPercentCpcOrBuilder

      PercentCpcOrBuilder getPercentCpcOrBuilder()
       Standard Percent Cpc bidding strategy where bids are a fraction of the
       advertised price for some good or service.
       
      .google.ads.googleads.v18.common.PercentCpc percent_cpc = 34;
    • hasTargetCpm

      boolean hasTargetCpm()
       A bidding strategy that automatically optimizes cost per thousand
       impressions.
       
      .google.ads.googleads.v18.common.TargetCpm target_cpm = 41;
      Returns:
      Whether the targetCpm field is set.
    • getTargetCpm

      TargetCpm getTargetCpm()
       A bidding strategy that automatically optimizes cost per thousand
       impressions.
       
      .google.ads.googleads.v18.common.TargetCpm target_cpm = 41;
      Returns:
      The targetCpm.
    • getTargetCpmOrBuilder

      TargetCpmOrBuilder getTargetCpmOrBuilder()
       A bidding strategy that automatically optimizes cost per thousand
       impressions.
       
      .google.ads.googleads.v18.common.TargetCpm target_cpm = 41;
    • hasFixedCpm

      boolean hasFixedCpm()
       A manual bidding strategy with a fixed CPM.
       
      .google.ads.googleads.v18.common.FixedCpm fixed_cpm = 92;
      Returns:
      Whether the fixedCpm field is set.
    • getFixedCpm

      FixedCpm getFixedCpm()
       A manual bidding strategy with a fixed CPM.
       
      .google.ads.googleads.v18.common.FixedCpm fixed_cpm = 92;
      Returns:
      The fixedCpm.
    • getFixedCpmOrBuilder

      FixedCpmOrBuilder getFixedCpmOrBuilder()
       A manual bidding strategy with a fixed CPM.
       
      .google.ads.googleads.v18.common.FixedCpm fixed_cpm = 92;
    • hasTargetCpv

      boolean hasTargetCpv()
       An automated bidding strategy that sets bids to optimize performance
       given the target CPV you set.
       
      .google.ads.googleads.v18.common.TargetCpv target_cpv = 93;
      Returns:
      Whether the targetCpv field is set.
    • getTargetCpv

      TargetCpv getTargetCpv()
       An automated bidding strategy that sets bids to optimize performance
       given the target CPV you set.
       
      .google.ads.googleads.v18.common.TargetCpv target_cpv = 93;
      Returns:
      The targetCpv.
    • getTargetCpvOrBuilder

      TargetCpvOrBuilder getTargetCpvOrBuilder()
       An automated bidding strategy that sets bids to optimize performance
       given the target CPV you set.
       
      .google.ads.googleads.v18.common.TargetCpv target_cpv = 93;
    • getCampaignBiddingStrategyCase

      Campaign.CampaignBiddingStrategyCase getCampaignBiddingStrategyCase()