com.google.ads.googleads.v17.resources.CampaignOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/ads/googleads/v17/resources/campaign.proto
// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;
public interface CampaignOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.Campaign)
com.google.protobuf.MessageOrBuilder {
/**
*
* 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) = { ... }
* @return The resourceName.
*/
java.lang.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) = { ... }
* @return The bytes for resourceName.
*/
com.google.protobuf.ByteString
getResourceNameBytes();
/**
*
* Output only. The ID of the campaign.
*
*
* optional int64 id = 59 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the id field is set.
*/
boolean hasId();
/**
*
* Output only. The ID of the campaign.
*
*
* optional int64 id = 59 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The id.
*/
long getId();
/**
*
* 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;
* @return Whether the name field is set.
*/
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;
* @return The name.
*/
java.lang.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;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* 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.v17.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus primary_status = 81 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for primaryStatus.
*/
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.v17.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus primary_status = 81 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The primaryStatus.
*/
com.google.ads.googleads.v17.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus getPrimaryStatus();
/**
*
* 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.v17.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return A list containing the primaryStatusReasons.
*/
java.util.List 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.v17.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The count of primaryStatusReasons.
*/
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.v17.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param index The index of the element to return.
* @return The primaryStatusReasons at the given index.
*/
com.google.ads.googleads.v17.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason getPrimaryStatusReasons(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.v17.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return A list containing the enum numeric values on the wire for primaryStatusReasons.
*/
java.util.List
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.v17.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param index The index of the value to return.
* @return The enum numeric value on the wire of primaryStatusReasons at the given index.
*/
int getPrimaryStatusReasonsValue(int index);
/**
*
* The status of the campaign.
*
* When a new campaign is added, the status defaults to ENABLED.
*
*
* .google.ads.googleads.v17.enums.CampaignStatusEnum.CampaignStatus status = 5;
* @return The enum numeric value on the wire for status.
*/
int getStatusValue();
/**
*
* The status of the campaign.
*
* When a new campaign is added, the status defaults to ENABLED.
*
*
* .google.ads.googleads.v17.enums.CampaignStatusEnum.CampaignStatus status = 5;
* @return The status.
*/
com.google.ads.googleads.v17.enums.CampaignStatusEnum.CampaignStatus getStatus();
/**
*
* Output only. The ad serving status of the campaign.
*
*
* .google.ads.googleads.v17.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for servingStatus.
*/
int getServingStatusValue();
/**
*
* Output only. The ad serving status of the campaign.
*
*
* .google.ads.googleads.v17.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The servingStatus.
*/
com.google.ads.googleads.v17.enums.CampaignServingStatusEnum.CampaignServingStatus getServingStatus();
/**
*
* Output only. The system status of the campaign's bidding strategy.
*
*
* .google.ads.googleads.v17.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for biddingStrategySystemStatus.
*/
int getBiddingStrategySystemStatusValue();
/**
*
* Output only. The system status of the campaign's bidding strategy.
*
*
* .google.ads.googleads.v17.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The biddingStrategySystemStatus.
*/
com.google.ads.googleads.v17.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus getBiddingStrategySystemStatus();
/**
*
* The ad serving optimization status of the campaign.
*
*
* .google.ads.googleads.v17.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8;
* @return The enum numeric value on the wire for adServingOptimizationStatus.
*/
int getAdServingOptimizationStatusValue();
/**
*
* The ad serving optimization status of the campaign.
*
*
* .google.ads.googleads.v17.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8;
* @return The adServingOptimizationStatus.
*/
com.google.ads.googleads.v17.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus getAdServingOptimizationStatus();
/**
*
* 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.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(.google.api.field_behavior) = IMMUTABLE];
* @return The enum numeric value on the wire for advertisingChannelType.
*/
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.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(.google.api.field_behavior) = IMMUTABLE];
* @return The advertisingChannelType.
*/
com.google.ads.googleads.v17.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType getAdvertisingChannelType();
/**
*
* 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.v17.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(.google.api.field_behavior) = IMMUTABLE];
* @return The enum numeric value on the wire for advertisingChannelSubType.
*/
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.v17.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(.google.api.field_behavior) = IMMUTABLE];
* @return The advertisingChannelSubType.
*/
com.google.ads.googleads.v17.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType getAdvertisingChannelSubType();
/**
*
* The URL template for constructing a tracking URL.
*
*
* optional string tracking_url_template = 60;
* @return Whether the trackingUrlTemplate field is set.
*/
boolean hasTrackingUrlTemplate();
/**
*
* The URL template for constructing a tracking URL.
*
*
* optional string tracking_url_template = 60;
* @return The trackingUrlTemplate.
*/
java.lang.String getTrackingUrlTemplate();
/**
*
* The URL template for constructing a tracking URL.
*
*
* optional string tracking_url_template = 60;
* @return The bytes for trackingUrlTemplate.
*/
com.google.protobuf.ByteString
getTrackingUrlTemplateBytes();
/**
*
* 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.v17.common.CustomParameter url_custom_parameters = 12;
*/
java.util.List
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.v17.common.CustomParameter url_custom_parameters = 12;
*/
com.google.ads.googleads.v17.common.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.v17.common.CustomParameter url_custom_parameters = 12;
*/
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.v17.common.CustomParameter url_custom_parameters = 12;
*/
java.util.List
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.v17.common.CustomParameter url_custom_parameters = 12;
*/
com.google.ads.googleads.v17.common.CustomParameterOrBuilder getUrlCustomParametersOrBuilder(
int index);
/**
*
* The Local Services Campaign related settings.
*
*
* .google.ads.googleads.v17.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75;
* @return Whether the localServicesCampaignSettings field is set.
*/
boolean hasLocalServicesCampaignSettings();
/**
*
* The Local Services Campaign related settings.
*
*
* .google.ads.googleads.v17.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75;
* @return The localServicesCampaignSettings.
*/
com.google.ads.googleads.v17.resources.Campaign.LocalServicesCampaignSettings getLocalServicesCampaignSettings();
/**
*
* The Local Services Campaign related settings.
*
*
* .google.ads.googleads.v17.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75;
*/
com.google.ads.googleads.v17.resources.Campaign.LocalServicesCampaignSettingsOrBuilder getLocalServicesCampaignSettingsOrBuilder();
/**
*
* Settings for Travel campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85;
* @return Whether the travelCampaignSettings field is set.
*/
boolean hasTravelCampaignSettings();
/**
*
* Settings for Travel campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85;
* @return The travelCampaignSettings.
*/
com.google.ads.googleads.v17.resources.Campaign.TravelCampaignSettings getTravelCampaignSettings();
/**
*
* Settings for Travel campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85;
*/
com.google.ads.googleads.v17.resources.Campaign.TravelCampaignSettingsOrBuilder getTravelCampaignSettingsOrBuilder();
/**
*
* Settings for Demand Gen campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91;
* @return Whether the demandGenCampaignSettings field is set.
*/
boolean hasDemandGenCampaignSettings();
/**
*
* Settings for Demand Gen campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91;
* @return The demandGenCampaignSettings.
*/
com.google.ads.googleads.v17.resources.Campaign.DemandGenCampaignSettings getDemandGenCampaignSettings();
/**
*
* Settings for Demand Gen campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91;
*/
com.google.ads.googleads.v17.resources.Campaign.DemandGenCampaignSettingsOrBuilder getDemandGenCampaignSettingsOrBuilder();
/**
*
* Settings for Video campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94;
* @return Whether the videoCampaignSettings field is set.
*/
boolean hasVideoCampaignSettings();
/**
*
* Settings for Video campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94;
* @return The videoCampaignSettings.
*/
com.google.ads.googleads.v17.resources.Campaign.VideoCampaignSettings getVideoCampaignSettings();
/**
*
* Settings for Video campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94;
*/
com.google.ads.googleads.v17.resources.Campaign.VideoCampaignSettingsOrBuilder getVideoCampaignSettingsOrBuilder();
/**
*
* Settings for Real-Time Bidding, a feature only available for campaigns
* targeting the Ad Exchange network.
*
*
* .google.ads.googleads.v17.common.RealTimeBiddingSetting real_time_bidding_setting = 39;
* @return Whether the realTimeBiddingSetting field is set.
*/
boolean hasRealTimeBiddingSetting();
/**
*
* Settings for Real-Time Bidding, a feature only available for campaigns
* targeting the Ad Exchange network.
*
*
* .google.ads.googleads.v17.common.RealTimeBiddingSetting real_time_bidding_setting = 39;
* @return The realTimeBiddingSetting.
*/
com.google.ads.googleads.v17.common.RealTimeBiddingSetting getRealTimeBiddingSetting();
/**
*
* Settings for Real-Time Bidding, a feature only available for campaigns
* targeting the Ad Exchange network.
*
*
* .google.ads.googleads.v17.common.RealTimeBiddingSetting real_time_bidding_setting = 39;
*/
com.google.ads.googleads.v17.common.RealTimeBiddingSettingOrBuilder getRealTimeBiddingSettingOrBuilder();
/**
*
* The network settings for the campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.NetworkSettings network_settings = 14;
* @return Whether the networkSettings field is set.
*/
boolean hasNetworkSettings();
/**
*
* The network settings for the campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.NetworkSettings network_settings = 14;
* @return The networkSettings.
*/
com.google.ads.googleads.v17.resources.Campaign.NetworkSettings getNetworkSettings();
/**
*
* The network settings for the campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.NetworkSettings network_settings = 14;
*/
com.google.ads.googleads.v17.resources.Campaign.NetworkSettingsOrBuilder getNetworkSettingsOrBuilder();
/**
*
* Immutable. The hotel setting for the campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.HotelSettingInfo hotel_setting = 32 [(.google.api.field_behavior) = IMMUTABLE];
* @return Whether the hotelSetting field is set.
*/
boolean hasHotelSetting();
/**
*
* Immutable. The hotel setting for the campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.HotelSettingInfo hotel_setting = 32 [(.google.api.field_behavior) = IMMUTABLE];
* @return The hotelSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.HotelSettingInfo getHotelSetting();
/**
*
* Immutable. The hotel setting for the campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.HotelSettingInfo hotel_setting = 32 [(.google.api.field_behavior) = IMMUTABLE];
*/
com.google.ads.googleads.v17.resources.Campaign.HotelSettingInfoOrBuilder getHotelSettingOrBuilder();
/**
*
* The setting for controlling Dynamic Search Ads (DSA).
*
*
* .google.ads.googleads.v17.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
* @return Whether the dynamicSearchAdsSetting field is set.
*/
boolean hasDynamicSearchAdsSetting();
/**
*
* The setting for controlling Dynamic Search Ads (DSA).
*
*
* .google.ads.googleads.v17.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
* @return The dynamicSearchAdsSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.DynamicSearchAdsSetting getDynamicSearchAdsSetting();
/**
*
* The setting for controlling Dynamic Search Ads (DSA).
*
*
* .google.ads.googleads.v17.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33;
*/
com.google.ads.googleads.v17.resources.Campaign.DynamicSearchAdsSettingOrBuilder getDynamicSearchAdsSettingOrBuilder();
/**
*
* The setting for controlling Shopping campaigns.
*
*
* .google.ads.googleads.v17.resources.Campaign.ShoppingSetting shopping_setting = 36;
* @return Whether the shoppingSetting field is set.
*/
boolean hasShoppingSetting();
/**
*
* The setting for controlling Shopping campaigns.
*
*
* .google.ads.googleads.v17.resources.Campaign.ShoppingSetting shopping_setting = 36;
* @return The shoppingSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.ShoppingSetting getShoppingSetting();
/**
*
* The setting for controlling Shopping campaigns.
*
*
* .google.ads.googleads.v17.resources.Campaign.ShoppingSetting shopping_setting = 36;
*/
com.google.ads.googleads.v17.resources.Campaign.ShoppingSettingOrBuilder getShoppingSettingOrBuilder();
/**
*
* Setting for targeting related features.
*
*
* .google.ads.googleads.v17.common.TargetingSetting targeting_setting = 43;
* @return Whether the targetingSetting field is set.
*/
boolean hasTargetingSetting();
/**
*
* Setting for targeting related features.
*
*
* .google.ads.googleads.v17.common.TargetingSetting targeting_setting = 43;
* @return The targetingSetting.
*/
com.google.ads.googleads.v17.common.TargetingSetting getTargetingSetting();
/**
*
* Setting for targeting related features.
*
*
* .google.ads.googleads.v17.common.TargetingSetting targeting_setting = 43;
*/
com.google.ads.googleads.v17.common.TargetingSettingOrBuilder getTargetingSettingOrBuilder();
/**
*
* Immutable. Setting for audience related features.
*
*
* optional .google.ads.googleads.v17.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE];
* @return Whether the audienceSetting field is set.
*/
boolean hasAudienceSetting();
/**
*
* Immutable. Setting for audience related features.
*
*
* optional .google.ads.googleads.v17.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE];
* @return The audienceSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.AudienceSetting getAudienceSetting();
/**
*
* Immutable. Setting for audience related features.
*
*
* optional .google.ads.googleads.v17.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE];
*/
com.google.ads.googleads.v17.resources.Campaign.AudienceSettingOrBuilder getAudienceSettingOrBuilder();
/**
*
* The setting for ads geotargeting.
*
*
* .google.ads.googleads.v17.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47;
* @return Whether the geoTargetTypeSetting field is set.
*/
boolean hasGeoTargetTypeSetting();
/**
*
* The setting for ads geotargeting.
*
*
* .google.ads.googleads.v17.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47;
* @return The geoTargetTypeSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.GeoTargetTypeSetting getGeoTargetTypeSetting();
/**
*
* The setting for ads geotargeting.
*
*
* .google.ads.googleads.v17.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47;
*/
com.google.ads.googleads.v17.resources.Campaign.GeoTargetTypeSettingOrBuilder getGeoTargetTypeSettingOrBuilder();
/**
*
* The setting for local campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50;
* @return Whether the localCampaignSetting field is set.
*/
boolean hasLocalCampaignSetting();
/**
*
* The setting for local campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50;
* @return The localCampaignSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.LocalCampaignSetting getLocalCampaignSetting();
/**
*
* The setting for local campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50;
*/
com.google.ads.googleads.v17.resources.Campaign.LocalCampaignSettingOrBuilder getLocalCampaignSettingOrBuilder();
/**
*
* The setting related to App Campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.AppCampaignSetting app_campaign_setting = 51;
* @return Whether the appCampaignSetting field is set.
*/
boolean hasAppCampaignSetting();
/**
*
* The setting related to App Campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.AppCampaignSetting app_campaign_setting = 51;
* @return The appCampaignSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.AppCampaignSetting getAppCampaignSetting();
/**
*
* The setting related to App Campaign.
*
*
* .google.ads.googleads.v17.resources.Campaign.AppCampaignSetting app_campaign_setting = 51;
*/
com.google.ads.googleads.v17.resources.Campaign.AppCampaignSettingOrBuilder getAppCampaignSettingOrBuilder();
/**
*
* 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) = { ... }
* @return A list containing the labels.
*/
java.util.List
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) = { ... }
* @return The count of labels.
*/
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) = { ... }
* @param index The index of the element to return.
* @return The labels at the given index.
*/
java.lang.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) = { ... }
* @param index The index of the value to return.
* @return The bytes of the labels at the given index.
*/
com.google.protobuf.ByteString
getLabelsBytes(int index);
/**
*
* Output only. The type of campaign: normal, draft, or experiment.
*
*
* .google.ads.googleads.v17.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for experimentType.
*/
int getExperimentTypeValue();
/**
*
* Output only. The type of campaign: normal, draft, or experiment.
*
*
* .google.ads.googleads.v17.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The experimentType.
*/
com.google.ads.googleads.v17.enums.CampaignExperimentTypeEnum.CampaignExperimentType getExperimentType();
/**
*
* 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) = { ... }
* @return Whether the baseCampaign field is set.
*/
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) = { ... }
* @return The baseCampaign.
*/
java.lang.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) = { ... }
* @return The bytes for baseCampaign.
*/
com.google.protobuf.ByteString
getBaseCampaignBytes();
/**
*
* The budget of the campaign.
*
*
* optional string campaign_budget = 62 [(.google.api.resource_reference) = { ... }
* @return Whether the campaignBudget field is set.
*/
boolean hasCampaignBudget();
/**
*
* The budget of the campaign.
*
*
* optional string campaign_budget = 62 [(.google.api.resource_reference) = { ... }
* @return The campaignBudget.
*/
java.lang.String getCampaignBudget();
/**
*
* The budget of the campaign.
*
*
* optional string campaign_budget = 62 [(.google.api.resource_reference) = { ... }
* @return The bytes for campaignBudget.
*/
com.google.protobuf.ByteString
getCampaignBudgetBytes();
/**
*
* 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.v17.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The enum numeric value on the wire for biddingStrategyType.
*/
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.v17.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The biddingStrategyType.
*/
com.google.ads.googleads.v17.enums.BiddingStrategyTypeEnum.BiddingStrategyType getBiddingStrategyType();
/**
*
* 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) = { ... }
* @return The accessibleBiddingStrategy.
*/
java.lang.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) = { ... }
* @return The bytes for accessibleBiddingStrategy.
*/
com.google.protobuf.ByteString
getAccessibleBiddingStrategyBytes();
/**
*
* The date when campaign started in serving customer's timezone in YYYY-MM-DD
* format.
*
*
* optional string start_date = 63;
* @return Whether the startDate field is set.
*/
boolean hasStartDate();
/**
*
* The date when campaign started in serving customer's timezone in YYYY-MM-DD
* format.
*
*
* optional string start_date = 63;
* @return The startDate.
*/
java.lang.String getStartDate();
/**
*
* The date when campaign started in serving customer's timezone in YYYY-MM-DD
* format.
*
*
* optional string start_date = 63;
* @return The bytes for startDate.
*/
com.google.protobuf.ByteString
getStartDateBytes();
/**
*
* The campaign group this campaign belongs to.
*
*
* optional string campaign_group = 76 [(.google.api.resource_reference) = { ... }
* @return Whether the campaignGroup field is set.
*/
boolean hasCampaignGroup();
/**
*
* The campaign group this campaign belongs to.
*
*
* optional string campaign_group = 76 [(.google.api.resource_reference) = { ... }
* @return The campaignGroup.
*/
java.lang.String getCampaignGroup();
/**
*
* The campaign group this campaign belongs to.
*
*
* optional string campaign_group = 76 [(.google.api.resource_reference) = { ... }
* @return The bytes for campaignGroup.
*/
com.google.protobuf.ByteString
getCampaignGroupBytes();
/**
*
* 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;
* @return Whether the endDate field is set.
*/
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;
* @return The endDate.
*/
java.lang.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;
* @return The bytes for endDate.
*/
com.google.protobuf.ByteString
getEndDateBytes();
/**
*
* Suffix used to append query parameters to landing pages that are served
* with parallel tracking.
*
*
* optional string final_url_suffix = 65;
* @return Whether the finalUrlSuffix field is set.
*/
boolean hasFinalUrlSuffix();
/**
*
* Suffix used to append query parameters to landing pages that are served
* with parallel tracking.
*
*
* optional string final_url_suffix = 65;
* @return The finalUrlSuffix.
*/
java.lang.String getFinalUrlSuffix();
/**
*
* Suffix used to append query parameters to landing pages that are served
* with parallel tracking.
*
*
* optional string final_url_suffix = 65;
* @return The bytes for finalUrlSuffix.
*/
com.google.protobuf.ByteString
getFinalUrlSuffixBytes();
/**
*
* A list that limits how often each user will see this campaign's ads.
*
*
* repeated .google.ads.googleads.v17.common.FrequencyCapEntry frequency_caps = 40;
*/
java.util.List
getFrequencyCapsList();
/**
*
* A list that limits how often each user will see this campaign's ads.
*
*
* repeated .google.ads.googleads.v17.common.FrequencyCapEntry frequency_caps = 40;
*/
com.google.ads.googleads.v17.common.FrequencyCapEntry getFrequencyCaps(int index);
/**
*
* A list that limits how often each user will see this campaign's ads.
*
*
* repeated .google.ads.googleads.v17.common.FrequencyCapEntry frequency_caps = 40;
*/
int getFrequencyCapsCount();
/**
*
* A list that limits how often each user will see this campaign's ads.
*
*
* repeated .google.ads.googleads.v17.common.FrequencyCapEntry frequency_caps = 40;
*/
java.util.List
getFrequencyCapsOrBuilderList();
/**
*
* A list that limits how often each user will see this campaign's ads.
*
*
* repeated .google.ads.googleads.v17.common.FrequencyCapEntry frequency_caps = 40;
*/
com.google.ads.googleads.v17.common.FrequencyCapEntryOrBuilder getFrequencyCapsOrBuilder(
int index);
/**
*
* 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.v17.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42;
* @return The enum numeric value on the wire for videoBrandSafetySuitability.
*/
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.v17.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42;
* @return The videoBrandSafetySuitability.
*/
com.google.ads.googleads.v17.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability getVideoBrandSafetySuitability();
/**
*
* Describes how unbranded pharma ads will be displayed.
*
*
* .google.ads.googleads.v17.resources.Campaign.VanityPharma vanity_pharma = 44;
* @return Whether the vanityPharma field is set.
*/
boolean hasVanityPharma();
/**
*
* Describes how unbranded pharma ads will be displayed.
*
*
* .google.ads.googleads.v17.resources.Campaign.VanityPharma vanity_pharma = 44;
* @return The vanityPharma.
*/
com.google.ads.googleads.v17.resources.Campaign.VanityPharma getVanityPharma();
/**
*
* Describes how unbranded pharma ads will be displayed.
*
*
* .google.ads.googleads.v17.resources.Campaign.VanityPharma vanity_pharma = 44;
*/
com.google.ads.googleads.v17.resources.Campaign.VanityPharmaOrBuilder getVanityPharmaOrBuilder();
/**
*
* 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.v17.resources.Campaign.SelectiveOptimization selective_optimization = 45;
* @return Whether the selectiveOptimization field is set.
*/
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.v17.resources.Campaign.SelectiveOptimization selective_optimization = 45;
* @return The selectiveOptimization.
*/
com.google.ads.googleads.v17.resources.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.v17.resources.Campaign.SelectiveOptimization selective_optimization = 45;
*/
com.google.ads.googleads.v17.resources.Campaign.SelectiveOptimizationOrBuilder getSelectiveOptimizationOrBuilder();
/**
*
* Optimization goal setting for this campaign, which includes a set of
* optimization goal types.
*
*
* .google.ads.googleads.v17.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54;
* @return Whether the optimizationGoalSetting field is set.
*/
boolean hasOptimizationGoalSetting();
/**
*
* Optimization goal setting for this campaign, which includes a set of
* optimization goal types.
*
*
* .google.ads.googleads.v17.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54;
* @return The optimizationGoalSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.OptimizationGoalSetting getOptimizationGoalSetting();
/**
*
* Optimization goal setting for this campaign, which includes a set of
* optimization goal types.
*
*
* .google.ads.googleads.v17.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54;
*/
com.google.ads.googleads.v17.resources.Campaign.OptimizationGoalSettingOrBuilder getOptimizationGoalSettingOrBuilder();
/**
*
* Output only. Campaign-level settings for tracking information.
*
*
* .google.ads.googleads.v17.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the trackingSetting field is set.
*/
boolean hasTrackingSetting();
/**
*
* Output only. Campaign-level settings for tracking information.
*
*
* .google.ads.googleads.v17.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The trackingSetting.
*/
com.google.ads.googleads.v17.resources.Campaign.TrackingSetting getTrackingSetting();
/**
*
* Output only. Campaign-level settings for tracking information.
*
*
* .google.ads.googleads.v17.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
com.google.ads.googleads.v17.resources.Campaign.TrackingSettingOrBuilder getTrackingSettingOrBuilder();
/**
*
* Payment mode for the campaign.
*
*
* .google.ads.googleads.v17.enums.PaymentModeEnum.PaymentMode payment_mode = 52;
* @return The enum numeric value on the wire for paymentMode.
*/
int getPaymentModeValue();
/**
*
* Payment mode for the campaign.
*
*
* .google.ads.googleads.v17.enums.PaymentModeEnum.PaymentMode payment_mode = 52;
* @return The paymentMode.
*/
com.google.ads.googleads.v17.enums.PaymentModeEnum.PaymentMode getPaymentMode();
/**
*
* 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];
* @return Whether the optimizationScore field is set.
*/
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];
* @return The optimizationScore.
*/
double getOptimizationScore();
/**
*
* 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.v17.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
* @return A list containing the excludedParentAssetFieldTypes.
*/
java.util.List 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.v17.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
* @return The count of excludedParentAssetFieldTypes.
*/
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.v17.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
* @param index The index of the element to return.
* @return The excludedParentAssetFieldTypes at the given index.
*/
com.google.ads.googleads.v17.enums.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.v17.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
* @return A list containing the enum numeric values on the wire for excludedParentAssetFieldTypes.
*/
java.util.List
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.v17.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69;
* @param index The index of the value to return.
* @return The enum numeric value on the wire of excludedParentAssetFieldTypes at the given index.
*/
int getExcludedParentAssetFieldTypesValue(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.v17.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
* @return A list containing the excludedParentAssetSetTypes.
*/
java.util.List 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.v17.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
* @return The count of excludedParentAssetSetTypes.
*/
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.v17.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
* @param index The index of the element to return.
* @return The excludedParentAssetSetTypes at the given index.
*/
com.google.ads.googleads.v17.enums.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.v17.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
* @return A list containing the enum numeric values on the wire for excludedParentAssetSetTypes.
*/
java.util.List
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.v17.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80;
* @param index The index of the value to return.
* @return The enum numeric value on the wire of excludedParentAssetSetTypes at the given index.
*/
int getExcludedParentAssetSetTypesValue(int index);
/**
*
* 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;
* @return Whether the urlExpansionOptOut field is set.
*/
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;
* @return The urlExpansionOptOut.
*/
boolean getUrlExpansionOptOut();
/**
*
* Output only. Information about campaigns being upgraded to Performance Max.
*
*
* .google.ads.googleads.v17.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return Whether the performanceMaxUpgrade field is set.
*/
boolean hasPerformanceMaxUpgrade();
/**
*
* Output only. Information about campaigns being upgraded to Performance Max.
*
*
* .google.ads.googleads.v17.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return The performanceMaxUpgrade.
*/
com.google.ads.googleads.v17.resources.Campaign.PerformanceMaxUpgrade getPerformanceMaxUpgrade();
/**
*
* Output only. Information about campaigns being upgraded to Performance Max.
*
*
* .google.ads.googleads.v17.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
com.google.ads.googleads.v17.resources.Campaign.PerformanceMaxUpgradeOrBuilder getPerformanceMaxUpgradeOrBuilder();
/**
*
* Immutable. The 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) = { ... }
* @return Whether the hotelPropertyAssetSet field is set.
*/
boolean hasHotelPropertyAssetSet();
/**
*
* Immutable. The 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) = { ... }
* @return The hotelPropertyAssetSet.
*/
java.lang.String getHotelPropertyAssetSet();
/**
*
* Immutable. The 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) = { ... }
* @return The bytes for hotelPropertyAssetSet.
*/
com.google.protobuf.ByteString
getHotelPropertyAssetSetBytes();
/**
*
* Immutable. Listing type of ads served for this campaign.
* Field is restricted for usage with Performance Max campaigns.
*
*
* optional .google.ads.googleads.v17.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE];
* @return Whether the listingType field is set.
*/
boolean hasListingType();
/**
*
* Immutable. Listing type of ads served for this campaign.
* Field is restricted for usage with Performance Max campaigns.
*
*
* optional .google.ads.googleads.v17.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE];
* @return The enum numeric value on the wire for listingType.
*/
int getListingTypeValue();
/**
*
* Immutable. Listing type of ads served for this campaign.
* Field is restricted for usage with Performance Max campaigns.
*
*
* optional .google.ads.googleads.v17.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE];
* @return The listingType.
*/
com.google.ads.googleads.v17.enums.ListingTypeEnum.ListingType getListingType();
/**
*
* 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.v17.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
*/
java.util.List
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.v17.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
*/
com.google.ads.googleads.v17.resources.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.v17.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
*/
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.v17.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
*/
java.util.List
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.v17.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88;
*/
com.google.ads.googleads.v17.resources.Campaign.AssetAutomationSettingOrBuilder getAssetAutomationSettingsOrBuilder(
int index);
/**
*
* Keyword match type of Campaign. Set to BROAD to set broad matching for all
* keywords in a campaign.
*
*
* .google.ads.googleads.v17.enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType keyword_match_type = 90;
* @return The enum numeric value on the wire for keywordMatchType.
*/
int getKeywordMatchTypeValue();
/**
*
* Keyword match type of Campaign. Set to BROAD to set broad matching for all
* keywords in a campaign.
*
*
* .google.ads.googleads.v17.enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType keyword_match_type = 90;
* @return The keywordMatchType.
*/
com.google.ads.googleads.v17.enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType getKeywordMatchType();
/**
*
* Portfolio bidding strategy used by campaign.
*
*
* string bidding_strategy = 67 [(.google.api.resource_reference) = { ... }
* @return Whether the biddingStrategy field is set.
*/
boolean hasBiddingStrategy();
/**
*
* Portfolio bidding strategy used by campaign.
*
*
* string bidding_strategy = 67 [(.google.api.resource_reference) = { ... }
* @return The biddingStrategy.
*/
java.lang.String getBiddingStrategy();
/**
*
* Portfolio bidding strategy used by campaign.
*
*
* string bidding_strategy = 67 [(.google.api.resource_reference) = { ... }
* @return The bytes for biddingStrategy.
*/
com.google.protobuf.ByteString
getBiddingStrategyBytes();
/**
*
* Commission is an automatic bidding strategy in which the advertiser pays
* a certain portion of the conversion value.
*
*
* .google.ads.googleads.v17.common.Commission commission = 49;
* @return Whether the commission field is set.
*/
boolean hasCommission();
/**
*
* Commission is an automatic bidding strategy in which the advertiser pays
* a certain portion of the conversion value.
*
*
* .google.ads.googleads.v17.common.Commission commission = 49;
* @return The commission.
*/
com.google.ads.googleads.v17.common.Commission getCommission();
/**
*
* Commission is an automatic bidding strategy in which the advertiser pays
* a certain portion of the conversion value.
*
*
* .google.ads.googleads.v17.common.Commission commission = 49;
*/
com.google.ads.googleads.v17.common.CommissionOrBuilder getCommissionOrBuilder();
/**
*
* 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.v17.common.ManualCpa manual_cpa = 74;
* @return Whether the manualCpa field is set.
*/
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.v17.common.ManualCpa manual_cpa = 74;
* @return The manualCpa.
*/
com.google.ads.googleads.v17.common.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.v17.common.ManualCpa manual_cpa = 74;
*/
com.google.ads.googleads.v17.common.ManualCpaOrBuilder getManualCpaOrBuilder();
/**
*
* Standard Manual CPC bidding strategy.
* Manual click-based bidding where user pays per click.
*
*
* .google.ads.googleads.v17.common.ManualCpc manual_cpc = 24;
* @return Whether the manualCpc field is set.
*/
boolean hasManualCpc();
/**
*
* Standard Manual CPC bidding strategy.
* Manual click-based bidding where user pays per click.
*
*
* .google.ads.googleads.v17.common.ManualCpc manual_cpc = 24;
* @return The manualCpc.
*/
com.google.ads.googleads.v17.common.ManualCpc getManualCpc();
/**
*
* Standard Manual CPC bidding strategy.
* Manual click-based bidding where user pays per click.
*
*
* .google.ads.googleads.v17.common.ManualCpc manual_cpc = 24;
*/
com.google.ads.googleads.v17.common.ManualCpcOrBuilder getManualCpcOrBuilder();
/**
*
* Standard Manual CPM bidding strategy.
* Manual impression-based bidding where user pays per thousand
* impressions.
*
*
* .google.ads.googleads.v17.common.ManualCpm manual_cpm = 25;
* @return Whether the manualCpm field is set.
*/
boolean hasManualCpm();
/**
*
* Standard Manual CPM bidding strategy.
* Manual impression-based bidding where user pays per thousand
* impressions.
*
*
* .google.ads.googleads.v17.common.ManualCpm manual_cpm = 25;
* @return The manualCpm.
*/
com.google.ads.googleads.v17.common.ManualCpm getManualCpm();
/**
*
* Standard Manual CPM bidding strategy.
* Manual impression-based bidding where user pays per thousand
* impressions.
*
*
* .google.ads.googleads.v17.common.ManualCpm manual_cpm = 25;
*/
com.google.ads.googleads.v17.common.ManualCpmOrBuilder getManualCpmOrBuilder();
/**
*
* A bidding strategy that pays a configurable amount per video view.
*
*
* .google.ads.googleads.v17.common.ManualCpv manual_cpv = 37;
* @return Whether the manualCpv field is set.
*/
boolean hasManualCpv();
/**
*
* A bidding strategy that pays a configurable amount per video view.
*
*
* .google.ads.googleads.v17.common.ManualCpv manual_cpv = 37;
* @return The manualCpv.
*/
com.google.ads.googleads.v17.common.ManualCpv getManualCpv();
/**
*
* A bidding strategy that pays a configurable amount per video view.
*
*
* .google.ads.googleads.v17.common.ManualCpv manual_cpv = 37;
*/
com.google.ads.googleads.v17.common.ManualCpvOrBuilder getManualCpvOrBuilder();
/**
*
* Standard Maximize Conversions bidding strategy that automatically
* maximizes number of conversions while spending your budget.
*
*
* .google.ads.googleads.v17.common.MaximizeConversions maximize_conversions = 30;
* @return Whether the maximizeConversions field is set.
*/
boolean hasMaximizeConversions();
/**
*
* Standard Maximize Conversions bidding strategy that automatically
* maximizes number of conversions while spending your budget.
*
*
* .google.ads.googleads.v17.common.MaximizeConversions maximize_conversions = 30;
* @return The maximizeConversions.
*/
com.google.ads.googleads.v17.common.MaximizeConversions getMaximizeConversions();
/**
*
* Standard Maximize Conversions bidding strategy that automatically
* maximizes number of conversions while spending your budget.
*
*
* .google.ads.googleads.v17.common.MaximizeConversions maximize_conversions = 30;
*/
com.google.ads.googleads.v17.common.MaximizeConversionsOrBuilder getMaximizeConversionsOrBuilder();
/**
*
* Standard Maximize Conversion Value bidding strategy that automatically
* sets bids to maximize revenue while spending your budget.
*
*
* .google.ads.googleads.v17.common.MaximizeConversionValue maximize_conversion_value = 31;
* @return Whether the maximizeConversionValue field is set.
*/
boolean hasMaximizeConversionValue();
/**
*
* Standard Maximize Conversion Value bidding strategy that automatically
* sets bids to maximize revenue while spending your budget.
*
*
* .google.ads.googleads.v17.common.MaximizeConversionValue maximize_conversion_value = 31;
* @return The maximizeConversionValue.
*/
com.google.ads.googleads.v17.common.MaximizeConversionValue getMaximizeConversionValue();
/**
*
* Standard Maximize Conversion Value bidding strategy that automatically
* sets bids to maximize revenue while spending your budget.
*
*
* .google.ads.googleads.v17.common.MaximizeConversionValue maximize_conversion_value = 31;
*/
com.google.ads.googleads.v17.common.MaximizeConversionValueOrBuilder getMaximizeConversionValueOrBuilder();
/**
*
* 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.v17.common.TargetCpa target_cpa = 26;
* @return Whether the targetCpa field is set.
*/
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.v17.common.TargetCpa target_cpa = 26;
* @return The targetCpa.
*/
com.google.ads.googleads.v17.common.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.v17.common.TargetCpa target_cpa = 26;
*/
com.google.ads.googleads.v17.common.TargetCpaOrBuilder getTargetCpaOrBuilder();
/**
*
* Target Impression Share bidding strategy. An automated bidding strategy
* that sets bids to achieve a chosen percentage of impressions.
*
*
* .google.ads.googleads.v17.common.TargetImpressionShare target_impression_share = 48;
* @return Whether the targetImpressionShare field is set.
*/
boolean hasTargetImpressionShare();
/**
*
* Target Impression Share bidding strategy. An automated bidding strategy
* that sets bids to achieve a chosen percentage of impressions.
*
*
* .google.ads.googleads.v17.common.TargetImpressionShare target_impression_share = 48;
* @return The targetImpressionShare.
*/
com.google.ads.googleads.v17.common.TargetImpressionShare getTargetImpressionShare();
/**
*
* Target Impression Share bidding strategy. An automated bidding strategy
* that sets bids to achieve a chosen percentage of impressions.
*
*
* .google.ads.googleads.v17.common.TargetImpressionShare target_impression_share = 48;
*/
com.google.ads.googleads.v17.common.TargetImpressionShareOrBuilder getTargetImpressionShareOrBuilder();
/**
*
* Standard Target ROAS bidding strategy that automatically maximizes
* revenue while averaging a specific target return on ad spend (ROAS).
*
*
* .google.ads.googleads.v17.common.TargetRoas target_roas = 29;
* @return Whether the targetRoas field is set.
*/
boolean hasTargetRoas();
/**
*
* Standard Target ROAS bidding strategy that automatically maximizes
* revenue while averaging a specific target return on ad spend (ROAS).
*
*
* .google.ads.googleads.v17.common.TargetRoas target_roas = 29;
* @return The targetRoas.
*/
com.google.ads.googleads.v17.common.TargetRoas getTargetRoas();
/**
*
* Standard Target ROAS bidding strategy that automatically maximizes
* revenue while averaging a specific target return on ad spend (ROAS).
*
*
* .google.ads.googleads.v17.common.TargetRoas target_roas = 29;
*/
com.google.ads.googleads.v17.common.TargetRoasOrBuilder getTargetRoasOrBuilder();
/**
*
* Standard Target Spend bidding strategy that automatically sets your bids
* to help get as many clicks as possible within your budget.
*
*
* .google.ads.googleads.v17.common.TargetSpend target_spend = 27;
* @return Whether the targetSpend field is set.
*/
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.v17.common.TargetSpend target_spend = 27;
* @return The targetSpend.
*/
com.google.ads.googleads.v17.common.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.v17.common.TargetSpend target_spend = 27;
*/
com.google.ads.googleads.v17.common.TargetSpendOrBuilder getTargetSpendOrBuilder();
/**
*
* Standard Percent Cpc bidding strategy where bids are a fraction of the
* advertised price for some good or service.
*
*
* .google.ads.googleads.v17.common.PercentCpc percent_cpc = 34;
* @return Whether the percentCpc field is set.
*/
boolean hasPercentCpc();
/**
*
* Standard Percent Cpc bidding strategy where bids are a fraction of the
* advertised price for some good or service.
*
*
* .google.ads.googleads.v17.common.PercentCpc percent_cpc = 34;
* @return The percentCpc.
*/
com.google.ads.googleads.v17.common.PercentCpc getPercentCpc();
/**
*
* Standard Percent Cpc bidding strategy where bids are a fraction of the
* advertised price for some good or service.
*
*
* .google.ads.googleads.v17.common.PercentCpc percent_cpc = 34;
*/
com.google.ads.googleads.v17.common.PercentCpcOrBuilder getPercentCpcOrBuilder();
/**
*
* A bidding strategy that automatically optimizes cost per thousand
* impressions.
*
*
* .google.ads.googleads.v17.common.TargetCpm target_cpm = 41;
* @return Whether the targetCpm field is set.
*/
boolean hasTargetCpm();
/**
*
* A bidding strategy that automatically optimizes cost per thousand
* impressions.
*
*
* .google.ads.googleads.v17.common.TargetCpm target_cpm = 41;
* @return The targetCpm.
*/
com.google.ads.googleads.v17.common.TargetCpm getTargetCpm();
/**
*
* A bidding strategy that automatically optimizes cost per thousand
* impressions.
*
*
* .google.ads.googleads.v17.common.TargetCpm target_cpm = 41;
*/
com.google.ads.googleads.v17.common.TargetCpmOrBuilder getTargetCpmOrBuilder();
/**
*
* A manual bidding strategy with a fixed CPM.
*
*
* .google.ads.googleads.v17.common.FixedCpm fixed_cpm = 92;
* @return Whether the fixedCpm field is set.
*/
boolean hasFixedCpm();
/**
*
* A manual bidding strategy with a fixed CPM.
*
*
* .google.ads.googleads.v17.common.FixedCpm fixed_cpm = 92;
* @return The fixedCpm.
*/
com.google.ads.googleads.v17.common.FixedCpm getFixedCpm();
/**
*
* A manual bidding strategy with a fixed CPM.
*
*
* .google.ads.googleads.v17.common.FixedCpm fixed_cpm = 92;
*/
com.google.ads.googleads.v17.common.FixedCpmOrBuilder getFixedCpmOrBuilder();
/**
*
* An automated bidding strategy that sets bids to optimize performance
* given the target CPV you set.
*
*
* .google.ads.googleads.v17.common.TargetCpv target_cpv = 93;
* @return Whether the targetCpv field is set.
*/
boolean hasTargetCpv();
/**
*
* An automated bidding strategy that sets bids to optimize performance
* given the target CPV you set.
*
*
* .google.ads.googleads.v17.common.TargetCpv target_cpv = 93;
* @return The targetCpv.
*/
com.google.ads.googleads.v17.common.TargetCpv getTargetCpv();
/**
*
* An automated bidding strategy that sets bids to optimize performance
* given the target CPV you set.
*
*
* .google.ads.googleads.v17.common.TargetCpv target_cpv = 93;
*/
com.google.ads.googleads.v17.common.TargetCpvOrBuilder getTargetCpvOrBuilder();
com.google.ads.googleads.v17.resources.Campaign.CampaignBiddingStrategyCase getCampaignBiddingStrategyCase();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy