Class: Google::Apis::DoubleclickbidmanagerV2::QueryMetadata

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

Overview

The metadata of the query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryMetadata

Returns a new instance of QueryMetadata.



334
335
336
 
# File 'lib/google/apis/doubleclickbidmanager_v2/classes.rb', line 334

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

Instance Attribute Details

#data_range ⇒ Google::Apis::DoubleclickbidmanagerV2::DataRange

The date range to be reported on. Corresponds to the JSON property dataRange

Returns:



305
306
307
 
# File 'lib/google/apis/doubleclickbidmanager_v2/classes.rb', line 305

def data_range
  @data_range
end

#format ⇒ String

The format of the report generated by the query. Corresponds to the JSON property format

Returns:

  • (String) 


310
311
312
 
# File 'lib/google/apis/doubleclickbidmanager_v2/classes.rb', line 310

def format
  @format
end

#send_notification ⇒ Boolean Also known as: send_notification?

Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is false by default. Corresponds to the JSON property sendNotification

Returns:

  • (Boolean) 


316
317
318
 
# File 'lib/google/apis/doubleclickbidmanager_v2/classes.rb', line 316

def send_notification
  @send_notification
end

#share_email_address ⇒ Array<String>

List of additional email addresses with which to share the query. If send_notification is true, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface. Corresponds to the JSON property shareEmailAddress

Returns:

  • (Array<String>) 


326
327
328
 
# File 'lib/google/apis/doubleclickbidmanager_v2/classes.rb', line 326

def share_email_address
  @share_email_address
end

#title ⇒ String

The display name of the query. This value will be used in the file name of reports generated by the query. Corresponds to the JSON property title

Returns:

  • (String) 


332
333
334
 
# File 'lib/google/apis/doubleclickbidmanager_v2/classes.rb', line 332

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



339
340
341
342
343
344
345
 
# File 'lib/google/apis/doubleclickbidmanager_v2/classes.rb', line 339

def update!(**args)
  @data_range = args[:data_range] if args.key?(:data_range)
  @format = args[:format] if args.key?(:format)
  @send_notification = args[:send_notification] if args.key?(:send_notification)
  @share_email_address = args[:share_email_address] if args.key?(:share_email_address)
  @title = args[:title] if args.key?(:title)
end