Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesBiddingDataExclusion

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

Overview

Represents a bidding data exclusion. Bidding data exclusions can be set in client accounts only, and cannot be used in manager accounts. See "About data exclusions" at https://support.google.com/google-ads/answer/10370710. Note: A customer account can have a maximum of 500 active bidding data exclusions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ResourcesBiddingDataExclusion

Returns a new instance of GoogleAdsSearchads360V23ResourcesBiddingDataExclusion.



23373
23374
23375
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23373

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

Instance Attribute Details

#advertising_channel_types ⇒ Array<String>

The data_exclusion will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this exclusion is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported. Corresponds to the JSON property advertisingChannelTypes

Returns:

  • (Array<String>) 


23310
23311
23312
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23310

def advertising_channel_types
  @advertising_channel_types
end

#campaigns ⇒ Array<String>

The data exclusion will apply to the campaigns listed when the scope of this exclusion is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a data exclusion with both advertising_channel_types and campaign_ids is not supported. Corresponds to the JSON property campaigns

Returns:

  • (Array<String>) 


23318
23319
23320
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23318

def campaigns
  @campaigns
end

#data_exclusion_id ⇒ Fixnum

Output only. The ID of the data exclusion. Corresponds to the JSON property dataExclusionId

Returns:

  • (Fixnum) 


23323
23324
23325
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23323

def data_exclusion_id
  @data_exclusion_id
end

#description ⇒ String

The description of the data exclusion. The description can be at most 2048 characters. Corresponds to the JSON property description

Returns:

  • (String) 


23329
23330
23331
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23329

def description
  @description
end

#devices ⇒ Array<String>

If not specified, all devices will be included in this exclusion. Otherwise, only the specified targeted devices will be included in this exclusion. Corresponds to the JSON property devices

Returns:

  • (Array<String>) 


23335
23336
23337
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23335

def devices
  @devices
end

#end_date_time ⇒ String

Required. The exclusive end time of the data exclusion in yyyy-MM-dd HH:mm:ss format. The length of [start_date_time, end_date_time) interval must be within (0, 14 days]. Corresponds to the JSON property endDateTime

Returns:

  • (String) 


23342
23343
23344
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23342

def end_date_time
  @end_date_time
end

#name ⇒ String

The name of the data exclusion. The name can be at most 255 characters. Corresponds to the JSON property name

Returns:

  • (String) 


23347
23348
23349
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23347

def name
  @name
end

#resource_name ⇒ String

Immutable. The resource name of the data exclusion. Data exclusion resource names have the form: customers/customer_id/biddingDataExclusions/ data_exclusion_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


23354
23355
23356
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23354

def resource_name
  @resource_name
end

#scope ⇒ String

The scope of the data exclusion. Corresponds to the JSON property scope

Returns:

  • (String) 


23359
23360
23361
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23359

def scope
  @scope
end

#start_date_time ⇒ String

Required. The inclusive start time of the data exclusion in yyyy-MM-dd HH:mm: ss format. A data exclusion is backward looking and should be used for events that start in the past and end either in the past or future. Corresponds to the JSON property startDateTime

Returns:

  • (String) 


23366
23367
23368
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23366

def start_date_time
  @start_date_time
end

#status ⇒ String

Output only. The status of the data exclusion. Corresponds to the JSON property status

Returns:

  • (String) 


23371
23372
23373
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23371

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23378
23379
23380
23381
23382
23383
23384
23385
23386
23387
23388
23389
23390
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 23378

def update!(**args)
  @advertising_channel_types = args[:advertising_channel_types] if args.key?(:advertising_channel_types)
  @campaigns = args[:campaigns] if args.key?(:campaigns)
  @data_exclusion_id = args[:data_exclusion_id] if args.key?(:data_exclusion_id)
  @description = args[:description] if args.key?(:description)
  @devices = args[:devices] if args.key?(:devices)
  @end_date_time = args[:end_date_time] if args.key?(:end_date_time)
  @name = args[:name] if args.key?(:name)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @scope = args[:scope] if args.key?(:scope)
  @start_date_time = args[:start_date_time] if args.key?(:start_date_time)
  @status = args[:status] if args.key?(:status)
end