Class: Google::Apis::DoubleclickbidmanagerV1::QueryMetadata

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

Overview

Query metadata.

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

Returns a new instance of QueryMetadata.


417
418
419
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 417

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

Instance Attribute Details

#data_rangeString

Range of report data. Corresponds to the JSON property dataRange

Returns:

  • (String)

357
358
359
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 357

def data_range
  @data_range
end

#formatString

Format of the generated report. Corresponds to the JSON property format

Returns:

  • (String)

362
363
364
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 362

def format
  @format
end

#google_cloud_storage_path_for_latest_reportString

The path to the location in Google Cloud Storage where the latest report is stored. Corresponds to the JSON property googleCloudStoragePathForLatestReport

Returns:

  • (String)

368
369
370
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 368

def google_cloud_storage_path_for_latest_report
  @google_cloud_storage_path_for_latest_report
end

#google_drive_path_for_latest_reportString

The path in Google Drive for the latest report. Corresponds to the JSON property googleDrivePathForLatestReport

Returns:

  • (String)

373
374
375
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 373

def google_drive_path_for_latest_report
  @google_drive_path_for_latest_report
end

#latest_report_run_time_msString

The time when the latest report started to run. Corresponds to the JSON property latestReportRunTimeMs

Returns:

  • (String)

378
379
380
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 378

def latest_report_run_time_ms
  @latest_report_run_time_ms
end

#localeString

Locale of the generated reports. Valid values are cs CZECH de GERMAN en ENGLISH es SPANISH fr FRENCH it ITALIAN ja JAPANESE ko KOREAN pl POLISH pt-BR BRAZILIAN_PORTUGUESE ru RUSSIAN tr TURKISH uk UKRAINIAN zh-CN CHINA_CHINESE zh- TW TAIWAN_CHINESE An locale string not in the list above will generate reports in English. Corresponds to the JSON property locale

Returns:

  • (String)

387
388
389
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 387

def locale
  @locale
end

#report_countFixnum

Number of reports that have been generated for the query. Corresponds to the JSON property reportCount

Returns:

  • (Fixnum)

392
393
394
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 392

def report_count
  @report_count
end

#runningBoolean Also known as: running?

Whether the latest report is currently running. Corresponds to the JSON property running

Returns:

  • (Boolean)

397
398
399
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 397

def running
  @running
end

#send_notificationBoolean Also known as: send_notification?

Whether to send an email notification when a report is ready. Default to false. Corresponds to the JSON property sendNotification

Returns:

  • (Boolean)

403
404
405
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 403

def send_notification
  @send_notification
end

#share_email_addressArray<String>

List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. Corresponds to the JSON property shareEmailAddress

Returns:

  • (Array<String>)

410
411
412
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 410

def share_email_address
  @share_email_address
end

#titleString

Query title. It is used to name the reports generated from this query. Corresponds to the JSON property title

Returns:

  • (String)

415
416
417
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 415

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


422
423
424
425
426
427
428
429
430
431
432
433
434
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 422

def update!(**args)
  @data_range = args[:data_range] if args.key?(:data_range)
  @format = args[:format] if args.key?(:format)
  @google_cloud_storage_path_for_latest_report = args[:google_cloud_storage_path_for_latest_report] if args.key?(:google_cloud_storage_path_for_latest_report)
  @google_drive_path_for_latest_report = args[:google_drive_path_for_latest_report] if args.key?(:google_drive_path_for_latest_report)
  @latest_report_run_time_ms = args[:latest_report_run_time_ms] if args.key?(:latest_report_run_time_ms)
  @locale = args[:locale] if args.key?(:locale)
  @report_count = args[:report_count] if args.key?(:report_count)
  @running = args[:running] if args.key?(:running)
  @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