| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="doubleclickbidmanager_v1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1.queries.html">queries</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 78 | <code><a href="#createquery">createquery(body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 79 | <p class="firstline">Creates a query.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#deletequery">deletequery(queryId)</a></code></p> |
| 82 | <p class="firstline">Deletes a stored query as well as the associated stored reports.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#getquery">getquery(queryId)</a></code></p> |
| 85 | <p class="firstline">Retrieves a stored query.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#listqueries">listqueries()</a></code></p> |
| 88 | <p class="firstline">Retrieves stored queries.</p> |
| 89 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <code><a href="#runquery">runquery(queryId, body=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 91 | <p class="firstline">Runs a stored query to generate a report.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 94 | <code class="details" id="createquery">createquery(body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 95 | <pre>Creates a query. |
| 96 | |
| 97 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 98 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 99 | The object takes the form of: |
| 100 | |
| 101 | { # Represents a query. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 102 | "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". |
| 103 | "metadata": { # Query metadata. # Query metadata. |
| 104 | "dataRange": "A String", # Range of report data. |
| 105 | "format": "A String", # Format of the generated report. |
| 106 | "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored. |
| 107 | "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report. |
| 108 | "latestReportRunTimeMs": "A String", # The time when the latest report started to run. |
| 109 | "locale": "A 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 |
| 110 | # |
| 111 | # An locale string not in the list above will generate reports in English. |
| 112 | "reportCount": 42, # Number of reports that have been generated for the query. |
| 113 | "running": True or False, # Whether the latest report is currently running. |
| 114 | "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false. |
| 115 | "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. |
| 116 | "A String", |
| 117 | ], |
| 118 | "title": "A String", # Query title. It is used to name the reports generated from this query. |
| 119 | }, |
| 120 | "params": { # Parameters of a query or report. # Query parameters. |
| 121 | "filters": [ # Filters used to match traffic data in your report. |
| 122 | { # Filter used to match traffic data in your report. |
| 123 | "type": "A String", # Filter type. |
| 124 | "value": "A String", # Filter value. |
| 125 | }, |
| 126 | ], |
| 127 | "groupBys": [ # Data is grouped by the filters listed in this field. |
| 128 | "A String", |
| 129 | ], |
| 130 | "includeInviteData": True or False, # Deprecated. This field is no longer in use. |
| 131 | "metrics": [ # Metrics to include as columns in your report. |
| 132 | "A String", |
| 133 | ], |
| 134 | "type": "A String", # Report type. |
| 135 | }, |
| 136 | "queryId": "A String", # Query ID. |
| 137 | "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. |
| 138 | "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. |
| 139 | "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. |
| 140 | "endTimeMs": "A String", # Datetime to periodically run the query until. |
| 141 | "frequency": "A String", # How often the query is run. |
| 142 | "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. |
| 143 | "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York. |
| 144 | }, |
| 145 | "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. |
| 146 | } |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 147 | |
| 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
| 152 | { # Represents a query. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 153 | "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". |
| 154 | "metadata": { # Query metadata. # Query metadata. |
| 155 | "dataRange": "A String", # Range of report data. |
| 156 | "format": "A String", # Format of the generated report. |
| 157 | "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored. |
| 158 | "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report. |
| 159 | "latestReportRunTimeMs": "A String", # The time when the latest report started to run. |
| 160 | "locale": "A 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 |
| 161 | # |
| 162 | # An locale string not in the list above will generate reports in English. |
| 163 | "reportCount": 42, # Number of reports that have been generated for the query. |
| 164 | "running": True or False, # Whether the latest report is currently running. |
| 165 | "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false. |
| 166 | "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. |
| 167 | "A String", |
| 168 | ], |
| 169 | "title": "A String", # Query title. It is used to name the reports generated from this query. |
| 170 | }, |
| 171 | "params": { # Parameters of a query or report. # Query parameters. |
| 172 | "filters": [ # Filters used to match traffic data in your report. |
| 173 | { # Filter used to match traffic data in your report. |
| 174 | "type": "A String", # Filter type. |
| 175 | "value": "A String", # Filter value. |
| 176 | }, |
| 177 | ], |
| 178 | "groupBys": [ # Data is grouped by the filters listed in this field. |
| 179 | "A String", |
| 180 | ], |
| 181 | "includeInviteData": True or False, # Deprecated. This field is no longer in use. |
| 182 | "metrics": [ # Metrics to include as columns in your report. |
| 183 | "A String", |
| 184 | ], |
| 185 | "type": "A String", # Report type. |
| 186 | }, |
| 187 | "queryId": "A String", # Query ID. |
| 188 | "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. |
| 189 | "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. |
| 190 | "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. |
| 191 | "endTimeMs": "A String", # Datetime to periodically run the query until. |
| 192 | "frequency": "A String", # How often the query is run. |
| 193 | "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. |
| 194 | "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York. |
| 195 | }, |
| 196 | "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. |
| 197 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 198 | </div> |
| 199 | |
| 200 | <div class="method"> |
| 201 | <code class="details" id="deletequery">deletequery(queryId)</code> |
| 202 | <pre>Deletes a stored query as well as the associated stored reports. |
| 203 | |
| 204 | Args: |
| 205 | queryId: string, Query ID to delete. (required) |
| 206 | </pre> |
| 207 | </div> |
| 208 | |
| 209 | <div class="method"> |
| 210 | <code class="details" id="getquery">getquery(queryId)</code> |
| 211 | <pre>Retrieves a stored query. |
| 212 | |
| 213 | Args: |
| 214 | queryId: string, Query ID to retrieve. (required) |
| 215 | |
| 216 | Returns: |
| 217 | An object of the form: |
| 218 | |
| 219 | { # Represents a query. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 220 | "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". |
| 221 | "metadata": { # Query metadata. # Query metadata. |
| 222 | "dataRange": "A String", # Range of report data. |
| 223 | "format": "A String", # Format of the generated report. |
| 224 | "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored. |
| 225 | "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report. |
| 226 | "latestReportRunTimeMs": "A String", # The time when the latest report started to run. |
| 227 | "locale": "A 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 |
| 228 | # |
| 229 | # An locale string not in the list above will generate reports in English. |
| 230 | "reportCount": 42, # Number of reports that have been generated for the query. |
| 231 | "running": True or False, # Whether the latest report is currently running. |
| 232 | "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false. |
| 233 | "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. |
| 234 | "A String", |
| 235 | ], |
| 236 | "title": "A String", # Query title. It is used to name the reports generated from this query. |
| 237 | }, |
| 238 | "params": { # Parameters of a query or report. # Query parameters. |
| 239 | "filters": [ # Filters used to match traffic data in your report. |
| 240 | { # Filter used to match traffic data in your report. |
| 241 | "type": "A String", # Filter type. |
| 242 | "value": "A String", # Filter value. |
| 243 | }, |
| 244 | ], |
| 245 | "groupBys": [ # Data is grouped by the filters listed in this field. |
| 246 | "A String", |
| 247 | ], |
| 248 | "includeInviteData": True or False, # Deprecated. This field is no longer in use. |
| 249 | "metrics": [ # Metrics to include as columns in your report. |
| 250 | "A String", |
| 251 | ], |
| 252 | "type": "A String", # Report type. |
| 253 | }, |
| 254 | "queryId": "A String", # Query ID. |
| 255 | "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. |
| 256 | "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. |
| 257 | "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. |
| 258 | "endTimeMs": "A String", # Datetime to periodically run the query until. |
| 259 | "frequency": "A String", # How often the query is run. |
| 260 | "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. |
| 261 | "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York. |
| 262 | }, |
| 263 | "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. |
| 264 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 265 | </div> |
| 266 | |
| 267 | <div class="method"> |
| 268 | <code class="details" id="listqueries">listqueries()</code> |
| 269 | <pre>Retrieves stored queries. |
| 270 | |
| 271 | Args: |
| 272 | |
| 273 | Returns: |
| 274 | An object of the form: |
| 275 | |
| 276 | { # List queries response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 277 | "kind": "doubleclickbidmanager#listQueriesResponse", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse". |
| 278 | "queries": [ # Retrieved queries. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 279 | { # Represents a query. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 280 | "kind": "doubleclickbidmanager#query", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". |
| 281 | "metadata": { # Query metadata. # Query metadata. |
| 282 | "dataRange": "A String", # Range of report data. |
| 283 | "format": "A String", # Format of the generated report. |
| 284 | "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored. |
| 285 | "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report. |
| 286 | "latestReportRunTimeMs": "A String", # The time when the latest report started to run. |
| 287 | "locale": "A 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 |
| 288 | # |
| 289 | # An locale string not in the list above will generate reports in English. |
| 290 | "reportCount": 42, # Number of reports that have been generated for the query. |
| 291 | "running": True or False, # Whether the latest report is currently running. |
| 292 | "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false. |
| 293 | "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. |
| 294 | "A String", |
| 295 | ], |
| 296 | "title": "A String", # Query title. It is used to name the reports generated from this query. |
| 297 | }, |
| 298 | "params": { # Parameters of a query or report. # Query parameters. |
| 299 | "filters": [ # Filters used to match traffic data in your report. |
| 300 | { # Filter used to match traffic data in your report. |
| 301 | "type": "A String", # Filter type. |
| 302 | "value": "A String", # Filter value. |
| 303 | }, |
| 304 | ], |
| 305 | "groupBys": [ # Data is grouped by the filters listed in this field. |
| 306 | "A String", |
| 307 | ], |
| 308 | "includeInviteData": True or False, # Deprecated. This field is no longer in use. |
| 309 | "metrics": [ # Metrics to include as columns in your report. |
| 310 | "A String", |
| 311 | ], |
| 312 | "type": "A String", # Report type. |
| 313 | }, |
| 314 | "queryId": "A String", # Query ID. |
| 315 | "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. |
| 316 | "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. |
| 317 | "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. |
| 318 | "endTimeMs": "A String", # Datetime to periodically run the query until. |
| 319 | "frequency": "A String", # How often the query is run. |
| 320 | "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. |
| 321 | "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York. |
| 322 | }, |
| 323 | "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 324 | }, |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 325 | ], |
| 326 | }</pre> |
| 327 | </div> |
| 328 | |
| 329 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 330 | <code class="details" id="runquery">runquery(queryId, body=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 331 | <pre>Runs a stored query to generate a report. |
| 332 | |
| 333 | Args: |
| 334 | queryId: string, Query ID to run. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 335 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 336 | The object takes the form of: |
| 337 | |
| 338 | { # Request to run a stored query to generate a report. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 339 | "dataRange": "A String", # Report data range used to generate the report. |
| 340 | "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. |
| 341 | "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. |
| 342 | "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 343 | } |
| 344 | |
| 345 | </pre> |
| 346 | </div> |
| 347 | |
| 348 | </body></html> |