# DoubleClick Bid Manager API . queries

## Instance Methods

Creates a query.

Deletes a stored query as well as the associated stored reports.

Retrieves a stored query.

Retrieves stored queries.

Runs a stored query to generate a report.

### Method Details

`createquery(body)`

    Creates a query.

    Args:
      body: object, The request body. (required)
        The object takes the form of:

    { # Represents a query.
      "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
      "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
        "endTimeMs": "A String", # Datetime to periodically run the query until.
        "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
        "frequency": "A String", # How often the query is run.
        "nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight Range is 0 to 1439. Only applies to scheduled reports.
      },
      "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
      "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
      "queryId": "A String", # Query ID.
      "params": { # Parameters of a query or report. # Query parameters.
        "metrics": [ # Metrics to include as columns in your report.
          "A String",
        ],
        "includeInviteData": True or False, # Whether to include data from Invite Media.
        "type": "A String", # Report type.
        "groupBys": [ # Data is grouped by the filters listed in this field.
          "A String",
        ],
        "filters": [ # Filters used to match traffic data in your report.
          { # Filter used to match traffic data in your report.
            "type": "A String", # Filter type.
            "value": "A String", # Filter value.
          },
        ],
      },
      "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
      "metadata": { # Query metadata. # Query metadata.
        "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
        "dataRange": "A String", # Range of report data.
        "format": "A String", # Format of the generated report.
        "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
        "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
        "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
          "A String",
        ],
        "reportCount": 42, # Number of reports that have been generated for the query.
        "running": True or False, # Whether the latest report is currently running.
        "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
        "title": "A String", # Query title. It is used to name the reports generated from this query.
      },
    }

    Returns:
      An object of the form:

        { # Represents a query.
        "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
        "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
          "endTimeMs": "A String", # Datetime to periodically run the query until.
          "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
          "frequency": "A String", # How often the query is run.
          "nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight Range is 0 to 1439. Only applies to scheduled reports.
        },
        "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
        "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
        "queryId": "A String", # Query ID.
        "params": { # Parameters of a query or report. # Query parameters.
          "metrics": [ # Metrics to include as columns in your report.
            "A String",
          ],
          "includeInviteData": True or False, # Whether to include data from Invite Media.
          "type": "A String", # Report type.
          "groupBys": [ # Data is grouped by the filters listed in this field.
            "A String",
          ],
          "filters": [ # Filters used to match traffic data in your report.
            { # Filter used to match traffic data in your report.
              "type": "A String", # Filter type.
              "value": "A String", # Filter value.
            },
          ],
        },
        "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
        "metadata": { # Query metadata. # Query metadata.
          "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
          "dataRange": "A String", # Range of report data.
          "format": "A String", # Format of the generated report.
          "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
          "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
          "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
            "A String",
          ],
          "reportCount": 42, # Number of reports that have been generated for the query.
          "running": True or False, # Whether the latest report is currently running.
          "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
          "title": "A String", # Query title. It is used to name the reports generated from this query.
        },
      }

`deletequery(queryId)`

    Deletes a stored query as well as the associated stored reports.

    Args:
      queryId: string, Query ID to delete. (required)

`getquery(queryId)`

    Retrieves a stored query.

    Args:
      queryId: string, Query ID to retrieve. (required)

    Returns:
      An object of the form:

        { # Represents a query.
        "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
        "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
          "endTimeMs": "A String", # Datetime to periodically run the query until.
          "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
          "frequency": "A String", # How often the query is run.
          "nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight Range is 0 to 1439. Only applies to scheduled reports.
        },
        "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
        "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
        "queryId": "A String", # Query ID.
        "params": { # Parameters of a query or report. # Query parameters.
          "metrics": [ # Metrics to include as columns in your report.
            "A String",
          ],
          "includeInviteData": True or False, # Whether to include data from Invite Media.
          "type": "A String", # Report type.
          "groupBys": [ # Data is grouped by the filters listed in this field.
            "A String",
          ],
          "filters": [ # Filters used to match traffic data in your report.
            { # Filter used to match traffic data in your report.
              "type": "A String", # Filter type.
              "value": "A String", # Filter value.
            },
          ],
        },
        "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
        "metadata": { # Query metadata. # Query metadata.
          "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
          "dataRange": "A String", # Range of report data.
          "format": "A String", # Format of the generated report.
          "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
          "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
          "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
            "A String",
          ],
          "reportCount": 42, # Number of reports that have been generated for the query.
          "running": True or False, # Whether the latest report is currently running.
          "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
          "title": "A String", # Query title. It is used to name the reports generated from this query.
        },
      }

`listqueries()`

    Retrieves stored queries.

    Args:

    Returns:
      An object of the form:

        { # List queries response.
        "kind": "doubleclickbidmanager#listQueriesResponse", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse".
        "queries": [ # Retrieved queries.
          { # Represents a query.
            "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query".
            "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query.
              "endTimeMs": "A String", # Datetime to periodically run the query until.
              "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York.
              "frequency": "A String", # How often the query is run.
              "nextRunMinuteOfDay": 42, # Time of day at which a new report will be generated, represented as minutes past midnight Range is 0 to 1439. Only applies to scheduled reports.
            },
            "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
            "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
            "queryId": "A String", # Query ID.
            "params": { # Parameters of a query or report. # Query parameters.
              "metrics": [ # Metrics to include as columns in your report.
                "A String",
              ],
              "includeInviteData": True or False, # Whether to include data from Invite Media.
              "type": "A String", # Report type.
              "groupBys": [ # Data is grouped by the filters listed in this field.
                "A String",
              ],
              "filters": [ # Filters used to match traffic data in your report.
                { # Filter used to match traffic data in your report.
                  "type": "A String", # Filter type.
                  "value": "A String", # Filter value.
                },
              ],
            },
            "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if metadata.dataRange is CUSTOM_DATES and ignored otherwise.
            "metadata": { # Query metadata. # Query metadata.
              "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored.
              "dataRange": "A String", # Range of report data.
              "format": "A String", # Format of the generated report.
              "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report.
              "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false.
              "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification.
                "A String",
              ],
              "reportCount": 42, # Number of reports that have been generated for the query.
              "running": True or False, # Whether the latest report is currently running.
              "latestReportRunTimeMs": "A String", # The time when the latest report started to run.
              "title": "A String", # Query title. It is used to name the reports generated from this query.
            },
          },
        ],
      }

`runquery(queryId, body)`

    Runs a stored query to generate a report.

    Args:
      queryId: string, Query ID to run. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Request to run a stored query to generate a report.
        "reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report. Note, reportDataEndTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
        "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York.
        "reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report. Note, reportDataStartTimeMs is required if dataRange is CUSTOM_DATES and ignored otherwise.
        "dataRange": "A String", # Report data range used to generate the report.
      }