google.ads.googleads.v23.resources.Campaign */ class Campaign extends \Google\Protobuf\Internal\Message { /** * Immutable. The resource name of the campaign. * Campaign resource names have the form: * `customers/{customer_id}/campaigns/{campaign_id}` * * Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { */ protected $resource_name = ''; /** * Output only. The ID of the campaign. * * Generated from protobuf field optional int64 id = 59 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $id = null; /** * 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. * * Generated from protobuf field optional string name = 58; */ protected $name = null; /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus primary_status = 81 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $primary_status = 0; /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $primary_status_reasons; /** * The status of the campaign. * When a new campaign is added, the status defaults to ENABLED. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignStatusEnum.CampaignStatus status = 5; */ protected $status = 0; /** * Output only. The ad serving status of the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $serving_status = 0; /** * Output only. The system status of the campaign's bidding strategy. * * Generated from protobuf field .google.ads.googleads.v23.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $bidding_strategy_system_status = 0; /** * The ad serving optimization status of the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8; */ protected $ad_serving_optimization_status = 0; /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(.google.api.field_behavior) = IMMUTABLE]; */ protected $advertising_channel_type = 0; /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(.google.api.field_behavior) = IMMUTABLE]; */ protected $advertising_channel_sub_type = 0; /** * The URL template for constructing a tracking URL. * * Generated from protobuf field optional string tracking_url_template = 60; */ protected $tracking_url_template = null; /** * The list of mappings used to substitute custom parameter tags in a * `tracking_url_template`, `final_urls`, or `mobile_final_urls`. * * Generated from protobuf field repeated .google.ads.googleads.v23.common.CustomParameter url_custom_parameters = 12; */ private $url_custom_parameters; /** * The Local Services Campaign related settings. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75; */ protected $local_services_campaign_settings = null; /** * Settings for Travel campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85; */ protected $travel_campaign_settings = null; /** * Settings for Demand Gen campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91; */ protected $demand_gen_campaign_settings = null; /** * Settings for Video campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94; */ protected $video_campaign_settings = null; /** * Settings for Performance Max campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.PmaxCampaignSettings pmax_campaign_settings = 97; */ protected $pmax_campaign_settings = null; /** * Settings for Real-Time Bidding, a feature only available for campaigns * targeting the Ad Exchange network. * * Generated from protobuf field .google.ads.googleads.v23.common.RealTimeBiddingSetting real_time_bidding_setting = 39; */ protected $real_time_bidding_setting = null; /** * The network settings for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.NetworkSettings network_settings = 14; */ protected $network_settings = null; /** * The hotel setting for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.HotelSettingInfo hotel_setting = 32; */ protected $hotel_setting = null; /** * The setting for controlling Dynamic Search Ads (DSA). * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33; */ protected $dynamic_search_ads_setting = null; /** * The setting for controlling Shopping campaigns. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.ShoppingSetting shopping_setting = 36; */ protected $shopping_setting = null; /** * Setting for targeting related features. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetingSetting targeting_setting = 43; */ protected $targeting_setting = null; /** * Immutable. Setting for audience related features. * * Generated from protobuf field optional .google.ads.googleads.v23.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE]; */ protected $audience_setting = null; /** * The setting for ads geotargeting. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47; */ protected $geo_target_type_setting = null; /** * The setting for local campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50; */ protected $local_campaign_setting = null; /** * The setting related to App Campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.AppCampaignSetting app_campaign_setting = 51; */ protected $app_campaign_setting = null; /** * Output only. The resource names of labels attached to this campaign. * * Generated from protobuf field repeated string labels = 61 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { */ private $labels; /** * Output only. The type of campaign: normal, draft, or experiment. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $experiment_type = 0; /** * 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. * * Generated from protobuf field optional string base_campaign = 56 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { */ protected $base_campaign = null; /** * The resource name of the campaign budget of the campaign. * * Generated from protobuf field optional string campaign_budget = 62 [(.google.api.resource_reference) = { */ protected $campaign_budget = null; /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $bidding_strategy_type = 0; /** * 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. * * Generated from protobuf field string accessible_bidding_strategy = 71 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { */ protected $accessible_bidding_strategy = ''; /** * The resource name of the campaign group that this campaign belongs to. * * Generated from protobuf field optional string campaign_group = 76 [(.google.api.resource_reference) = { */ protected $campaign_group = null; /** * The date and time when campaign started in serving. The timestamp is in * the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time * component to 00:00:00 for daily granularity, time granularity is only * supported for some campaign types. * * Generated from protobuf field optional string start_date_time = 104; */ protected $start_date_time = null; /** * The last day and time of the campaign in serving customer's timezone in * "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily * granularity, time granularity is only supported for some campaign types. On * create, defaults to running indefinitely. To set an existing campaign to * run indefinitely, clear this field. * * Generated from protobuf field optional string end_date_time = 105; */ protected $end_date_time = null; /** * Suffix used to append query parameters to landing pages that are served * with parallel tracking. * * Generated from protobuf field optional string final_url_suffix = 65; */ protected $final_url_suffix = null; /** * A list that limits how often each user will see this campaign's ads. * * Generated from protobuf field repeated .google.ads.googleads.v23.common.FrequencyCapEntry frequency_caps = 40; */ private $frequency_caps; /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42; */ protected $video_brand_safety_suitability = 0; /** * Describes how unbranded pharma ads will be displayed. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.VanityPharma vanity_pharma = 44; */ protected $vanity_pharma = null; /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.SelectiveOptimization selective_optimization = 45; */ protected $selective_optimization = null; /** * Optimization goal setting for this campaign, which includes a set of * optimization goal types. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54; */ protected $optimization_goal_setting = null; /** * Output only. Campaign-level settings for tracking information. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $tracking_setting = null; /** * Payment mode for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.PaymentModeEnum.PaymentMode payment_mode = 52; */ protected $payment_mode = 0; /** * 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. * * Generated from protobuf field optional double optimization_score = 66 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $optimization_score = null; /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69; */ private $excluded_parent_asset_field_types; /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80; */ private $excluded_parent_asset_set_types; /** * Output only. Information about campaigns being upgraded to Performance Max. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $performance_max_upgrade = null; /** * Immutable. The resource name for a set of hotel properties for Performance * Max for travel goals campaigns. * * Generated from protobuf field optional string hotel_property_asset_set = 83 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { */ protected $hotel_property_asset_set = null; /** * Immutable. Listing type of ads served for this campaign. * Field is restricted for usage with Performance Max campaigns. * * Generated from protobuf field optional .google.ads.googleads.v23.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE]; */ protected $listing_type = null; /** * Contains the opt-in/out status of each AssetAutomationType. * See documentation of each asset automation type enum for default * opt in/out behavior. * * Generated from protobuf field repeated .google.ads.googleads.v23.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88; */ private $asset_automation_settings; /** * Keyword match type of Campaign. Set to BROAD to set broad matching for all * keywords in a campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType keyword_match_type = 90; */ protected $keyword_match_type = 0; /** * Immutable. 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. * Writable only at campaign creation. Set to true to enable Brand * Guidelines when creating a new Performance Max campaign. * Immutable after creation. This field cannot be modified using standard * update operations after the campaign has been created. * For existing campaigns: To enable Brand Guidelines on a campaign after it * has been created, use the CampaignService.EnablePMaxBrandGuidelines method, * which is a separate operation. It is not possible to disable Brand * Guidelines for an existing campaign. * Incompatible with Travel Goals: This feature is not supported for * Performance Max campaigns with Travel Goals. Attempting to set this field * to true for a Travel Goals campaign will result in an error. * * Generated from protobuf field optional bool brand_guidelines_enabled = 96 [(.google.api.field_behavior) = IMMUTABLE]; */ protected $brand_guidelines_enabled = null; /** * These settings control how your brand appears in automatically generated * assets and formats within this campaign. Note: These settings can only be * used for Performance Max campaigns that have Brand Guidelines enabled. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.BrandGuidelines brand_guidelines = 98; */ protected $brand_guidelines = null; /** * Settings to control automatically generated text assets. Only available * in Performance Max and Search campaigns (Brand Guidelines does not need * to be enabled). * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TextGuidelines text_guidelines = 107; */ protected $text_guidelines = null; /** * Third-Party integration partners. * * Generated from protobuf field .google.ads.googleads.v23.common.CampaignThirdPartyIntegrationPartners third_party_integration_partners = 100; */ protected $third_party_integration_partners = null; /** * Settings for AI Max in search campaigns. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.AiMaxSetting ai_max_setting = 101; */ protected $ai_max_setting = null; /** * The advertiser should self-declare whether this campaign contains * political advertising content targeted towards the European Union. * * Generated from protobuf field .google.ads.googleads.v23.enums.EuPoliticalAdvertisingStatusEnum.EuPoliticalAdvertisingStatus contains_eu_political_advertising = 102; */ protected $contains_eu_political_advertising = 0; /** * Output only. Types of feeds that are attached directly to this campaign. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetSetTypeEnum.AssetSetType feed_types = 103 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $feed_types; /** * Output only. Indicates whether this campaign is missing a declaration about * whether it contains political advertising targeted towards the EU and is * ineligible for any exemptions. If this field is true, use the * contains_eu_political_advertising field to add the required declaration. * This field is read-only. * * Generated from protobuf field bool missing_eu_political_advertising_declaration = 108 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ protected $missing_eu_political_advertising_declaration = false; protected $campaign_bidding_strategy; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $resource_name * Immutable. The resource name of the campaign. * Campaign resource names have the form: * `customers/{customer_id}/campaigns/{campaign_id}` * @type int|string $id * Output only. The ID of the campaign. * @type string $name * 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. * @type int $primary_status * 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. * @type int[] $primary_status_reasons * 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. * @type int $status * The status of the campaign. * When a new campaign is added, the status defaults to ENABLED. * @type int $serving_status * Output only. The ad serving status of the campaign. * @type int $bidding_strategy_system_status * Output only. The system status of the campaign's bidding strategy. * @type int $ad_serving_optimization_status * The ad serving optimization status of the campaign. * @type int $advertising_channel_type * 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. * @type int $advertising_channel_sub_type * 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. * @type string $tracking_url_template * The URL template for constructing a tracking URL. * @type \Google\Ads\GoogleAds\V23\Common\CustomParameter[] $url_custom_parameters * The list of mappings used to substitute custom parameter tags in a * `tracking_url_template`, `final_urls`, or `mobile_final_urls`. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\LocalServicesCampaignSettings $local_services_campaign_settings * The Local Services Campaign related settings. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\TravelCampaignSettings $travel_campaign_settings * Settings for Travel campaign. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\DemandGenCampaignSettings $demand_gen_campaign_settings * Settings for Demand Gen campaign. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\VideoCampaignSettings $video_campaign_settings * Settings for Video campaign. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\PmaxCampaignSettings $pmax_campaign_settings * Settings for Performance Max campaign. * @type \Google\Ads\GoogleAds\V23\Common\RealTimeBiddingSetting $real_time_bidding_setting * Settings for Real-Time Bidding, a feature only available for campaigns * targeting the Ad Exchange network. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\NetworkSettings $network_settings * The network settings for the campaign. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\HotelSettingInfo $hotel_setting * The hotel setting for the campaign. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\DynamicSearchAdsSetting $dynamic_search_ads_setting * The setting for controlling Dynamic Search Ads (DSA). * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\ShoppingSetting $shopping_setting * The setting for controlling Shopping campaigns. * @type \Google\Ads\GoogleAds\V23\Common\TargetingSetting $targeting_setting * Setting for targeting related features. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\AudienceSetting $audience_setting * Immutable. Setting for audience related features. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\GeoTargetTypeSetting $geo_target_type_setting * The setting for ads geotargeting. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\LocalCampaignSetting $local_campaign_setting * The setting for local campaign. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\AppCampaignSetting $app_campaign_setting * The setting related to App Campaign. * @type string[] $labels * Output only. The resource names of labels attached to this campaign. * @type int $experiment_type * Output only. The type of campaign: normal, draft, or experiment. * @type string $base_campaign * 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. * @type string $campaign_budget * The resource name of the campaign budget of the campaign. * @type int $bidding_strategy_type * 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. * @type string $accessible_bidding_strategy * 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. * @type string $campaign_group * The resource name of the campaign group that this campaign belongs to. * @type string $start_date_time * The date and time when campaign started in serving. The timestamp is in * the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time * component to 00:00:00 for daily granularity, time granularity is only * supported for some campaign types. * @type string $end_date_time * The last day and time of the campaign in serving customer's timezone in * "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily * granularity, time granularity is only supported for some campaign types. On * create, defaults to running indefinitely. To set an existing campaign to * run indefinitely, clear this field. * @type string $final_url_suffix * Suffix used to append query parameters to landing pages that are served * with parallel tracking. * @type \Google\Ads\GoogleAds\V23\Common\FrequencyCapEntry[] $frequency_caps * A list that limits how often each user will see this campaign's ads. * @type int $video_brand_safety_suitability * 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. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\VanityPharma $vanity_pharma * Describes how unbranded pharma ads will be displayed. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\SelectiveOptimization $selective_optimization * 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. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\OptimizationGoalSetting $optimization_goal_setting * Optimization goal setting for this campaign, which includes a set of * optimization goal types. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\TrackingSetting $tracking_setting * Output only. Campaign-level settings for tracking information. * @type int $payment_mode * Payment mode for the campaign. * @type float $optimization_score * 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. * @type int[] $excluded_parent_asset_field_types * 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. * @type int[] $excluded_parent_asset_set_types * 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. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\PerformanceMaxUpgrade $performance_max_upgrade * Output only. Information about campaigns being upgraded to Performance Max. * @type string $hotel_property_asset_set * Immutable. The resource name for a set of hotel properties for Performance * Max for travel goals campaigns. * @type int $listing_type * Immutable. Listing type of ads served for this campaign. * Field is restricted for usage with Performance Max campaigns. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\AssetAutomationSetting[] $asset_automation_settings * Contains the opt-in/out status of each AssetAutomationType. * See documentation of each asset automation type enum for default * opt in/out behavior. * @type int $keyword_match_type * Keyword match type of Campaign. Set to BROAD to set broad matching for all * keywords in a campaign. * @type bool $brand_guidelines_enabled * Immutable. 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. * Writable only at campaign creation. Set to true to enable Brand * Guidelines when creating a new Performance Max campaign. * Immutable after creation. This field cannot be modified using standard * update operations after the campaign has been created. * For existing campaigns: To enable Brand Guidelines on a campaign after it * has been created, use the CampaignService.EnablePMaxBrandGuidelines method, * which is a separate operation. It is not possible to disable Brand * Guidelines for an existing campaign. * Incompatible with Travel Goals: This feature is not supported for * Performance Max campaigns with Travel Goals. Attempting to set this field * to true for a Travel Goals campaign will result in an error. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\BrandGuidelines $brand_guidelines * These settings control how your brand appears in automatically generated * assets and formats within this campaign. Note: These settings can only be * used for Performance Max campaigns that have Brand Guidelines enabled. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\TextGuidelines $text_guidelines * Settings to control automatically generated text assets. Only available * in Performance Max and Search campaigns (Brand Guidelines does not need * to be enabled). * @type \Google\Ads\GoogleAds\V23\Common\CampaignThirdPartyIntegrationPartners $third_party_integration_partners * Third-Party integration partners. * @type \Google\Ads\GoogleAds\V23\Resources\Campaign\AiMaxSetting $ai_max_setting * Settings for AI Max in search campaigns. * @type int $contains_eu_political_advertising * The advertiser should self-declare whether this campaign contains * political advertising content targeted towards the European Union. * @type int[] $feed_types * Output only. Types of feeds that are attached directly to this campaign. * @type bool $missing_eu_political_advertising_declaration * Output only. Indicates whether this campaign is missing a declaration about * whether it contains political advertising targeted towards the EU and is * ineligible for any exemptions. If this field is true, use the * contains_eu_political_advertising field to add the required declaration. * This field is read-only. * @type string $bidding_strategy * The resource name of the portfolio bidding strategy used by the campaign. * @type \Google\Ads\GoogleAds\V23\Common\Commission $commission * Commission is an automatic bidding strategy in which the advertiser pays * a certain portion of the conversion value. * @type \Google\Ads\GoogleAds\V23\Common\ManualCpa $manual_cpa * 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. * @type \Google\Ads\GoogleAds\V23\Common\ManualCpc $manual_cpc * Standard Manual CPC bidding strategy. * Manual click-based bidding where user pays per click. * @type \Google\Ads\GoogleAds\V23\Common\ManualCpm $manual_cpm * Standard Manual CPM bidding strategy. * Manual impression-based bidding where user pays per thousand * impressions. * @type \Google\Ads\GoogleAds\V23\Common\ManualCpv $manual_cpv * A bidding strategy that pays a configurable amount per video view. * @type \Google\Ads\GoogleAds\V23\Common\MaximizeConversions $maximize_conversions * Standard Maximize Conversions bidding strategy that automatically * maximizes number of conversions while spending your budget. * @type \Google\Ads\GoogleAds\V23\Common\MaximizeConversionValue $maximize_conversion_value * Standard Maximize Conversion Value bidding strategy that automatically * sets bids to maximize revenue while spending your budget. * @type \Google\Ads\GoogleAds\V23\Common\TargetCpa $target_cpa * 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. * @type \Google\Ads\GoogleAds\V23\Common\TargetImpressionShare $target_impression_share * Target Impression Share bidding strategy. An automated bidding strategy * that sets bids to achieve a chosen percentage of impressions. * @type \Google\Ads\GoogleAds\V23\Common\TargetRoas $target_roas * Standard Target ROAS bidding strategy that automatically maximizes * revenue while averaging a specific target return on ad spend (ROAS). * @type \Google\Ads\GoogleAds\V23\Common\TargetSpend $target_spend * Standard Target Spend bidding strategy that automatically sets your bids * to help get as many clicks as possible within your budget. * @type \Google\Ads\GoogleAds\V23\Common\PercentCpc $percent_cpc * Standard Percent Cpc bidding strategy where bids are a fraction of the * advertised price for some good or service. * @type \Google\Ads\GoogleAds\V23\Common\TargetCpm $target_cpm * A bidding strategy that automatically optimizes cost per thousand * impressions. * @type \Google\Ads\GoogleAds\V23\Common\FixedCpm $fixed_cpm * A manual bidding strategy with a fixed CPM. * @type \Google\Ads\GoogleAds\V23\Common\TargetCpv $target_cpv * An automated bidding strategy that sets bids to optimize performance * given the target CPV you set. * @type \Google\Ads\GoogleAds\V23\Common\TargetCpc $target_cpc * An automated bidding strategy that sets bids to help get as many clicks * as possible at the target cost-per-click (CPC) you set. * } */ public function __construct($data = null) { \GPBMetadata\Google\Ads\GoogleAds\V23\Resources\Campaign::initOnce(); parent::__construct($data); } /** * Immutable. The resource name of the campaign. * Campaign resource names have the form: * `customers/{customer_id}/campaigns/{campaign_id}` * * Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { * * @return string */ public function getResourceName() { return $this->resource_name; } /** * Immutable. The resource name of the campaign. * Campaign resource names have the form: * `customers/{customer_id}/campaigns/{campaign_id}` * * Generated from protobuf field string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { * * @param string $var * @return $this */ public function setResourceName($var) { GPBUtil::checkString($var, true); $this->resource_name = $var; return $this; } /** * Output only. The ID of the campaign. * * Generated from protobuf field optional int64 id = 59 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return int|string */ public function getId() { return isset($this->id) ? $this->id : 0; } public function hasId() { return isset($this->id); } public function clearId() { unset($this->id); } /** * Output only. The ID of the campaign. * * Generated from protobuf field optional int64 id = 59 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param int|string $var * @return $this */ public function setId($var) { GPBUtil::checkInt64($var); $this->id = $var; return $this; } /** * 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. * * Generated from protobuf field optional string name = 58; * * @return string */ public function getName() { return isset($this->name) ? $this->name : ''; } public function hasName() { return isset($this->name); } public function clearName() { unset($this->name); } /** * 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. * * Generated from protobuf field optional string name = 58; * * @param string $var * @return $this */ public function setName($var) { GPBUtil::checkString($var, true); $this->name = $var; return $this; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus primary_status = 81 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return int */ public function getPrimaryStatus() { return $this->primary_status; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignPrimaryStatusEnum.CampaignPrimaryStatus primary_status = 81 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param int $var * @return $this */ public function setPrimaryStatus($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\CampaignPrimaryStatusEnum\CampaignPrimaryStatus::class); $this->primary_status = $var; return $this; } /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return RepeatedField */ public function getPrimaryStatusReasons() { return $this->primary_status_reasons; } /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.CampaignPrimaryStatusReasonEnum.CampaignPrimaryStatusReason primary_status_reasons = 82 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param int[] $var * @return $this */ public function setPrimaryStatusReasons($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\GoogleAds\V23\Enums\CampaignPrimaryStatusReasonEnum\CampaignPrimaryStatusReason::class); $this->primary_status_reasons = $arr; return $this; } /** * The status of the campaign. * When a new campaign is added, the status defaults to ENABLED. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignStatusEnum.CampaignStatus status = 5; * * @return int */ public function getStatus() { return $this->status; } /** * The status of the campaign. * When a new campaign is added, the status defaults to ENABLED. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignStatusEnum.CampaignStatus status = 5; * * @param int $var * @return $this */ public function setStatus($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\CampaignStatusEnum\CampaignStatus::class); $this->status = $var; return $this; } /** * Output only. The ad serving status of the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return int */ public function getServingStatus() { return $this->serving_status; } /** * Output only. The ad serving status of the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignServingStatusEnum.CampaignServingStatus serving_status = 21 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param int $var * @return $this */ public function setServingStatus($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\CampaignServingStatusEnum\CampaignServingStatus::class); $this->serving_status = $var; return $this; } /** * Output only. The system status of the campaign's bidding strategy. * * Generated from protobuf field .google.ads.googleads.v23.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return int */ public function getBiddingStrategySystemStatus() { return $this->bidding_strategy_system_status; } /** * Output only. The system status of the campaign's bidding strategy. * * Generated from protobuf field .google.ads.googleads.v23.enums.BiddingStrategySystemStatusEnum.BiddingStrategySystemStatus bidding_strategy_system_status = 78 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param int $var * @return $this */ public function setBiddingStrategySystemStatus($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\BiddingStrategySystemStatusEnum\BiddingStrategySystemStatus::class); $this->bidding_strategy_system_status = $var; return $this; } /** * The ad serving optimization status of the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8; * * @return int */ public function getAdServingOptimizationStatus() { return $this->ad_serving_optimization_status; } /** * The ad serving optimization status of the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdServingOptimizationStatusEnum.AdServingOptimizationStatus ad_serving_optimization_status = 8; * * @param int $var * @return $this */ public function setAdServingOptimizationStatus($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\AdServingOptimizationStatusEnum\AdServingOptimizationStatus::class); $this->ad_serving_optimization_status = $var; return $this; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(.google.api.field_behavior) = IMMUTABLE]; * * @return int */ public function getAdvertisingChannelType() { return $this->advertising_channel_type; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdvertisingChannelTypeEnum.AdvertisingChannelType advertising_channel_type = 9 [(.google.api.field_behavior) = IMMUTABLE]; * * @param int $var * @return $this */ public function setAdvertisingChannelType($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\AdvertisingChannelTypeEnum\AdvertisingChannelType::class); $this->advertising_channel_type = $var; return $this; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(.google.api.field_behavior) = IMMUTABLE]; * * @return int */ public function getAdvertisingChannelSubType() { return $this->advertising_channel_sub_type; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.AdvertisingChannelSubTypeEnum.AdvertisingChannelSubType advertising_channel_sub_type = 10 [(.google.api.field_behavior) = IMMUTABLE]; * * @param int $var * @return $this */ public function setAdvertisingChannelSubType($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\AdvertisingChannelSubTypeEnum\AdvertisingChannelSubType::class); $this->advertising_channel_sub_type = $var; return $this; } /** * The URL template for constructing a tracking URL. * * Generated from protobuf field optional string tracking_url_template = 60; * * @return string */ public function getTrackingUrlTemplate() { return isset($this->tracking_url_template) ? $this->tracking_url_template : ''; } public function hasTrackingUrlTemplate() { return isset($this->tracking_url_template); } public function clearTrackingUrlTemplate() { unset($this->tracking_url_template); } /** * The URL template for constructing a tracking URL. * * Generated from protobuf field optional string tracking_url_template = 60; * * @param string $var * @return $this */ public function setTrackingUrlTemplate($var) { GPBUtil::checkString($var, true); $this->tracking_url_template = $var; return $this; } /** * The list of mappings used to substitute custom parameter tags in a * `tracking_url_template`, `final_urls`, or `mobile_final_urls`. * * Generated from protobuf field repeated .google.ads.googleads.v23.common.CustomParameter url_custom_parameters = 12; * * @return RepeatedField<\Google\Ads\GoogleAds\V23\Common\CustomParameter> */ public function getUrlCustomParameters() { return $this->url_custom_parameters; } /** * The list of mappings used to substitute custom parameter tags in a * `tracking_url_template`, `final_urls`, or `mobile_final_urls`. * * Generated from protobuf field repeated .google.ads.googleads.v23.common.CustomParameter url_custom_parameters = 12; * * @param \Google\Ads\GoogleAds\V23\Common\CustomParameter[] $var * @return $this */ public function setUrlCustomParameters($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V23\Common\CustomParameter::class); $this->url_custom_parameters = $arr; return $this; } /** * The Local Services Campaign related settings. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\LocalServicesCampaignSettings|null */ public function getLocalServicesCampaignSettings() { return $this->local_services_campaign_settings; } public function hasLocalServicesCampaignSettings() { return isset($this->local_services_campaign_settings); } public function clearLocalServicesCampaignSettings() { unset($this->local_services_campaign_settings); } /** * The Local Services Campaign related settings. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.LocalServicesCampaignSettings local_services_campaign_settings = 75; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\LocalServicesCampaignSettings $var * @return $this */ public function setLocalServicesCampaignSettings($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\LocalServicesCampaignSettings::class); $this->local_services_campaign_settings = $var; return $this; } /** * Settings for Travel campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\TravelCampaignSettings|null */ public function getTravelCampaignSettings() { return $this->travel_campaign_settings; } public function hasTravelCampaignSettings() { return isset($this->travel_campaign_settings); } public function clearTravelCampaignSettings() { unset($this->travel_campaign_settings); } /** * Settings for Travel campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TravelCampaignSettings travel_campaign_settings = 85; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\TravelCampaignSettings $var * @return $this */ public function setTravelCampaignSettings($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\TravelCampaignSettings::class); $this->travel_campaign_settings = $var; return $this; } /** * Settings for Demand Gen campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\DemandGenCampaignSettings|null */ public function getDemandGenCampaignSettings() { return $this->demand_gen_campaign_settings; } public function hasDemandGenCampaignSettings() { return isset($this->demand_gen_campaign_settings); } public function clearDemandGenCampaignSettings() { unset($this->demand_gen_campaign_settings); } /** * Settings for Demand Gen campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.DemandGenCampaignSettings demand_gen_campaign_settings = 91; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\DemandGenCampaignSettings $var * @return $this */ public function setDemandGenCampaignSettings($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\DemandGenCampaignSettings::class); $this->demand_gen_campaign_settings = $var; return $this; } /** * Settings for Video campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\VideoCampaignSettings|null */ public function getVideoCampaignSettings() { return $this->video_campaign_settings; } public function hasVideoCampaignSettings() { return isset($this->video_campaign_settings); } public function clearVideoCampaignSettings() { unset($this->video_campaign_settings); } /** * Settings for Video campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.VideoCampaignSettings video_campaign_settings = 94; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\VideoCampaignSettings $var * @return $this */ public function setVideoCampaignSettings($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\VideoCampaignSettings::class); $this->video_campaign_settings = $var; return $this; } /** * Settings for Performance Max campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.PmaxCampaignSettings pmax_campaign_settings = 97; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\PmaxCampaignSettings|null */ public function getPmaxCampaignSettings() { return $this->pmax_campaign_settings; } public function hasPmaxCampaignSettings() { return isset($this->pmax_campaign_settings); } public function clearPmaxCampaignSettings() { unset($this->pmax_campaign_settings); } /** * Settings for Performance Max campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.PmaxCampaignSettings pmax_campaign_settings = 97; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\PmaxCampaignSettings $var * @return $this */ public function setPmaxCampaignSettings($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\PmaxCampaignSettings::class); $this->pmax_campaign_settings = $var; return $this; } /** * Settings for Real-Time Bidding, a feature only available for campaigns * targeting the Ad Exchange network. * * Generated from protobuf field .google.ads.googleads.v23.common.RealTimeBiddingSetting real_time_bidding_setting = 39; * * @return \Google\Ads\GoogleAds\V23\Common\RealTimeBiddingSetting|null */ public function getRealTimeBiddingSetting() { return $this->real_time_bidding_setting; } public function hasRealTimeBiddingSetting() { return isset($this->real_time_bidding_setting); } public function clearRealTimeBiddingSetting() { unset($this->real_time_bidding_setting); } /** * Settings for Real-Time Bidding, a feature only available for campaigns * targeting the Ad Exchange network. * * Generated from protobuf field .google.ads.googleads.v23.common.RealTimeBiddingSetting real_time_bidding_setting = 39; * * @param \Google\Ads\GoogleAds\V23\Common\RealTimeBiddingSetting $var * @return $this */ public function setRealTimeBiddingSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\RealTimeBiddingSetting::class); $this->real_time_bidding_setting = $var; return $this; } /** * The network settings for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.NetworkSettings network_settings = 14; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\NetworkSettings|null */ public function getNetworkSettings() { return $this->network_settings; } public function hasNetworkSettings() { return isset($this->network_settings); } public function clearNetworkSettings() { unset($this->network_settings); } /** * The network settings for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.NetworkSettings network_settings = 14; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\NetworkSettings $var * @return $this */ public function setNetworkSettings($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\NetworkSettings::class); $this->network_settings = $var; return $this; } /** * The hotel setting for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.HotelSettingInfo hotel_setting = 32; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\HotelSettingInfo|null */ public function getHotelSetting() { return $this->hotel_setting; } public function hasHotelSetting() { return isset($this->hotel_setting); } public function clearHotelSetting() { unset($this->hotel_setting); } /** * The hotel setting for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.HotelSettingInfo hotel_setting = 32; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\HotelSettingInfo $var * @return $this */ public function setHotelSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\HotelSettingInfo::class); $this->hotel_setting = $var; return $this; } /** * The setting for controlling Dynamic Search Ads (DSA). * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\DynamicSearchAdsSetting|null */ public function getDynamicSearchAdsSetting() { return $this->dynamic_search_ads_setting; } public function hasDynamicSearchAdsSetting() { return isset($this->dynamic_search_ads_setting); } public function clearDynamicSearchAdsSetting() { unset($this->dynamic_search_ads_setting); } /** * The setting for controlling Dynamic Search Ads (DSA). * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.DynamicSearchAdsSetting dynamic_search_ads_setting = 33; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\DynamicSearchAdsSetting $var * @return $this */ public function setDynamicSearchAdsSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\DynamicSearchAdsSetting::class); $this->dynamic_search_ads_setting = $var; return $this; } /** * The setting for controlling Shopping campaigns. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.ShoppingSetting shopping_setting = 36; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\ShoppingSetting|null */ public function getShoppingSetting() { return $this->shopping_setting; } public function hasShoppingSetting() { return isset($this->shopping_setting); } public function clearShoppingSetting() { unset($this->shopping_setting); } /** * The setting for controlling Shopping campaigns. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.ShoppingSetting shopping_setting = 36; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\ShoppingSetting $var * @return $this */ public function setShoppingSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\ShoppingSetting::class); $this->shopping_setting = $var; return $this; } /** * Setting for targeting related features. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetingSetting targeting_setting = 43; * * @return \Google\Ads\GoogleAds\V23\Common\TargetingSetting|null */ public function getTargetingSetting() { return $this->targeting_setting; } public function hasTargetingSetting() { return isset($this->targeting_setting); } public function clearTargetingSetting() { unset($this->targeting_setting); } /** * Setting for targeting related features. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetingSetting targeting_setting = 43; * * @param \Google\Ads\GoogleAds\V23\Common\TargetingSetting $var * @return $this */ public function setTargetingSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\TargetingSetting::class); $this->targeting_setting = $var; return $this; } /** * Immutable. Setting for audience related features. * * Generated from protobuf field optional .google.ads.googleads.v23.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE]; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\AudienceSetting|null */ public function getAudienceSetting() { return $this->audience_setting; } public function hasAudienceSetting() { return isset($this->audience_setting); } public function clearAudienceSetting() { unset($this->audience_setting); } /** * Immutable. Setting for audience related features. * * Generated from protobuf field optional .google.ads.googleads.v23.resources.Campaign.AudienceSetting audience_setting = 73 [(.google.api.field_behavior) = IMMUTABLE]; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\AudienceSetting $var * @return $this */ public function setAudienceSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\AudienceSetting::class); $this->audience_setting = $var; return $this; } /** * The setting for ads geotargeting. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\GeoTargetTypeSetting|null */ public function getGeoTargetTypeSetting() { return $this->geo_target_type_setting; } public function hasGeoTargetTypeSetting() { return isset($this->geo_target_type_setting); } public function clearGeoTargetTypeSetting() { unset($this->geo_target_type_setting); } /** * The setting for ads geotargeting. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.GeoTargetTypeSetting geo_target_type_setting = 47; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\GeoTargetTypeSetting $var * @return $this */ public function setGeoTargetTypeSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\GeoTargetTypeSetting::class); $this->geo_target_type_setting = $var; return $this; } /** * The setting for local campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\LocalCampaignSetting|null */ public function getLocalCampaignSetting() { return $this->local_campaign_setting; } public function hasLocalCampaignSetting() { return isset($this->local_campaign_setting); } public function clearLocalCampaignSetting() { unset($this->local_campaign_setting); } /** * The setting for local campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.LocalCampaignSetting local_campaign_setting = 50; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\LocalCampaignSetting $var * @return $this */ public function setLocalCampaignSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\LocalCampaignSetting::class); $this->local_campaign_setting = $var; return $this; } /** * The setting related to App Campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.AppCampaignSetting app_campaign_setting = 51; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\AppCampaignSetting|null */ public function getAppCampaignSetting() { return $this->app_campaign_setting; } public function hasAppCampaignSetting() { return isset($this->app_campaign_setting); } public function clearAppCampaignSetting() { unset($this->app_campaign_setting); } /** * The setting related to App Campaign. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.AppCampaignSetting app_campaign_setting = 51; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\AppCampaignSetting $var * @return $this */ public function setAppCampaignSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\AppCampaignSetting::class); $this->app_campaign_setting = $var; return $this; } /** * Output only. The resource names of labels attached to this campaign. * * Generated from protobuf field repeated string labels = 61 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * * @return RepeatedField */ public function getLabels() { return $this->labels; } /** * Output only. The resource names of labels attached to this campaign. * * Generated from protobuf field repeated string labels = 61 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * * @param string[] $var * @return $this */ public function setLabels($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING); $this->labels = $arr; return $this; } /** * Output only. The type of campaign: normal, draft, or experiment. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return int */ public function getExperimentType() { return $this->experiment_type; } /** * Output only. The type of campaign: normal, draft, or experiment. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignExperimentTypeEnum.CampaignExperimentType experiment_type = 17 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param int $var * @return $this */ public function setExperimentType($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\CampaignExperimentTypeEnum\CampaignExperimentType::class); $this->experiment_type = $var; return $this; } /** * 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. * * Generated from protobuf field optional string base_campaign = 56 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * * @return string */ public function getBaseCampaign() { return isset($this->base_campaign) ? $this->base_campaign : ''; } public function hasBaseCampaign() { return isset($this->base_campaign); } public function clearBaseCampaign() { unset($this->base_campaign); } /** * 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. * * Generated from protobuf field optional string base_campaign = 56 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * * @param string $var * @return $this */ public function setBaseCampaign($var) { GPBUtil::checkString($var, true); $this->base_campaign = $var; return $this; } /** * The resource name of the campaign budget of the campaign. * * Generated from protobuf field optional string campaign_budget = 62 [(.google.api.resource_reference) = { * * @return string */ public function getCampaignBudget() { return isset($this->campaign_budget) ? $this->campaign_budget : ''; } public function hasCampaignBudget() { return isset($this->campaign_budget); } public function clearCampaignBudget() { unset($this->campaign_budget); } /** * The resource name of the campaign budget of the campaign. * * Generated from protobuf field optional string campaign_budget = 62 [(.google.api.resource_reference) = { * * @param string $var * @return $this */ public function setCampaignBudget($var) { GPBUtil::checkString($var, true); $this->campaign_budget = $var; return $this; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return int */ public function getBiddingStrategyType() { return $this->bidding_strategy_type; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.BiddingStrategyTypeEnum.BiddingStrategyType bidding_strategy_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param int $var * @return $this */ public function setBiddingStrategyType($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\BiddingStrategyTypeEnum\BiddingStrategyType::class); $this->bidding_strategy_type = $var; return $this; } /** * 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. * * Generated from protobuf field string accessible_bidding_strategy = 71 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * * @return string */ public function getAccessibleBiddingStrategy() { return $this->accessible_bidding_strategy; } /** * 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. * * Generated from protobuf field string accessible_bidding_strategy = 71 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { * * @param string $var * @return $this */ public function setAccessibleBiddingStrategy($var) { GPBUtil::checkString($var, true); $this->accessible_bidding_strategy = $var; return $this; } /** * The resource name of the campaign group that this campaign belongs to. * * Generated from protobuf field optional string campaign_group = 76 [(.google.api.resource_reference) = { * * @return string */ public function getCampaignGroup() { return isset($this->campaign_group) ? $this->campaign_group : ''; } public function hasCampaignGroup() { return isset($this->campaign_group); } public function clearCampaignGroup() { unset($this->campaign_group); } /** * The resource name of the campaign group that this campaign belongs to. * * Generated from protobuf field optional string campaign_group = 76 [(.google.api.resource_reference) = { * * @param string $var * @return $this */ public function setCampaignGroup($var) { GPBUtil::checkString($var, true); $this->campaign_group = $var; return $this; } /** * The date and time when campaign started in serving. The timestamp is in * the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time * component to 00:00:00 for daily granularity, time granularity is only * supported for some campaign types. * * Generated from protobuf field optional string start_date_time = 104; * * @return string */ public function getStartDateTime() { return isset($this->start_date_time) ? $this->start_date_time : ''; } public function hasStartDateTime() { return isset($this->start_date_time); } public function clearStartDateTime() { unset($this->start_date_time); } /** * The date and time when campaign started in serving. The timestamp is in * the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Set the time * component to 00:00:00 for daily granularity, time granularity is only * supported for some campaign types. * * Generated from protobuf field optional string start_date_time = 104; * * @param string $var * @return $this */ public function setStartDateTime($var) { GPBUtil::checkString($var, true); $this->start_date_time = $var; return $this; } /** * The last day and time of the campaign in serving customer's timezone in * "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily * granularity, time granularity is only supported for some campaign types. On * create, defaults to running indefinitely. To set an existing campaign to * run indefinitely, clear this field. * * Generated from protobuf field optional string end_date_time = 105; * * @return string */ public function getEndDateTime() { return isset($this->end_date_time) ? $this->end_date_time : ''; } public function hasEndDateTime() { return isset($this->end_date_time); } public function clearEndDateTime() { unset($this->end_date_time); } /** * The last day and time of the campaign in serving customer's timezone in * "yyyy-MM-dd HH:mm:ss" format. Set the time component to 23:59:59 for daily * granularity, time granularity is only supported for some campaign types. On * create, defaults to running indefinitely. To set an existing campaign to * run indefinitely, clear this field. * * Generated from protobuf field optional string end_date_time = 105; * * @param string $var * @return $this */ public function setEndDateTime($var) { GPBUtil::checkString($var, true); $this->end_date_time = $var; return $this; } /** * Suffix used to append query parameters to landing pages that are served * with parallel tracking. * * Generated from protobuf field optional string final_url_suffix = 65; * * @return string */ public function getFinalUrlSuffix() { return isset($this->final_url_suffix) ? $this->final_url_suffix : ''; } public function hasFinalUrlSuffix() { return isset($this->final_url_suffix); } public function clearFinalUrlSuffix() { unset($this->final_url_suffix); } /** * Suffix used to append query parameters to landing pages that are served * with parallel tracking. * * Generated from protobuf field optional string final_url_suffix = 65; * * @param string $var * @return $this */ public function setFinalUrlSuffix($var) { GPBUtil::checkString($var, true); $this->final_url_suffix = $var; return $this; } /** * A list that limits how often each user will see this campaign's ads. * * Generated from protobuf field repeated .google.ads.googleads.v23.common.FrequencyCapEntry frequency_caps = 40; * * @return RepeatedField<\Google\Ads\GoogleAds\V23\Common\FrequencyCapEntry> */ public function getFrequencyCaps() { return $this->frequency_caps; } /** * A list that limits how often each user will see this campaign's ads. * * Generated from protobuf field repeated .google.ads.googleads.v23.common.FrequencyCapEntry frequency_caps = 40; * * @param \Google\Ads\GoogleAds\V23\Common\FrequencyCapEntry[] $var * @return $this */ public function setFrequencyCaps($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V23\Common\FrequencyCapEntry::class); $this->frequency_caps = $arr; return $this; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42; * * @return int */ public function getVideoBrandSafetySuitability() { return $this->video_brand_safety_suitability; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.enums.BrandSafetySuitabilityEnum.BrandSafetySuitability video_brand_safety_suitability = 42; * * @param int $var * @return $this */ public function setVideoBrandSafetySuitability($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\BrandSafetySuitabilityEnum\BrandSafetySuitability::class); $this->video_brand_safety_suitability = $var; return $this; } /** * Describes how unbranded pharma ads will be displayed. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.VanityPharma vanity_pharma = 44; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\VanityPharma|null */ public function getVanityPharma() { return $this->vanity_pharma; } public function hasVanityPharma() { return isset($this->vanity_pharma); } public function clearVanityPharma() { unset($this->vanity_pharma); } /** * Describes how unbranded pharma ads will be displayed. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.VanityPharma vanity_pharma = 44; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\VanityPharma $var * @return $this */ public function setVanityPharma($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\VanityPharma::class); $this->vanity_pharma = $var; return $this; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.SelectiveOptimization selective_optimization = 45; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\SelectiveOptimization|null */ public function getSelectiveOptimization() { return $this->selective_optimization; } public function hasSelectiveOptimization() { return isset($this->selective_optimization); } public function clearSelectiveOptimization() { unset($this->selective_optimization); } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.SelectiveOptimization selective_optimization = 45; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\SelectiveOptimization $var * @return $this */ public function setSelectiveOptimization($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\SelectiveOptimization::class); $this->selective_optimization = $var; return $this; } /** * Optimization goal setting for this campaign, which includes a set of * optimization goal types. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\OptimizationGoalSetting|null */ public function getOptimizationGoalSetting() { return $this->optimization_goal_setting; } public function hasOptimizationGoalSetting() { return isset($this->optimization_goal_setting); } public function clearOptimizationGoalSetting() { unset($this->optimization_goal_setting); } /** * Optimization goal setting for this campaign, which includes a set of * optimization goal types. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.OptimizationGoalSetting optimization_goal_setting = 54; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\OptimizationGoalSetting $var * @return $this */ public function setOptimizationGoalSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\OptimizationGoalSetting::class); $this->optimization_goal_setting = $var; return $this; } /** * Output only. Campaign-level settings for tracking information. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\TrackingSetting|null */ public function getTrackingSetting() { return $this->tracking_setting; } public function hasTrackingSetting() { return isset($this->tracking_setting); } public function clearTrackingSetting() { unset($this->tracking_setting); } /** * Output only. Campaign-level settings for tracking information. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TrackingSetting tracking_setting = 46 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\TrackingSetting $var * @return $this */ public function setTrackingSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\TrackingSetting::class); $this->tracking_setting = $var; return $this; } /** * Payment mode for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.PaymentModeEnum.PaymentMode payment_mode = 52; * * @return int */ public function getPaymentMode() { return $this->payment_mode; } /** * Payment mode for the campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.PaymentModeEnum.PaymentMode payment_mode = 52; * * @param int $var * @return $this */ public function setPaymentMode($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\PaymentModeEnum\PaymentMode::class); $this->payment_mode = $var; return $this; } /** * 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. * * Generated from protobuf field optional double optimization_score = 66 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return float */ public function getOptimizationScore() { return isset($this->optimization_score) ? $this->optimization_score : 0.0; } public function hasOptimizationScore() { return isset($this->optimization_score); } public function clearOptimizationScore() { unset($this->optimization_score); } /** * 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. * * Generated from protobuf field optional double optimization_score = 66 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param float $var * @return $this */ public function setOptimizationScore($var) { GPBUtil::checkDouble($var); $this->optimization_score = $var; return $this; } /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69; * * @return RepeatedField */ public function getExcludedParentAssetFieldTypes() { return $this->excluded_parent_asset_field_types; } /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetFieldTypeEnum.AssetFieldType excluded_parent_asset_field_types = 69; * * @param int[] $var * @return $this */ public function setExcludedParentAssetFieldTypes($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\GoogleAds\V23\Enums\AssetFieldTypeEnum\AssetFieldType::class); $this->excluded_parent_asset_field_types = $arr; return $this; } /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80; * * @return RepeatedField */ public function getExcludedParentAssetSetTypes() { return $this->excluded_parent_asset_set_types; } /** * 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. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetSetTypeEnum.AssetSetType excluded_parent_asset_set_types = 80; * * @param int[] $var * @return $this */ public function setExcludedParentAssetSetTypes($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\GoogleAds\V23\Enums\AssetSetTypeEnum\AssetSetType::class); $this->excluded_parent_asset_set_types = $arr; return $this; } /** * Output only. Information about campaigns being upgraded to Performance Max. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\PerformanceMaxUpgrade|null */ public function getPerformanceMaxUpgrade() { return $this->performance_max_upgrade; } public function hasPerformanceMaxUpgrade() { return isset($this->performance_max_upgrade); } public function clearPerformanceMaxUpgrade() { unset($this->performance_max_upgrade); } /** * Output only. Information about campaigns being upgraded to Performance Max. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.PerformanceMaxUpgrade performance_max_upgrade = 77 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\PerformanceMaxUpgrade $var * @return $this */ public function setPerformanceMaxUpgrade($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\PerformanceMaxUpgrade::class); $this->performance_max_upgrade = $var; return $this; } /** * Immutable. The resource name for a set of hotel properties for Performance * Max for travel goals campaigns. * * Generated from protobuf field optional string hotel_property_asset_set = 83 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { * * @return string */ public function getHotelPropertyAssetSet() { return isset($this->hotel_property_asset_set) ? $this->hotel_property_asset_set : ''; } public function hasHotelPropertyAssetSet() { return isset($this->hotel_property_asset_set); } public function clearHotelPropertyAssetSet() { unset($this->hotel_property_asset_set); } /** * Immutable. The resource name for a set of hotel properties for Performance * Max for travel goals campaigns. * * Generated from protobuf field optional string hotel_property_asset_set = 83 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { * * @param string $var * @return $this */ public function setHotelPropertyAssetSet($var) { GPBUtil::checkString($var, true); $this->hotel_property_asset_set = $var; return $this; } /** * Immutable. Listing type of ads served for this campaign. * Field is restricted for usage with Performance Max campaigns. * * Generated from protobuf field optional .google.ads.googleads.v23.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE]; * * @return int */ public function getListingType() { return isset($this->listing_type) ? $this->listing_type : 0; } public function hasListingType() { return isset($this->listing_type); } public function clearListingType() { unset($this->listing_type); } /** * Immutable. Listing type of ads served for this campaign. * Field is restricted for usage with Performance Max campaigns. * * Generated from protobuf field optional .google.ads.googleads.v23.enums.ListingTypeEnum.ListingType listing_type = 86 [(.google.api.field_behavior) = IMMUTABLE]; * * @param int $var * @return $this */ public function setListingType($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\ListingTypeEnum\ListingType::class); $this->listing_type = $var; return $this; } /** * Contains the opt-in/out status of each AssetAutomationType. * See documentation of each asset automation type enum for default * opt in/out behavior. * * Generated from protobuf field repeated .google.ads.googleads.v23.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88; * * @return RepeatedField<\Google\Ads\GoogleAds\V23\Resources\Campaign\AssetAutomationSetting> */ public function getAssetAutomationSettings() { return $this->asset_automation_settings; } /** * Contains the opt-in/out status of each AssetAutomationType. * See documentation of each asset automation type enum for default * opt in/out behavior. * * Generated from protobuf field repeated .google.ads.googleads.v23.resources.Campaign.AssetAutomationSetting asset_automation_settings = 88; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\AssetAutomationSetting[] $var * @return $this */ public function setAssetAutomationSettings($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Ads\GoogleAds\V23\Resources\Campaign\AssetAutomationSetting::class); $this->asset_automation_settings = $arr; return $this; } /** * Keyword match type of Campaign. Set to BROAD to set broad matching for all * keywords in a campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType keyword_match_type = 90; * * @return int */ public function getKeywordMatchType() { return $this->keyword_match_type; } /** * Keyword match type of Campaign. Set to BROAD to set broad matching for all * keywords in a campaign. * * Generated from protobuf field .google.ads.googleads.v23.enums.CampaignKeywordMatchTypeEnum.CampaignKeywordMatchType keyword_match_type = 90; * * @param int $var * @return $this */ public function setKeywordMatchType($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\CampaignKeywordMatchTypeEnum\CampaignKeywordMatchType::class); $this->keyword_match_type = $var; return $this; } /** * Immutable. 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. * Writable only at campaign creation. Set to true to enable Brand * Guidelines when creating a new Performance Max campaign. * Immutable after creation. This field cannot be modified using standard * update operations after the campaign has been created. * For existing campaigns: To enable Brand Guidelines on a campaign after it * has been created, use the CampaignService.EnablePMaxBrandGuidelines method, * which is a separate operation. It is not possible to disable Brand * Guidelines for an existing campaign. * Incompatible with Travel Goals: This feature is not supported for * Performance Max campaigns with Travel Goals. Attempting to set this field * to true for a Travel Goals campaign will result in an error. * * Generated from protobuf field optional bool brand_guidelines_enabled = 96 [(.google.api.field_behavior) = IMMUTABLE]; * * @return bool */ public function getBrandGuidelinesEnabled() { return isset($this->brand_guidelines_enabled) ? $this->brand_guidelines_enabled : false; } public function hasBrandGuidelinesEnabled() { return isset($this->brand_guidelines_enabled); } public function clearBrandGuidelinesEnabled() { unset($this->brand_guidelines_enabled); } /** * Immutable. 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. * Writable only at campaign creation. Set to true to enable Brand * Guidelines when creating a new Performance Max campaign. * Immutable after creation. This field cannot be modified using standard * update operations after the campaign has been created. * For existing campaigns: To enable Brand Guidelines on a campaign after it * has been created, use the CampaignService.EnablePMaxBrandGuidelines method, * which is a separate operation. It is not possible to disable Brand * Guidelines for an existing campaign. * Incompatible with Travel Goals: This feature is not supported for * Performance Max campaigns with Travel Goals. Attempting to set this field * to true for a Travel Goals campaign will result in an error. * * Generated from protobuf field optional bool brand_guidelines_enabled = 96 [(.google.api.field_behavior) = IMMUTABLE]; * * @param bool $var * @return $this */ public function setBrandGuidelinesEnabled($var) { GPBUtil::checkBool($var); $this->brand_guidelines_enabled = $var; return $this; } /** * These settings control how your brand appears in automatically generated * assets and formats within this campaign. Note: These settings can only be * used for Performance Max campaigns that have Brand Guidelines enabled. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.BrandGuidelines brand_guidelines = 98; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\BrandGuidelines|null */ public function getBrandGuidelines() { return $this->brand_guidelines; } public function hasBrandGuidelines() { return isset($this->brand_guidelines); } public function clearBrandGuidelines() { unset($this->brand_guidelines); } /** * These settings control how your brand appears in automatically generated * assets and formats within this campaign. Note: These settings can only be * used for Performance Max campaigns that have Brand Guidelines enabled. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.BrandGuidelines brand_guidelines = 98; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\BrandGuidelines $var * @return $this */ public function setBrandGuidelines($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\BrandGuidelines::class); $this->brand_guidelines = $var; return $this; } /** * Settings to control automatically generated text assets. Only available * in Performance Max and Search campaigns (Brand Guidelines does not need * to be enabled). * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TextGuidelines text_guidelines = 107; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\TextGuidelines|null */ public function getTextGuidelines() { return $this->text_guidelines; } public function hasTextGuidelines() { return isset($this->text_guidelines); } public function clearTextGuidelines() { unset($this->text_guidelines); } /** * Settings to control automatically generated text assets. Only available * in Performance Max and Search campaigns (Brand Guidelines does not need * to be enabled). * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.TextGuidelines text_guidelines = 107; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\TextGuidelines $var * @return $this */ public function setTextGuidelines($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\TextGuidelines::class); $this->text_guidelines = $var; return $this; } /** * Third-Party integration partners. * * Generated from protobuf field .google.ads.googleads.v23.common.CampaignThirdPartyIntegrationPartners third_party_integration_partners = 100; * * @return \Google\Ads\GoogleAds\V23\Common\CampaignThirdPartyIntegrationPartners|null */ public function getThirdPartyIntegrationPartners() { return $this->third_party_integration_partners; } public function hasThirdPartyIntegrationPartners() { return isset($this->third_party_integration_partners); } public function clearThirdPartyIntegrationPartners() { unset($this->third_party_integration_partners); } /** * Third-Party integration partners. * * Generated from protobuf field .google.ads.googleads.v23.common.CampaignThirdPartyIntegrationPartners third_party_integration_partners = 100; * * @param \Google\Ads\GoogleAds\V23\Common\CampaignThirdPartyIntegrationPartners $var * @return $this */ public function setThirdPartyIntegrationPartners($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\CampaignThirdPartyIntegrationPartners::class); $this->third_party_integration_partners = $var; return $this; } /** * Settings for AI Max in search campaigns. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.AiMaxSetting ai_max_setting = 101; * * @return \Google\Ads\GoogleAds\V23\Resources\Campaign\AiMaxSetting|null */ public function getAiMaxSetting() { return $this->ai_max_setting; } public function hasAiMaxSetting() { return isset($this->ai_max_setting); } public function clearAiMaxSetting() { unset($this->ai_max_setting); } /** * Settings for AI Max in search campaigns. * * Generated from protobuf field .google.ads.googleads.v23.resources.Campaign.AiMaxSetting ai_max_setting = 101; * * @param \Google\Ads\GoogleAds\V23\Resources\Campaign\AiMaxSetting $var * @return $this */ public function setAiMaxSetting($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Resources\Campaign\AiMaxSetting::class); $this->ai_max_setting = $var; return $this; } /** * The advertiser should self-declare whether this campaign contains * political advertising content targeted towards the European Union. * * Generated from protobuf field .google.ads.googleads.v23.enums.EuPoliticalAdvertisingStatusEnum.EuPoliticalAdvertisingStatus contains_eu_political_advertising = 102; * * @return int */ public function getContainsEuPoliticalAdvertising() { return $this->contains_eu_political_advertising; } /** * The advertiser should self-declare whether this campaign contains * political advertising content targeted towards the European Union. * * Generated from protobuf field .google.ads.googleads.v23.enums.EuPoliticalAdvertisingStatusEnum.EuPoliticalAdvertisingStatus contains_eu_political_advertising = 102; * * @param int $var * @return $this */ public function setContainsEuPoliticalAdvertising($var) { GPBUtil::checkEnum($var, \Google\Ads\GoogleAds\V23\Enums\EuPoliticalAdvertisingStatusEnum\EuPoliticalAdvertisingStatus::class); $this->contains_eu_political_advertising = $var; return $this; } /** * Output only. Types of feeds that are attached directly to this campaign. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetSetTypeEnum.AssetSetType feed_types = 103 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return RepeatedField */ public function getFeedTypes() { return $this->feed_types; } /** * Output only. Types of feeds that are attached directly to this campaign. * * Generated from protobuf field repeated .google.ads.googleads.v23.enums.AssetSetTypeEnum.AssetSetType feed_types = 103 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param int[] $var * @return $this */ public function setFeedTypes($var) { $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::ENUM, \Google\Ads\GoogleAds\V23\Enums\AssetSetTypeEnum\AssetSetType::class); $this->feed_types = $arr; return $this; } /** * Output only. Indicates whether this campaign is missing a declaration about * whether it contains political advertising targeted towards the EU and is * ineligible for any exemptions. If this field is true, use the * contains_eu_political_advertising field to add the required declaration. * This field is read-only. * * Generated from protobuf field bool missing_eu_political_advertising_declaration = 108 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return bool */ public function getMissingEuPoliticalAdvertisingDeclaration() { return $this->missing_eu_political_advertising_declaration; } /** * Output only. Indicates whether this campaign is missing a declaration about * whether it contains political advertising targeted towards the EU and is * ineligible for any exemptions. If this field is true, use the * contains_eu_political_advertising field to add the required declaration. * This field is read-only. * * Generated from protobuf field bool missing_eu_political_advertising_declaration = 108 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @param bool $var * @return $this */ public function setMissingEuPoliticalAdvertisingDeclaration($var) { GPBUtil::checkBool($var); $this->missing_eu_political_advertising_declaration = $var; return $this; } /** * The resource name of the portfolio bidding strategy used by the campaign. * * Generated from protobuf field string bidding_strategy = 67 [(.google.api.resource_reference) = { * * @return string */ public function getBiddingStrategy() { return $this->readOneof(67); } public function hasBiddingStrategy() { return $this->hasOneof(67); } /** * The resource name of the portfolio bidding strategy used by the campaign. * * Generated from protobuf field string bidding_strategy = 67 [(.google.api.resource_reference) = { * * @param string $var * @return $this */ public function setBiddingStrategy($var) { GPBUtil::checkString($var, true); $this->writeOneof(67, $var); return $this; } /** * Commission is an automatic bidding strategy in which the advertiser pays * a certain portion of the conversion value. * * Generated from protobuf field .google.ads.googleads.v23.common.Commission commission = 49; * * @return \Google\Ads\GoogleAds\V23\Common\Commission|null */ public function getCommission() { return $this->readOneof(49); } public function hasCommission() { return $this->hasOneof(49); } /** * Commission is an automatic bidding strategy in which the advertiser pays * a certain portion of the conversion value. * * Generated from protobuf field .google.ads.googleads.v23.common.Commission commission = 49; * * @param \Google\Ads\GoogleAds\V23\Common\Commission $var * @return $this */ public function setCommission($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\Commission::class); $this->writeOneof(49, $var); return $this; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.common.ManualCpa manual_cpa = 74; * * @return \Google\Ads\GoogleAds\V23\Common\ManualCpa|null */ public function getManualCpa() { return $this->readOneof(74); } public function hasManualCpa() { return $this->hasOneof(74); } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.common.ManualCpa manual_cpa = 74; * * @param \Google\Ads\GoogleAds\V23\Common\ManualCpa $var * @return $this */ public function setManualCpa($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\ManualCpa::class); $this->writeOneof(74, $var); return $this; } /** * Standard Manual CPC bidding strategy. * Manual click-based bidding where user pays per click. * * Generated from protobuf field .google.ads.googleads.v23.common.ManualCpc manual_cpc = 24; * * @return \Google\Ads\GoogleAds\V23\Common\ManualCpc|null */ public function getManualCpc() { return $this->readOneof(24); } public function hasManualCpc() { return $this->hasOneof(24); } /** * Standard Manual CPC bidding strategy. * Manual click-based bidding where user pays per click. * * Generated from protobuf field .google.ads.googleads.v23.common.ManualCpc manual_cpc = 24; * * @param \Google\Ads\GoogleAds\V23\Common\ManualCpc $var * @return $this */ public function setManualCpc($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\ManualCpc::class); $this->writeOneof(24, $var); return $this; } /** * Standard Manual CPM bidding strategy. * Manual impression-based bidding where user pays per thousand * impressions. * * Generated from protobuf field .google.ads.googleads.v23.common.ManualCpm manual_cpm = 25; * * @return \Google\Ads\GoogleAds\V23\Common\ManualCpm|null */ public function getManualCpm() { return $this->readOneof(25); } public function hasManualCpm() { return $this->hasOneof(25); } /** * Standard Manual CPM bidding strategy. * Manual impression-based bidding where user pays per thousand * impressions. * * Generated from protobuf field .google.ads.googleads.v23.common.ManualCpm manual_cpm = 25; * * @param \Google\Ads\GoogleAds\V23\Common\ManualCpm $var * @return $this */ public function setManualCpm($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\ManualCpm::class); $this->writeOneof(25, $var); return $this; } /** * A bidding strategy that pays a configurable amount per video view. * * Generated from protobuf field .google.ads.googleads.v23.common.ManualCpv manual_cpv = 37; * * @return \Google\Ads\GoogleAds\V23\Common\ManualCpv|null */ public function getManualCpv() { return $this->readOneof(37); } public function hasManualCpv() { return $this->hasOneof(37); } /** * A bidding strategy that pays a configurable amount per video view. * * Generated from protobuf field .google.ads.googleads.v23.common.ManualCpv manual_cpv = 37; * * @param \Google\Ads\GoogleAds\V23\Common\ManualCpv $var * @return $this */ public function setManualCpv($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\ManualCpv::class); $this->writeOneof(37, $var); return $this; } /** * Standard Maximize Conversions bidding strategy that automatically * maximizes number of conversions while spending your budget. * * Generated from protobuf field .google.ads.googleads.v23.common.MaximizeConversions maximize_conversions = 30; * * @return \Google\Ads\GoogleAds\V23\Common\MaximizeConversions|null */ public function getMaximizeConversions() { return $this->readOneof(30); } public function hasMaximizeConversions() { return $this->hasOneof(30); } /** * Standard Maximize Conversions bidding strategy that automatically * maximizes number of conversions while spending your budget. * * Generated from protobuf field .google.ads.googleads.v23.common.MaximizeConversions maximize_conversions = 30; * * @param \Google\Ads\GoogleAds\V23\Common\MaximizeConversions $var * @return $this */ public function setMaximizeConversions($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\MaximizeConversions::class); $this->writeOneof(30, $var); return $this; } /** * Standard Maximize Conversion Value bidding strategy that automatically * sets bids to maximize revenue while spending your budget. * * Generated from protobuf field .google.ads.googleads.v23.common.MaximizeConversionValue maximize_conversion_value = 31; * * @return \Google\Ads\GoogleAds\V23\Common\MaximizeConversionValue|null */ public function getMaximizeConversionValue() { return $this->readOneof(31); } public function hasMaximizeConversionValue() { return $this->hasOneof(31); } /** * Standard Maximize Conversion Value bidding strategy that automatically * sets bids to maximize revenue while spending your budget. * * Generated from protobuf field .google.ads.googleads.v23.common.MaximizeConversionValue maximize_conversion_value = 31; * * @param \Google\Ads\GoogleAds\V23\Common\MaximizeConversionValue $var * @return $this */ public function setMaximizeConversionValue($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\MaximizeConversionValue::class); $this->writeOneof(31, $var); return $this; } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetCpa target_cpa = 26; * * @return \Google\Ads\GoogleAds\V23\Common\TargetCpa|null */ public function getTargetCpa() { return $this->readOneof(26); } public function hasTargetCpa() { return $this->hasOneof(26); } /** * 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. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetCpa target_cpa = 26; * * @param \Google\Ads\GoogleAds\V23\Common\TargetCpa $var * @return $this */ public function setTargetCpa($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\TargetCpa::class); $this->writeOneof(26, $var); return $this; } /** * Target Impression Share bidding strategy. An automated bidding strategy * that sets bids to achieve a chosen percentage of impressions. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetImpressionShare target_impression_share = 48; * * @return \Google\Ads\GoogleAds\V23\Common\TargetImpressionShare|null */ public function getTargetImpressionShare() { return $this->readOneof(48); } public function hasTargetImpressionShare() { return $this->hasOneof(48); } /** * Target Impression Share bidding strategy. An automated bidding strategy * that sets bids to achieve a chosen percentage of impressions. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetImpressionShare target_impression_share = 48; * * @param \Google\Ads\GoogleAds\V23\Common\TargetImpressionShare $var * @return $this */ public function setTargetImpressionShare($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\TargetImpressionShare::class); $this->writeOneof(48, $var); return $this; } /** * Standard Target ROAS bidding strategy that automatically maximizes * revenue while averaging a specific target return on ad spend (ROAS). * * Generated from protobuf field .google.ads.googleads.v23.common.TargetRoas target_roas = 29; * * @return \Google\Ads\GoogleAds\V23\Common\TargetRoas|null */ public function getTargetRoas() { return $this->readOneof(29); } public function hasTargetRoas() { return $this->hasOneof(29); } /** * Standard Target ROAS bidding strategy that automatically maximizes * revenue while averaging a specific target return on ad spend (ROAS). * * Generated from protobuf field .google.ads.googleads.v23.common.TargetRoas target_roas = 29; * * @param \Google\Ads\GoogleAds\V23\Common\TargetRoas $var * @return $this */ public function setTargetRoas($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\TargetRoas::class); $this->writeOneof(29, $var); return $this; } /** * Standard Target Spend bidding strategy that automatically sets your bids * to help get as many clicks as possible within your budget. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetSpend target_spend = 27; * * @return \Google\Ads\GoogleAds\V23\Common\TargetSpend|null */ public function getTargetSpend() { return $this->readOneof(27); } public function hasTargetSpend() { return $this->hasOneof(27); } /** * Standard Target Spend bidding strategy that automatically sets your bids * to help get as many clicks as possible within your budget. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetSpend target_spend = 27; * * @param \Google\Ads\GoogleAds\V23\Common\TargetSpend $var * @return $this */ public function setTargetSpend($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\TargetSpend::class); $this->writeOneof(27, $var); return $this; } /** * Standard Percent Cpc bidding strategy where bids are a fraction of the * advertised price for some good or service. * * Generated from protobuf field .google.ads.googleads.v23.common.PercentCpc percent_cpc = 34; * * @return \Google\Ads\GoogleAds\V23\Common\PercentCpc|null */ public function getPercentCpc() { return $this->readOneof(34); } public function hasPercentCpc() { return $this->hasOneof(34); } /** * Standard Percent Cpc bidding strategy where bids are a fraction of the * advertised price for some good or service. * * Generated from protobuf field .google.ads.googleads.v23.common.PercentCpc percent_cpc = 34; * * @param \Google\Ads\GoogleAds\V23\Common\PercentCpc $var * @return $this */ public function setPercentCpc($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\PercentCpc::class); $this->writeOneof(34, $var); return $this; } /** * A bidding strategy that automatically optimizes cost per thousand * impressions. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetCpm target_cpm = 41; * * @return \Google\Ads\GoogleAds\V23\Common\TargetCpm|null */ public function getTargetCpm() { return $this->readOneof(41); } public function hasTargetCpm() { return $this->hasOneof(41); } /** * A bidding strategy that automatically optimizes cost per thousand * impressions. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetCpm target_cpm = 41; * * @param \Google\Ads\GoogleAds\V23\Common\TargetCpm $var * @return $this */ public function setTargetCpm($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\TargetCpm::class); $this->writeOneof(41, $var); return $this; } /** * A manual bidding strategy with a fixed CPM. * * Generated from protobuf field .google.ads.googleads.v23.common.FixedCpm fixed_cpm = 92; * * @return \Google\Ads\GoogleAds\V23\Common\FixedCpm|null */ public function getFixedCpm() { return $this->readOneof(92); } public function hasFixedCpm() { return $this->hasOneof(92); } /** * A manual bidding strategy with a fixed CPM. * * Generated from protobuf field .google.ads.googleads.v23.common.FixedCpm fixed_cpm = 92; * * @param \Google\Ads\GoogleAds\V23\Common\FixedCpm $var * @return $this */ public function setFixedCpm($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\FixedCpm::class); $this->writeOneof(92, $var); return $this; } /** * An automated bidding strategy that sets bids to optimize performance * given the target CPV you set. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetCpv target_cpv = 93; * * @return \Google\Ads\GoogleAds\V23\Common\TargetCpv|null */ public function getTargetCpv() { return $this->readOneof(93); } public function hasTargetCpv() { return $this->hasOneof(93); } /** * An automated bidding strategy that sets bids to optimize performance * given the target CPV you set. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetCpv target_cpv = 93; * * @param \Google\Ads\GoogleAds\V23\Common\TargetCpv $var * @return $this */ public function setTargetCpv($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\TargetCpv::class); $this->writeOneof(93, $var); return $this; } /** * An automated bidding strategy that sets bids to help get as many clicks * as possible at the target cost-per-click (CPC) you set. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetCpc target_cpc = 99; * * @return \Google\Ads\GoogleAds\V23\Common\TargetCpc|null */ public function getTargetCpc() { return $this->readOneof(99); } public function hasTargetCpc() { return $this->hasOneof(99); } /** * An automated bidding strategy that sets bids to help get as many clicks * as possible at the target cost-per-click (CPC) you set. * * Generated from protobuf field .google.ads.googleads.v23.common.TargetCpc target_cpc = 99; * * @param \Google\Ads\GoogleAds\V23\Common\TargetCpc $var * @return $this */ public function setTargetCpc($var) { GPBUtil::checkMessage($var, \Google\Ads\GoogleAds\V23\Common\TargetCpc::class); $this->writeOneof(99, $var); return $this; } /** * @return string */ public function getCampaignBiddingStrategy() { return $this->whichOneof("campaign_bidding_strategy"); } }