REST Resource: queries

{
  "queryId": string,
  "metadata": {
    object (QueryMetadata)
  },
  "params": {
    object (Parameters)
  },
  "schedule": {
    object (QuerySchedule)
  }
}

string (int64 format)

Output only. Query ID.

object (QueryMetadata)

Query metadata.

object (Parameters)

Query parameters.

object (QuerySchedule)

Information on how often and when to run a query.

If ONE_TIME is set to the frequency field, the query will only be run at the time of creation.

{
  "title": string,
  "dataRange": {
    object (DataRange)
  },
  "format": enum (Format),
  "sendNotification": boolean,
  "shareEmailAddress": [
    string
  ]
}

string

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

object (DataRange)

Range of report data.

All reports will be based on the same time zone as used by the advertiser.

enum (Format)

Format of the generated report.

boolean

Whether to send an email notification when a report is ready. Defaults to false.

string

List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.

{
  "range": enum (Range),
  "customStartDate": {
    object (Date)
  },
  "customEndDate": {
    object (Date)
  }
}

enum (Range)

Report data range used to generate the report.

object (Date)

The starting data for the data that is shown in the report. Note, customStartDate is required if range is CUSTOM_DATES and ignored otherwise.

object (Date)

The ending date for the data that is shown in the report. Note, customEndDate is required if range is CUSTOM_DATES and ignored otherwise.

{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "frequency": enum (Frequency),
  "nextRunTimezoneCode": string
}

object (Date)

When to start running the query. Not applicable to ONE_TIME frequency.

object (Date)

Date to periodically run the query until. Not applicable to ONE_TIME frequency.

enum (Frequency)

How often the query is run.

string

Canonical timezone code for report generation time. Defaults to America/New_York.