Class: Google::Apis::DisplayvideoV3::CreateSdfDownloadTaskRequest

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

Overview

Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CreateSdfDownloadTaskRequest

Returns a new instance of CreateSdfDownloadTaskRequest.



4234
4235
4236
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4234

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

Instance Attribute Details

#advertiser_id ⇒ Fixnum

The ID of the advertiser to download SDF for. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


4203
4204
4205
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4203

def advertiser_id
  @advertiser_id
end

#id_filter ⇒ Google::Apis::DisplayvideoV3::IdFilter

A filtering option that filters entities by their entity IDs. Corresponds to the JSON property idFilter

Returns:



4208
4209
4210
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4208

def id_filter
  @id_filter
end

#inventory_source_filter ⇒ Google::Apis::DisplayvideoV3::InventorySourceFilter

A filtering option for filtering on Inventory Source entities. Corresponds to the JSON property inventorySourceFilter

Returns:



4213
4214
4215
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4213

def inventory_source_filter
  @inventory_source_filter
end

#parent_entity_filter ⇒ Google::Apis::DisplayvideoV3::ParentEntityFilter

A filtering option that filters on selected file types belonging to a chosen set of filter entities. Corresponds to the JSON property parentEntityFilter

Returns:



4219
4220
4221
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4219

def parent_entity_filter
  @parent_entity_filter
end

#partner_id ⇒ Fixnum

The ID of the partner to download SDF for. Corresponds to the JSON property partnerId

Returns:

  • (Fixnum) 


4224
4225
4226
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4224

def partner_id
  @partner_id
end

#version ⇒ String

Required. The SDF version of the downloaded file. If set to SDF_VERSION_UNSPECIFIED, this will default to the version specified by the advertiser or partner identified by root_id. An advertiser inherits its SDF version from its partner unless configured otherwise. Corresponds to the JSON property version

Returns:

  • (String) 


4232
4233
4234
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4232

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4239
4240
4241
4242
4243
4244
4245
4246
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 4239

def update!(**args)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @id_filter = args[:id_filter] if args.key?(:id_filter)
  @inventory_source_filter = args[:inventory_source_filter] if args.key?(:inventory_source_filter)
  @parent_entity_filter = args[:parent_entity_filter] if args.key?(:parent_entity_filter)
  @partner_id = args[:partner_id] if args.key?(:partner_id)
  @version = args[:version] if args.key?(:version)
end