Class: Google::Apis::DoubleclickbidmanagerV1::QueryMetadata
- Inherits:
-
Object
- Object
- Google::Apis::DoubleclickbidmanagerV1::QueryMetadata
- 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
-
#data_range ⇒ String
Range of report data.
-
#format ⇒ String
Format of the generated report.
-
#google_cloud_storage_path_for_latest_report ⇒ String
The path to the location in Google Cloud Storage where the latest report is stored.
-
#google_drive_path_for_latest_report ⇒ String
The path in Google Drive for the latest report.
-
#latest_report_run_time_ms ⇒ Fixnum
The time when the latest report started to run.
-
#locale ⇒ String
Locale of the generated reports.
-
#report_count ⇒ Fixnum
Number of reports that have been generated for the query.
-
#running ⇒ Boolean
(also: #running?)
Whether the latest report is currently running.
-
#send_notification ⇒ Boolean
(also: #send_notification?)
Whether to send an email notification when a report is ready.
-
#share_email_address ⇒ Array<String>
List of email addresses which are sent email notifications when the report is finished.
-
#title ⇒ String
Query title.
Instance Method Summary collapse
-
#initialize(**args) ⇒ QueryMetadata
constructor
A new instance of QueryMetadata.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ QueryMetadata
Returns a new instance of QueryMetadata.
430 431 432 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 430 def initialize(**args) update!(**args) end |
Instance Attribute Details
#data_range ⇒ String
Range of report data.
Corresponds to the JSON property dataRange
370 371 372 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 370 def data_range @data_range end |
#format ⇒ String
Format of the generated report.
Corresponds to the JSON property format
375 376 377 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 375 def format @format end |
#google_cloud_storage_path_for_latest_report ⇒ String
The path to the location in Google Cloud Storage where the latest report is
stored.
Corresponds to the JSON property googleCloudStoragePathForLatestReport
381 382 383 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 381 def google_cloud_storage_path_for_latest_report @google_cloud_storage_path_for_latest_report end |
#google_drive_path_for_latest_report ⇒ String
The path in Google Drive for the latest report.
Corresponds to the JSON property googleDrivePathForLatestReport
386 387 388 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 386 def google_drive_path_for_latest_report @google_drive_path_for_latest_report end |
#latest_report_run_time_ms ⇒ Fixnum
The time when the latest report started to run.
Corresponds to the JSON property latestReportRunTimeMs
391 392 393 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 391 def latest_report_run_time_ms @latest_report_run_time_ms end |
#locale ⇒ String
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
400 401 402 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 400 def locale @locale end |
#report_count ⇒ Fixnum
Number of reports that have been generated for the query.
Corresponds to the JSON property reportCount
405 406 407 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 405 def report_count @report_count end |
#running ⇒ Boolean Also known as: running?
Whether the latest report is currently running.
Corresponds to the JSON property running
410 411 412 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 410 def running @running end |
#send_notification ⇒ Boolean 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
416 417 418 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 416 def send_notification @send_notification end |
#share_email_address ⇒ Array<String>
List of email addresses which are sent email notifications when the report is
finished. Separate from sendNotification.
Corresponds to the JSON property shareEmailAddress
423 424 425 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 423 def share_email_address @share_email_address end |
#title ⇒ String
Query title. It is used to name the reports generated from this query.
Corresponds to the JSON property title
428 429 430 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 428 def title @title end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
435 436 437 438 439 440 441 442 443 444 445 446 447 |
# File 'generated/google/apis/doubleclickbidmanager_v1/classes.rb', line 435 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 |