Class: Google::Apis::DoubleclickbidmanagerV1_1::DownloadRequest

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

Overview

Request to fetch stored inventory sources, campaigns, insertion orders, line items, YouTube ad groups and ads.

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) ⇒ DownloadRequest

Returns a new instance of DownloadRequest.


168
169
170
# File 'generated/google/apis/doubleclickbidmanager_v1_1/classes.rb', line 168

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

Instance Attribute Details

#file_typesArray<String>

File types that will be returned. If INVENTORY_SOURCE is requested, no other file types may be requested. Acceptable values are: - "AD" - "AD_GROUP" - " CAMPAIGN" - "INSERTION_ORDER" - "INVENTORY_SOURCE" - "LINE_ITEM" Corresponds to the JSON property fileTypes

Returns:

  • (Array<String>)

148
149
150
# File 'generated/google/apis/doubleclickbidmanager_v1_1/classes.rb', line 148

def file_types
  @file_types
end

#filter_idsArray<Fixnum>

The IDs of the specified filter type. This is used to filter entities to fetch. At least one ID must be specified. Corresponds to the JSON property filterIds

Returns:

  • (Array<Fixnum>)

154
155
156
# File 'generated/google/apis/doubleclickbidmanager_v1_1/classes.rb', line 154

def filter_ids
  @filter_ids
end

#filter_typeString

Filter type used to filter entities to fetch. PARTNER_ID and INVENTORY_SOURCE_ID may only be used when downloading inventory sources. Corresponds to the JSON property filterType

Returns:

  • (String)

160
161
162
# File 'generated/google/apis/doubleclickbidmanager_v1_1/classes.rb', line 160

def filter_type
  @filter_type
end

#versionString

SDF Version (column names, types, order) in which the entities will be returned. Default to 5. Corresponds to the JSON property version

Returns:

  • (String)

166
167
168
# File 'generated/google/apis/doubleclickbidmanager_v1_1/classes.rb', line 166

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


173
174
175
176
177
178
# File 'generated/google/apis/doubleclickbidmanager_v1_1/classes.rb', line 173

def update!(**args)
  @file_types = args[:file_types] if args.key?(:file_types)
  @filter_ids = args[:filter_ids] if args.key?(:filter_ids)
  @filter_type = args[:filter_type] if args.key?(:filter_type)
  @version = args[:version] if args.key?(:version)
end