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