Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCampaign

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/searchads360_v0/classes.rb,
lib/google/apis/searchads360_v0/representations.rb,
lib/google/apis/searchads360_v0/representations.rb

Overview

A campaign.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ResourcesCampaign

Returns a new instance of GoogleAdsSearchads360V0ResourcesCampaign.



5773
5774
5775
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5773

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#accessible_bidding_strategy ⇒ String

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. Corresponds to the JSON property accessibleBiddingStrategy

Returns:

  • (String) 


5497
5498
5499
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5497

def accessible_bidding_strategy
  @accessible_bidding_strategy
end

#ad_serving_optimization_status ⇒ String

The ad serving optimization status of the campaign. Corresponds to the JSON property adServingOptimizationStatus

Returns:

  • (String) 


5502
5503
5504
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5502

def ad_serving_optimization_status
  @ad_serving_optimization_status
end

#advertising_channel_sub_type ⇒ String

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. Corresponds to the JSON property advertisingChannelSubType

Returns:

  • (String) 


5509
5510
5511
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5509

def advertising_channel_sub_type
  @advertising_channel_sub_type
end

#advertising_channel_type ⇒ String

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. Corresponds to the JSON property advertisingChannelType

Returns:

  • (String) 


5518
5519
5520
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5518

def advertising_channel_type
  @advertising_channel_type
end

#bidding_strategy ⇒ String

The resource name of the portfolio bidding strategy used by the campaign. Corresponds to the JSON property biddingStrategy

Returns:

  • (String) 


5523
5524
5525
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5523

def bidding_strategy
  @bidding_strategy
end

#bidding_strategy_system_status ⇒ String

Output only. The system status of the campaign's bidding strategy. Corresponds to the JSON property biddingStrategySystemStatus

Returns:

  • (String) 


5528
5529
5530
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5528

def bidding_strategy_system_status
  @bidding_strategy_system_status
end

#bidding_strategy_type ⇒ String

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. Corresponds to the JSON property biddingStrategyType

Returns:

  • (String) 


5536
5537
5538
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5536

def bidding_strategy_type
  @bidding_strategy_type
end

#campaign_budget ⇒ String

The resource name of the campaign budget of the campaign. Corresponds to the JSON property campaignBudget

Returns:

  • (String) 


5541
5542
5543
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5541

def campaign_budget
  @campaign_budget
end

#create_time ⇒ String

Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. create_time will be deprecated in v1. Use creation_time instead. Corresponds to the JSON property createTime

Returns:

  • (String) 


5548
5549
5550
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5548

def create_time
  @create_time
end

#creation_time ⇒ String

Output only. The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Corresponds to the JSON property creationTime

Returns:

  • (String) 


5554
5555
5556
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5554

def creation_time
  @creation_time
end

#dynamic_search_ads_setting ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCampaignDynamicSearchAdsSetting

The setting for controlling Dynamic Search Ads (DSA). Corresponds to the JSON property dynamicSearchAdsSetting

Returns:



5559
5560
5561
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5559

def dynamic_search_ads_setting
  @dynamic_search_ads_setting
end

#effective_labels ⇒ Array<String>

Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign. Corresponds to the JSON property effectiveLabels

Returns:

  • (Array<String>) 


5565
5566
5567
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5565

def effective_labels
  @effective_labels
end

#end_date ⇒ String

The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30. Corresponds to the JSON property endDate

Returns:

  • (String) 


5573
5574
5575
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5573

def end_date
  @end_date
end

#engine_id ⇒ String

Output only. ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead. Corresponds to the JSON property engineId

Returns:

  • (String) 


5580
5581
5582
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5580

def engine_id
  @engine_id
end

#excluded_parent_asset_field_types ⇒ Array<String>

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. Corresponds to the JSON property excludedParentAssetFieldTypes

Returns:

  • (Array<String>) 


5587
5588
5589
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5587

def excluded_parent_asset_field_types
  @excluded_parent_asset_field_types
end

#final_url_suffix ⇒ String

Suffix used to append query parameters to landing pages that are served with parallel tracking. Corresponds to the JSON property finalUrlSuffix

Returns:

  • (String) 


5593
5594
5595
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5593

def final_url_suffix
  @final_url_suffix
end

#frequency_caps ⇒ Array<Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonFrequencyCapEntry>

A list that limits how often each user will see this campaign's ads. Corresponds to the JSON property frequencyCaps

Returns:



5598
5599
5600
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5598

def frequency_caps
  @frequency_caps
end

#geo_target_type_setting ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCampaignGeoTargetTypeSetting

Represents a collection of settings related to ads geotargeting. Corresponds to the JSON property geoTargetTypeSetting

Returns:



5603
5604
5605
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5603

def geo_target_type_setting
  @geo_target_type_setting
end

#id ⇒ Fixnum

Output only. The ID of the campaign. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


5608
5609
5610
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5608

def id
  @id
end

#labels ⇒ Array<String>

Output only. The resource names of labels attached to this campaign. Corresponds to the JSON property labels

Returns:

  • (Array<String>) 


5613
5614
5615
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5613

def labels
  @labels
end

#last_modified_time ⇒ String

Output only. The datetime when this campaign was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format. Corresponds to the JSON property lastModifiedTime

Returns:

  • (String) 


5619
5620
5621
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5619

def last_modified_time
  @last_modified_time
end

#manual_cpa ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonManualCpa

Manual bidding strategy that allows advertiser to set the bid per advertiser- specified action. Corresponds to the JSON property manualCpa

Returns:



5625
5626
5627
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5625

def manual_cpa
  @manual_cpa
end

#manual_cpc ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonManualCpc

Manual click-based bidding where user pays per click. Corresponds to the JSON property manualCpc

Returns:



5630
5631
5632
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5630

def manual_cpc
  @manual_cpc
end

#manual_cpm ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonManualCpm

Manual impression-based bidding where user pays per thousand impressions. Corresponds to the JSON property manualCpm

Returns:



5635
5636
5637
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5635

def manual_cpm
  @manual_cpm
end

#maximize_conversion_value ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonMaximizeConversionValue

An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget. Corresponds to the JSON property maximizeConversionValue

Returns:



5641
5642
5643
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5641

def maximize_conversion_value
  @maximize_conversion_value
end

#maximize_conversions ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonMaximizeConversions

An automated bidding strategy to help get the most conversions for your campaigns while spending your budget. Corresponds to the JSON property maximizeConversions

Returns:



5647
5648
5649
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5647

def maximize_conversions
  @maximize_conversions
end

#name ⇒ String

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. Corresponds to the JSON property name

Returns:

  • (String) 


5654
5655
5656
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5654

def name
  @name
end

#network_settings ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCampaignNetworkSettings

The network settings for the campaign. Corresponds to the JSON property networkSettings

Returns:



5659
5660
5661
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5659

def network_settings
  @network_settings
end

#optimization_goal_setting ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCampaignOptimizationGoalSetting

Optimization goal setting for this campaign, which includes a set of optimization goal types. Corresponds to the JSON property optimizationGoalSetting

Returns:



5665
5666
5667
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5665

def optimization_goal_setting
  @optimization_goal_setting
end

#percent_cpc ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonPercentCpc

A bidding strategy where bids are a fraction of the advertised price for some good or service. Corresponds to the JSON property percentCpc

Returns:



5671
5672
5673
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5671

def percent_cpc
  @percent_cpc
end

#real_time_bidding_setting ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonRealTimeBiddingSetting

Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network. Corresponds to the JSON property realTimeBiddingSetting

Returns:



5677
5678
5679
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5677

def real_time_bidding_setting
  @real_time_bidding_setting
end

#resource_name ⇒ String

Immutable. The resource name of the campaign. Campaign resource names have the form: customers/customer_id/campaigns/campaign_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


5683
5684
5685
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5683

def resource_name
  @resource_name
end

#selective_optimization ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCampaignSelectiveOptimization

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. Corresponds to the JSON property selectiveOptimization

Returns:



5691
5692
5693
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5691

def selective_optimization
  @selective_optimization
end

#serving_status ⇒ String

Output only. The ad serving status of the campaign. Corresponds to the JSON property servingStatus

Returns:

  • (String) 


5696
5697
5698
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5696

def serving_status
  @serving_status
end

#shopping_setting ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCampaignShoppingSetting

The setting for Shopping campaigns. Defines the universe of products that can be advertised by the campaign, and how this campaign interacts with other Shopping campaigns. Corresponds to the JSON property shoppingSetting

Returns:



5703
5704
5705
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5703

def shopping_setting
  @shopping_setting
end

#start_date ⇒ String

The date when campaign started in serving customer's timezone in YYYY-MM-DD format. Corresponds to the JSON property startDate

Returns:

  • (String) 


5709
5710
5711
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5709

def start_date
  @start_date
end

#status ⇒ String

The status of the campaign. When a new campaign is added, the status defaults to ENABLED. Corresponds to the JSON property status

Returns:

  • (String) 


5715
5716
5717
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5715

def status
  @status
end

#target_cpa ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonTargetCpa

An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set. Corresponds to the JSON property targetCpa

Returns:



5721
5722
5723
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5721

def target_cpa
  @target_cpa
end

#target_cpm ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonTargetCpm

Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set. Corresponds to the JSON property targetCpm

Returns:



5727
5728
5729
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5727

def target_cpm
  @target_cpm
end

#target_impression_share ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonTargetImpressionShare

An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location). Corresponds to the JSON property targetImpressionShare

Returns:



5733
5734
5735
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5733

def target_impression_share
  @target_impression_share
end

#target_roas ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonTargetRoas

An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS). Corresponds to the JSON property targetRoas

Returns:



5739
5740
5741
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5739

def target_roas
  @target_roas
end

#target_spend ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonTargetSpend

An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. Corresponds to the JSON property targetSpend

Returns:



5745
5746
5747
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5745

def target_spend
  @target_spend
end

#tracking_setting ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCampaignTrackingSetting

Campaign-level settings for tracking information. Corresponds to the JSON property trackingSetting

Returns:



5750
5751
5752
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5750

def tracking_setting
  @tracking_setting
end

#tracking_url_template ⇒ String

The URL template for constructing a tracking URL. Corresponds to the JSON property trackingUrlTemplate

Returns:

  • (String) 


5755
5756
5757
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5755

def tracking_url_template
  @tracking_url_template
end

#url_custom_parameters ⇒ Array<Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonCustomParameter>

The list of mappings used to substitute custom parameter tags in a tracking_url_template, final_urls, or mobile_final_urls. Corresponds to the JSON property urlCustomParameters

Returns:



5761
5762
5763
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5761

def url_custom_parameters
  @url_custom_parameters
end

#url_expansion_opt_out ⇒ Boolean Also known as: url_expansion_opt_out?

Represents opting out of URL expansion to more targeted URLs. If opted out ( true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false. Corresponds to the JSON property urlExpansionOptOut

Returns:

  • (Boolean) 


5770
5771
5772
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5770

def url_expansion_opt_out
  @url_expansion_opt_out
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 5778

def update!(**args)
  @accessible_bidding_strategy = args[:accessible_bidding_strategy] if args.key?(:accessible_bidding_strategy)
  @ad_serving_optimization_status = args[:ad_serving_optimization_status] if args.key?(:ad_serving_optimization_status)
  @advertising_channel_sub_type = args[:advertising_channel_sub_type] if args.key?(:advertising_channel_sub_type)
  @advertising_channel_type = args[:advertising_channel_type] if args.key?(:advertising_channel_type)
  @bidding_strategy = args[:bidding_strategy] if args.key?(:bidding_strategy)
  @bidding_strategy_system_status = args[:bidding_strategy_system_status] if args.key?(:bidding_strategy_system_status)
  @bidding_strategy_type = args[:bidding_strategy_type] if args.key?(:bidding_strategy_type)
  @campaign_budget = args[:campaign_budget] if args.key?(:campaign_budget)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @dynamic_search_ads_setting = args[:dynamic_search_ads_setting] if args.key?(:dynamic_search_ads_setting)
  @effective_labels = args[:effective_labels] if args.key?(:effective_labels)
  @end_date = args[:end_date] if args.key?(:end_date)
  @engine_id = args[:engine_id] if args.key?(:engine_id)
  @excluded_parent_asset_field_types = args[:excluded_parent_asset_field_types] if args.key?(:excluded_parent_asset_field_types)
  @final_url_suffix = args[:final_url_suffix] if args.key?(:final_url_suffix)
  @frequency_caps = args[:frequency_caps] if args.key?(:frequency_caps)
  @geo_target_type_setting = args[:geo_target_type_setting] if args.key?(:geo_target_type_setting)
  @id = args[:id] if args.key?(:id)
  @labels = args[:labels] if args.key?(:labels)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @manual_cpa = args[:manual_cpa] if args.key?(:manual_cpa)
  @manual_cpc = args[:manual_cpc] if args.key?(:manual_cpc)
  @manual_cpm = args[:manual_cpm] if args.key?(:manual_cpm)
  @maximize_conversion_value = args[:maximize_conversion_value] if args.key?(:maximize_conversion_value)
  @maximize_conversions = args[:maximize_conversions] if args.key?(:maximize_conversions)
  @name = args[:name] if args.key?(:name)
  @network_settings = args[:network_settings] if args.key?(:network_settings)
  @optimization_goal_setting = args[:optimization_goal_setting] if args.key?(:optimization_goal_setting)
  @percent_cpc = args[:percent_cpc] if args.key?(:percent_cpc)
  @real_time_bidding_setting = args[:real_time_bidding_setting] if args.key?(:real_time_bidding_setting)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @selective_optimization = args[:selective_optimization] if args.key?(:selective_optimization)
  @serving_status = args[:serving_status] if args.key?(:serving_status)
  @shopping_setting = args[:shopping_setting] if args.key?(:shopping_setting)
  @start_date = args[:start_date] if args.key?(:start_date)
  @status = args[:status] if args.key?(:status)
  @target_cpa = args[:target_cpa] if args.key?(:target_cpa)
  @target_cpm = args[:target_cpm] if args.key?(:target_cpm)
  @target_impression_share = args[:target_impression_share] if args.key?(:target_impression_share)
  @target_roas = args[:target_roas] if args.key?(:target_roas)
  @target_spend = args[:target_spend] if args.key?(:target_spend)
  @tracking_setting = args[:tracking_setting] if args.key?(:tracking_setting)
  @tracking_url_template = args[:tracking_url_template] if args.key?(:tracking_url_template)
  @url_custom_parameters = args[:url_custom_parameters] if args.key?(:url_custom_parameters)
  @url_expansion_opt_out = args[:url_expansion_opt_out] if args.key?(:url_expansion_opt_out)
end