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_1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1_1.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(asynchronous=None, 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(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves stored queries.</p> 92<p class="toc_element"> 93 <code><a href="#listqueries_next">listqueries_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#runquery">runquery(queryId, asynchronous=None, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Runs a stored query to generate a report.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="createquery">createquery(asynchronous=None, body=None, x__xgafv=None)</code> 106 <pre>Creates a query. 107 108Args: 109 body: object, The request body. 110 The object takes the form of: 111 112{ # Represents a query. 113 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". 114 "metadata": { # Query metadata. # Query metadata. 115 "dataRange": "A String", # Range of report data. 116 "format": "A String", # Format of the generated report. 117 "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored. 118 "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report. 119 "latestReportRunTimeMs": "A String", # The time when the latest report started to run. 120 "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. 121 "reportCount": 42, # Number of reports that have been generated for the query. 122 "running": True or False, # Whether the latest report is currently running. 123 "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false. 124 "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. 125 "A String", 126 ], 127 "title": "A String", # Query title. It is used to name the reports generated from this query. 128 }, 129 "params": { # Parameters of a query or report. # Query parameters. 130 "filters": [ # Filters used to match traffic data in your report. 131 { # Filter used to match traffic data in your report. 132 "type": "A String", # Filter type. 133 "value": "A String", # Filter value. 134 }, 135 ], 136 "groupBys": [ # Data is grouped by the filters listed in this field. 137 "A String", 138 ], 139 "includeInviteData": True or False, # Deprecated. This field is no longer in use. 140 "metrics": [ # Metrics to include as columns in your report. 141 "A String", 142 ], 143 "options": { # Additional query options. # Additional query options. 144 "includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items. 145 "pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings. 146 "channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings. 147 "fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping. 148 "name": "A String", # Channel Grouping name. 149 "rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping. 150 { # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied. 151 "disjunctiveMatchStatements": [ 152 { # DisjunctiveMatchStatement that OR's all contained filters. 153 "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. 154 { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. 155 "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. 156 "filter": "A String", # Dimension the filter is applied to. 157 "match": "A String", # Indicates how the filter should be matched to the value. 158 "values": [ # Value to filter on. 159 "A String", 160 ], 161 }, 162 }, 163 ], 164 }, 165 ], 166 "name": "A String", # Rule name. 167 }, 168 ], 169 }, 170 "pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report. 171 { # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. 172 "eventFilters": [ # Filter on an event to be applied to some part of the path. 173 { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. 174 "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. 175 "filter": "A String", # Dimension the filter is applied to. 176 "match": "A String", # Indicates how the filter should be matched to the value. 177 "values": [ # Value to filter on. 178 "A String", 179 ], 180 }, 181 }, 182 ], 183 "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). 184 }, 185 ], 186 }, 187 }, 188 "type": "A String", # Report type. 189 }, 190 "queryId": "A String", # Query ID. 191 "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. 192 "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. 193 "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. 194 "endTimeMs": "A String", # Datetime to periodically run the query until. 195 "frequency": "A String", # How often the query is run. 196 "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. 197 "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York. 198 "startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency. 199 }, 200 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. 201} 202 203 asynchronous: boolean, If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME. 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { # Represents a query. 213 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". 214 "metadata": { # Query metadata. # Query metadata. 215 "dataRange": "A String", # Range of report data. 216 "format": "A String", # Format of the generated report. 217 "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored. 218 "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report. 219 "latestReportRunTimeMs": "A String", # The time when the latest report started to run. 220 "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. 221 "reportCount": 42, # Number of reports that have been generated for the query. 222 "running": True or False, # Whether the latest report is currently running. 223 "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false. 224 "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. 225 "A String", 226 ], 227 "title": "A String", # Query title. It is used to name the reports generated from this query. 228 }, 229 "params": { # Parameters of a query or report. # Query parameters. 230 "filters": [ # Filters used to match traffic data in your report. 231 { # Filter used to match traffic data in your report. 232 "type": "A String", # Filter type. 233 "value": "A String", # Filter value. 234 }, 235 ], 236 "groupBys": [ # Data is grouped by the filters listed in this field. 237 "A String", 238 ], 239 "includeInviteData": True or False, # Deprecated. This field is no longer in use. 240 "metrics": [ # Metrics to include as columns in your report. 241 "A String", 242 ], 243 "options": { # Additional query options. # Additional query options. 244 "includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items. 245 "pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings. 246 "channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings. 247 "fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping. 248 "name": "A String", # Channel Grouping name. 249 "rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping. 250 { # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied. 251 "disjunctiveMatchStatements": [ 252 { # DisjunctiveMatchStatement that OR's all contained filters. 253 "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. 254 { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. 255 "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. 256 "filter": "A String", # Dimension the filter is applied to. 257 "match": "A String", # Indicates how the filter should be matched to the value. 258 "values": [ # Value to filter on. 259 "A String", 260 ], 261 }, 262 }, 263 ], 264 }, 265 ], 266 "name": "A String", # Rule name. 267 }, 268 ], 269 }, 270 "pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report. 271 { # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. 272 "eventFilters": [ # Filter on an event to be applied to some part of the path. 273 { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. 274 "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. 275 "filter": "A String", # Dimension the filter is applied to. 276 "match": "A String", # Indicates how the filter should be matched to the value. 277 "values": [ # Value to filter on. 278 "A String", 279 ], 280 }, 281 }, 282 ], 283 "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). 284 }, 285 ], 286 }, 287 }, 288 "type": "A String", # Report type. 289 }, 290 "queryId": "A String", # Query ID. 291 "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. 292 "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. 293 "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. 294 "endTimeMs": "A String", # Datetime to periodically run the query until. 295 "frequency": "A String", # How often the query is run. 296 "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. 297 "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York. 298 "startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency. 299 }, 300 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. 301}</pre> 302</div> 303 304<div class="method"> 305 <code class="details" id="deletequery">deletequery(queryId, x__xgafv=None)</code> 306 <pre>Deletes a stored query as well as the associated stored reports. 307 308Args: 309 queryId: string, Query ID to delete. (required) 310 x__xgafv: string, V1 error format. 311 Allowed values 312 1 - v1 error format 313 2 - v2 error format 314</pre> 315</div> 316 317<div class="method"> 318 <code class="details" id="getquery">getquery(queryId, x__xgafv=None)</code> 319 <pre>Retrieves a stored query. 320 321Args: 322 queryId: string, Query ID to retrieve. (required) 323 x__xgafv: string, V1 error format. 324 Allowed values 325 1 - v1 error format 326 2 - v2 error format 327 328Returns: 329 An object of the form: 330 331 { # Represents a query. 332 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". 333 "metadata": { # Query metadata. # Query metadata. 334 "dataRange": "A String", # Range of report data. 335 "format": "A String", # Format of the generated report. 336 "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored. 337 "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report. 338 "latestReportRunTimeMs": "A String", # The time when the latest report started to run. 339 "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. 340 "reportCount": 42, # Number of reports that have been generated for the query. 341 "running": True or False, # Whether the latest report is currently running. 342 "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false. 343 "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. 344 "A String", 345 ], 346 "title": "A String", # Query title. It is used to name the reports generated from this query. 347 }, 348 "params": { # Parameters of a query or report. # Query parameters. 349 "filters": [ # Filters used to match traffic data in your report. 350 { # Filter used to match traffic data in your report. 351 "type": "A String", # Filter type. 352 "value": "A String", # Filter value. 353 }, 354 ], 355 "groupBys": [ # Data is grouped by the filters listed in this field. 356 "A String", 357 ], 358 "includeInviteData": True or False, # Deprecated. This field is no longer in use. 359 "metrics": [ # Metrics to include as columns in your report. 360 "A String", 361 ], 362 "options": { # Additional query options. # Additional query options. 363 "includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items. 364 "pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings. 365 "channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings. 366 "fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping. 367 "name": "A String", # Channel Grouping name. 368 "rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping. 369 { # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied. 370 "disjunctiveMatchStatements": [ 371 { # DisjunctiveMatchStatement that OR's all contained filters. 372 "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. 373 { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. 374 "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. 375 "filter": "A String", # Dimension the filter is applied to. 376 "match": "A String", # Indicates how the filter should be matched to the value. 377 "values": [ # Value to filter on. 378 "A String", 379 ], 380 }, 381 }, 382 ], 383 }, 384 ], 385 "name": "A String", # Rule name. 386 }, 387 ], 388 }, 389 "pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report. 390 { # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. 391 "eventFilters": [ # Filter on an event to be applied to some part of the path. 392 { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. 393 "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. 394 "filter": "A String", # Dimension the filter is applied to. 395 "match": "A String", # Indicates how the filter should be matched to the value. 396 "values": [ # Value to filter on. 397 "A String", 398 ], 399 }, 400 }, 401 ], 402 "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). 403 }, 404 ], 405 }, 406 }, 407 "type": "A String", # Report type. 408 }, 409 "queryId": "A String", # Query ID. 410 "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. 411 "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. 412 "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. 413 "endTimeMs": "A String", # Datetime to periodically run the query until. 414 "frequency": "A String", # How often the query is run. 415 "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. 416 "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York. 417 "startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency. 418 }, 419 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. 420}</pre> 421</div> 422 423<div class="method"> 424 <code class="details" id="listqueries">listqueries(pageSize=None, pageToken=None, x__xgafv=None)</code> 425 <pre>Retrieves stored queries. 426 427Args: 428 pageSize: integer, Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified. 429 pageToken: string, Optional pagination token. 430 x__xgafv: string, V1 error format. 431 Allowed values 432 1 - v1 error format 433 2 - v2 error format 434 435Returns: 436 An object of the form: 437 438 { # List queries response. 439 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listQueriesResponse". 440 "nextPageToken": "A String", # Next page's pagination token if one exists. 441 "queries": [ # Retrieved queries. 442 { # Represents a query. 443 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#query". 444 "metadata": { # Query metadata. # Query metadata. 445 "dataRange": "A String", # Range of report data. 446 "format": "A String", # Format of the generated report. 447 "googleCloudStoragePathForLatestReport": "A String", # The path to the location in Google Cloud Storage where the latest report is stored. 448 "googleDrivePathForLatestReport": "A String", # The path in Google Drive for the latest report. 449 "latestReportRunTimeMs": "A String", # The time when the latest report started to run. 450 "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. 451 "reportCount": 42, # Number of reports that have been generated for the query. 452 "running": True or False, # Whether the latest report is currently running. 453 "sendNotification": True or False, # Whether to send an email notification when a report is ready. Default to false. 454 "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from sendNotification. 455 "A String", 456 ], 457 "title": "A String", # Query title. It is used to name the reports generated from this query. 458 }, 459 "params": { # Parameters of a query or report. # Query parameters. 460 "filters": [ # Filters used to match traffic data in your report. 461 { # Filter used to match traffic data in your report. 462 "type": "A String", # Filter type. 463 "value": "A String", # Filter value. 464 }, 465 ], 466 "groupBys": [ # Data is grouped by the filters listed in this field. 467 "A String", 468 ], 469 "includeInviteData": True or False, # Deprecated. This field is no longer in use. 470 "metrics": [ # Metrics to include as columns in your report. 471 "A String", 472 ], 473 "options": { # Additional query options. # Additional query options. 474 "includeOnlyTargetedUserLists": True or False, # Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items. 475 "pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings. 476 "channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings. 477 "fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping. 478 "name": "A String", # Channel Grouping name. 479 "rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping. 480 { # A Rule defines a name, and a boolean expression in [conjunctive normal form](http: //mathworld.wolfram.com/ConjunctiveNormalForm.html){.external} that can be // applied to a path event to determine if that name should be applied. 481 "disjunctiveMatchStatements": [ 482 { # DisjunctiveMatchStatement that OR's all contained filters. 483 "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. 484 { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. 485 "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. 486 "filter": "A String", # Dimension the filter is applied to. 487 "match": "A String", # Indicates how the filter should be matched to the value. 488 "values": [ # Value to filter on. 489 "A String", 490 ], 491 }, 492 }, 493 ], 494 }, 495 ], 496 "name": "A String", # Rule name. 497 }, 498 ], 499 }, 500 "pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report. 501 { # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. 502 "eventFilters": [ # Filter on an event to be applied to some part of the path. 503 { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. 504 "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. 505 "filter": "A String", # Dimension the filter is applied to. 506 "match": "A String", # Indicates how the filter should be matched to the value. 507 "values": [ # Value to filter on. 508 "A String", 509 ], 510 }, 511 }, 512 ], 513 "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). 514 }, 515 ], 516 }, 517 }, 518 "type": "A String", # Report type. 519 }, 520 "queryId": "A String", # Query ID. 521 "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. 522 "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. 523 "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. 524 "endTimeMs": "A String", # Datetime to periodically run the query until. 525 "frequency": "A String", # How often the query is run. 526 "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. 527 "nextRunTimezoneCode": "A String", # Canonical timezone code for report generation time. Defaults to America/New_York. 528 "startTimeMs": "A String", # When to start running the query. Not applicable to `ONE_TIME` frequency. 529 }, 530 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. 531 }, 532 ], 533}</pre> 534</div> 535 536<div class="method"> 537 <code class="details" id="listqueries_next">listqueries_next(previous_request, previous_response)</code> 538 <pre>Retrieves the next page of results. 539 540Args: 541 previous_request: The request for the previous page. (required) 542 previous_response: The response from the request for the previous page. (required) 543 544Returns: 545 A request object that you can call 'execute()' on to request the next 546 page. Returns None if there are no more items in the collection. 547 </pre> 548</div> 549 550<div class="method"> 551 <code class="details" id="runquery">runquery(queryId, asynchronous=None, body=None, x__xgafv=None)</code> 552 <pre>Runs a stored query to generate a report. 553 554Args: 555 queryId: string, Query ID to run. (required) 556 body: object, The request body. 557 The object takes the form of: 558 559{ # Request to run a stored query to generate a report. 560 "dataRange": "A String", # Report data range used to generate the report. 561 "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. 562 "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. 563 "timezoneCode": "A String", # Canonical timezone code for report data time. Defaults to America/New_York. 564} 565 566 asynchronous: boolean, If true, tries to run the query asynchronously. 567 x__xgafv: string, V1 error format. 568 Allowed values 569 1 - v1 error format 570 2 - v2 error format 571</pre> 572</div> 573 574</body></html>