Class: Google::Apis::DisplayvideoV1::CreateSdfDownloadTaskRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v1/classes.rb,
lib/google/apis/displayvideo_v1/representations.rb,
lib/google/apis/displayvideo_v1/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.



3286
3287
3288
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3286

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) 


3255
3256
3257
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3255

def advertiser_id
  @advertiser_id
end

#id_filter ⇒ Google::Apis::DisplayvideoV1::IdFilter

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

Returns:



3260
3261
3262
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3260

def id_filter
  @id_filter
end

#inventory_source_filter ⇒ Google::Apis::DisplayvideoV1::InventorySourceFilter

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

Returns:



3265
3266
3267
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3265

def inventory_source_filter
  @inventory_source_filter
end

#parent_entity_filter ⇒ Google::Apis::DisplayvideoV1::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:



3271
3272
3273
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3271

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) 


3276
3277
3278
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3276

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) 


3284
3285
3286
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3284

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3291
3292
3293
3294
3295
3296
3297
3298
 
# File 'lib/google/apis/displayvideo_v1/classes.rb', line 3291

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