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

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

Overview

Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreateSdfDownloadTaskRequest

Returns a new instance of CreateSdfDownloadTaskRequest.



2096
2097
2098
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 2096

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

Instance Attribute Details

#advertiser_idFixnum

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

Returns:

  • (Fixnum)


2065
2066
2067
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 2065

def advertiser_id
  @advertiser_id
end

#id_filterGoogle::Apis::DisplayvideoV1::IdFilter

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



2070
2071
2072
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 2070

def id_filter
  @id_filter
end

#inventory_source_filterGoogle::Apis::DisplayvideoV1::InventorySourceFilter

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



2075
2076
2077
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 2075

def inventory_source_filter
  @inventory_source_filter
end

#parent_entity_filterGoogle::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



2081
2082
2083
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 2081

def parent_entity_filter
  @parent_entity_filter
end

#partner_idFixnum

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

Returns:

  • (Fixnum)


2086
2087
2088
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 2086

def partner_id
  @partner_id
end

#versionString

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)


2094
2095
2096
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 2094

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2101
2102
2103
2104
2105
2106
2107
2108
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 2101

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