| 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_v2.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v2.queries.html">queries</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="doubleclickbidmanager_v2.queries.reports.html">reports()</a></code> |
| 79 |
</p> |
| 80 |
<p class="firstline">Returns the reports Resource.</p> |
| 81 |
|
| 82 |
<p class="toc_element"> |
| 83 |
<code><a href="#close">close()</a></code></p> |
| 84 |
<p class="firstline">Close httplib2 connections.</p> |
| 85 |
<p class="toc_element"> |
| 86 |
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> |
| 87 |
<p class="firstline">Creates a new query.</p> |
| 88 |
<p class="toc_element"> |
| 89 |
<code><a href="#delete">delete(queryId, x__xgafv=None)</a></code></p> |
| 90 |
<p class="firstline">Deletes an existing query as well as its generated reports.</p> |
| 91 |
<p class="toc_element"> |
| 92 |
<code><a href="#get">get(queryId, x__xgafv=None)</a></code></p> |
| 93 |
<p class="firstline">Retrieves a query.</p> |
| 94 |
<p class="toc_element"> |
| 95 |
<code><a href="#list">list(orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 96 |
<p class="firstline">Lists queries created by the current user.</p> |
| 97 |
<p class="toc_element"> |
| 98 |
<code><a href="#list_next">list_next()</a></code></p> |
| 99 |
<p class="firstline">Retrieves the next page of results.</p> |
| 100 |
<p class="toc_element"> |
| 101 |
<code><a href="#run">run(queryId, body=None, synchronous=None, x__xgafv=None)</a></code></p> |
| 102 |
<p class="firstline">Runs an existing query to generate a report.</p> |
| 103 |
<h3>Method Details</h3> |
| 104 |
<div class="method"> |
| 105 |
<code class="details" id="close">close()</code> |
| 106 |
<pre>Close httplib2 connections.</pre> |
| 107 |
</div> |
| 108 |
|
| 109 |
<div class="method"> |
| 110 |
<code class="details" id="create">create(body=None, x__xgafv=None)</code> |
| 111 |
<pre>Creates a new query. |
| 112 |
|
| 113 |
Args: |
| 114 |
body: object, The request body. |
| 115 |
The object takes the form of: |
| 116 |
|
| 117 |
{ # A single query used to generate a report. |
| 118 |
"metadata": { # The metadata of the query. # The metadata of the query. |
| 119 |
"dataRange": { # The date range to be reported on. # The date range the report generated by the query will report on. This date range will be defined by the time zone as used by the advertiser. |
| 120 |
"customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the end date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 121 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 122 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 123 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 124 |
}, |
| 125 |
"customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the starting date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 126 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 127 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 128 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 129 |
}, |
| 130 |
"range": "A String", # The preset date range to be reported on. If `CUSTOM_DATES` is assigned to this field, fields custom_start_date and custom_end_date must be set to specify the custom date range. |
| 131 |
}, |
| 132 |
"format": "A String", # The format of the report generated by the query. |
| 133 |
"sendNotification": True or False, # Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is `false` by default. |
| 134 |
"shareEmailAddress": [ # List of additional email addresses with which to share the query. If send_notification is `true`, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface. |
| 135 |
"A String", |
| 136 |
], |
| 137 |
"title": "A String", # The display name of the query. This value will be used in the file name of reports generated by the query. |
| 138 |
}, |
| 139 |
"params": { # Parameters of a generated report. # The parameters of the report generated by the query. |
| 140 |
"filters": [ # Filters to limit the scope of reported data. |
| 141 |
{ # Represents a single filter rule. |
| 142 |
"type": "A String", # The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value. |
| 143 |
"value": "A String", # The identifying value to filter by, such as a relevant resource ID. |
| 144 |
}, |
| 145 |
], |
| 146 |
"groupBys": [ # Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values. |
| 147 |
"A String", |
| 148 |
], |
| 149 |
"metrics": [ # Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values. |
| 150 |
"A String", |
| 151 |
], |
| 152 |
"options": { # Report parameter options. # Additional report parameter options. |
| 153 |
"includeOnlyTargetedUserLists": True or False, # Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters. |
| 154 |
}, |
| 155 |
"type": "A String", # The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used. |
| 156 |
}, |
| 157 |
"queryId": "A String", # Output only. The unique ID of the query. |
| 158 |
"schedule": { # Settings on when and how frequently to run a query. # When and how often the query is scheduled to run. If the frequency field is set to `ONE_TIME`, the query will only run when queries.run is called. |
| 159 |
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date on which to end the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. |
| 160 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 161 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 162 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 163 |
}, |
| 164 |
"frequency": "A String", # How frequently to run the query. If set to `ONE_TIME`, the query will only be run when queries.run is called. |
| 165 |
"nextRunTimezoneCode": "A String", # The canonical code for the timezone the query schedule is based on. Scheduled runs are usually conducted in the morning of a given day. Defaults to `America/New_York`. |
| 166 |
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date on which to begin the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. |
| 167 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 168 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 169 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 170 |
}, |
| 171 |
}, |
| 172 |
} |
| 173 |
|
| 174 |
x__xgafv: string, V1 error format. |
| 175 |
Allowed values |
| 176 |
1 - v1 error format |
| 177 |
2 - v2 error format |
| 178 |
|
| 179 |
Returns: |
| 180 |
An object of the form: |
| 181 |
|
| 182 |
{ # A single query used to generate a report. |
| 183 |
"metadata": { # The metadata of the query. # The metadata of the query. |
| 184 |
"dataRange": { # The date range to be reported on. # The date range the report generated by the query will report on. This date range will be defined by the time zone as used by the advertiser. |
| 185 |
"customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the end date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 186 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 187 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 188 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 189 |
}, |
| 190 |
"customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the starting date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 191 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 192 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 193 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 194 |
}, |
| 195 |
"range": "A String", # The preset date range to be reported on. If `CUSTOM_DATES` is assigned to this field, fields custom_start_date and custom_end_date must be set to specify the custom date range. |
| 196 |
}, |
| 197 |
"format": "A String", # The format of the report generated by the query. |
| 198 |
"sendNotification": True or False, # Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is `false` by default. |
| 199 |
"shareEmailAddress": [ # List of additional email addresses with which to share the query. If send_notification is `true`, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface. |
| 200 |
"A String", |
| 201 |
], |
| 202 |
"title": "A String", # The display name of the query. This value will be used in the file name of reports generated by the query. |
| 203 |
}, |
| 204 |
"params": { # Parameters of a generated report. # The parameters of the report generated by the query. |
| 205 |
"filters": [ # Filters to limit the scope of reported data. |
| 206 |
{ # Represents a single filter rule. |
| 207 |
"type": "A String", # The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value. |
| 208 |
"value": "A String", # The identifying value to filter by, such as a relevant resource ID. |
| 209 |
}, |
| 210 |
], |
| 211 |
"groupBys": [ # Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values. |
| 212 |
"A String", |
| 213 |
], |
| 214 |
"metrics": [ # Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values. |
| 215 |
"A String", |
| 216 |
], |
| 217 |
"options": { # Report parameter options. # Additional report parameter options. |
| 218 |
"includeOnlyTargetedUserLists": True or False, # Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters. |
| 219 |
}, |
| 220 |
"type": "A String", # The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used. |
| 221 |
}, |
| 222 |
"queryId": "A String", # Output only. The unique ID of the query. |
| 223 |
"schedule": { # Settings on when and how frequently to run a query. # When and how often the query is scheduled to run. If the frequency field is set to `ONE_TIME`, the query will only run when queries.run is called. |
| 224 |
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date on which to end the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. |
| 225 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 226 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 227 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 228 |
}, |
| 229 |
"frequency": "A String", # How frequently to run the query. If set to `ONE_TIME`, the query will only be run when queries.run is called. |
| 230 |
"nextRunTimezoneCode": "A String", # The canonical code for the timezone the query schedule is based on. Scheduled runs are usually conducted in the morning of a given day. Defaults to `America/New_York`. |
| 231 |
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date on which to begin the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. |
| 232 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 233 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 234 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 235 |
}, |
| 236 |
}, |
| 237 |
}</pre> |
| 238 |
</div> |
| 239 |
|
| 240 |
<div class="method"> |
| 241 |
<code class="details" id="delete">delete(queryId, x__xgafv=None)</code> |
| 242 |
<pre>Deletes an existing query as well as its generated reports. |
| 243 |
|
| 244 |
Args: |
| 245 |
queryId: string, Required. The ID of the query to delete. (required) |
| 246 |
x__xgafv: string, V1 error format. |
| 247 |
Allowed values |
| 248 |
1 - v1 error format |
| 249 |
2 - v2 error format |
| 250 |
</pre> |
| 251 |
</div> |
| 252 |
|
| 253 |
<div class="method"> |
| 254 |
<code class="details" id="get">get(queryId, x__xgafv=None)</code> |
| 255 |
<pre>Retrieves a query. |
| 256 |
|
| 257 |
Args: |
| 258 |
queryId: string, Required. The ID of the query to retrieve. (required) |
| 259 |
x__xgafv: string, V1 error format. |
| 260 |
Allowed values |
| 261 |
1 - v1 error format |
| 262 |
2 - v2 error format |
| 263 |
|
| 264 |
Returns: |
| 265 |
An object of the form: |
| 266 |
|
| 267 |
{ # A single query used to generate a report. |
| 268 |
"metadata": { # The metadata of the query. # The metadata of the query. |
| 269 |
"dataRange": { # The date range to be reported on. # The date range the report generated by the query will report on. This date range will be defined by the time zone as used by the advertiser. |
| 270 |
"customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the end date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 271 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 272 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 273 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 274 |
}, |
| 275 |
"customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the starting date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 276 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 277 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 278 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 279 |
}, |
| 280 |
"range": "A String", # The preset date range to be reported on. If `CUSTOM_DATES` is assigned to this field, fields custom_start_date and custom_end_date must be set to specify the custom date range. |
| 281 |
}, |
| 282 |
"format": "A String", # The format of the report generated by the query. |
| 283 |
"sendNotification": True or False, # Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is `false` by default. |
| 284 |
"shareEmailAddress": [ # List of additional email addresses with which to share the query. If send_notification is `true`, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface. |
| 285 |
"A String", |
| 286 |
], |
| 287 |
"title": "A String", # The display name of the query. This value will be used in the file name of reports generated by the query. |
| 288 |
}, |
| 289 |
"params": { # Parameters of a generated report. # The parameters of the report generated by the query. |
| 290 |
"filters": [ # Filters to limit the scope of reported data. |
| 291 |
{ # Represents a single filter rule. |
| 292 |
"type": "A String", # The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value. |
| 293 |
"value": "A String", # The identifying value to filter by, such as a relevant resource ID. |
| 294 |
}, |
| 295 |
], |
| 296 |
"groupBys": [ # Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values. |
| 297 |
"A String", |
| 298 |
], |
| 299 |
"metrics": [ # Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values. |
| 300 |
"A String", |
| 301 |
], |
| 302 |
"options": { # Report parameter options. # Additional report parameter options. |
| 303 |
"includeOnlyTargetedUserLists": True or False, # Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters. |
| 304 |
}, |
| 305 |
"type": "A String", # The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used. |
| 306 |
}, |
| 307 |
"queryId": "A String", # Output only. The unique ID of the query. |
| 308 |
"schedule": { # Settings on when and how frequently to run a query. # When and how often the query is scheduled to run. If the frequency field is set to `ONE_TIME`, the query will only run when queries.run is called. |
| 309 |
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date on which to end the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. |
| 310 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 311 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 312 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 313 |
}, |
| 314 |
"frequency": "A String", # How frequently to run the query. If set to `ONE_TIME`, the query will only be run when queries.run is called. |
| 315 |
"nextRunTimezoneCode": "A String", # The canonical code for the timezone the query schedule is based on. Scheduled runs are usually conducted in the morning of a given day. Defaults to `America/New_York`. |
| 316 |
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date on which to begin the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. |
| 317 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 318 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 319 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 320 |
}, |
| 321 |
}, |
| 322 |
}</pre> |
| 323 |
</div> |
| 324 |
|
| 325 |
<div class="method"> |
| 326 |
<code class="details" id="list">list(orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 327 |
<pre>Lists queries created by the current user. |
| 328 |
|
| 329 |
Args: |
| 330 |
orderBy: string, Field to sort the list by. Accepts the following values: * `queryId` (default) * `metadata.title` The default sorting order is ascending. To specify descending order for a field, add the suffix `desc` to the field name. For example, `queryId desc`. |
| 331 |
pageSize: integer, Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified. |
| 332 |
pageToken: string, A token identifying which page of results the server should return. Typically, this is the value of nextPageToken, returned from the previous call to the `queries.list` method. If unspecified, the first page of results is returned. |
| 333 |
x__xgafv: string, V1 error format. |
| 334 |
Allowed values |
| 335 |
1 - v1 error format |
| 336 |
2 - v2 error format |
| 337 |
|
| 338 |
Returns: |
| 339 |
An object of the form: |
| 340 |
|
| 341 |
{ |
| 342 |
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `queries.list` method to retrieve the next page of results. |
| 343 |
"queries": [ # The list of queries. This field will be absent if empty. |
| 344 |
{ # A single query used to generate a report. |
| 345 |
"metadata": { # The metadata of the query. # The metadata of the query. |
| 346 |
"dataRange": { # The date range to be reported on. # The date range the report generated by the query will report on. This date range will be defined by the time zone as used by the advertiser. |
| 347 |
"customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the end date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 348 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 349 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 350 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 351 |
}, |
| 352 |
"customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the starting date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 353 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 354 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 355 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 356 |
}, |
| 357 |
"range": "A String", # The preset date range to be reported on. If `CUSTOM_DATES` is assigned to this field, fields custom_start_date and custom_end_date must be set to specify the custom date range. |
| 358 |
}, |
| 359 |
"format": "A String", # The format of the report generated by the query. |
| 360 |
"sendNotification": True or False, # Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is `false` by default. |
| 361 |
"shareEmailAddress": [ # List of additional email addresses with which to share the query. If send_notification is `true`, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface. |
| 362 |
"A String", |
| 363 |
], |
| 364 |
"title": "A String", # The display name of the query. This value will be used in the file name of reports generated by the query. |
| 365 |
}, |
| 366 |
"params": { # Parameters of a generated report. # The parameters of the report generated by the query. |
| 367 |
"filters": [ # Filters to limit the scope of reported data. |
| 368 |
{ # Represents a single filter rule. |
| 369 |
"type": "A String", # The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value. |
| 370 |
"value": "A String", # The identifying value to filter by, such as a relevant resource ID. |
| 371 |
}, |
| 372 |
], |
| 373 |
"groupBys": [ # Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values. |
| 374 |
"A String", |
| 375 |
], |
| 376 |
"metrics": [ # Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values. |
| 377 |
"A String", |
| 378 |
], |
| 379 |
"options": { # Report parameter options. # Additional report parameter options. |
| 380 |
"includeOnlyTargetedUserLists": True or False, # Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters. |
| 381 |
}, |
| 382 |
"type": "A String", # The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used. |
| 383 |
}, |
| 384 |
"queryId": "A String", # Output only. The unique ID of the query. |
| 385 |
"schedule": { # Settings on when and how frequently to run a query. # When and how often the query is scheduled to run. If the frequency field is set to `ONE_TIME`, the query will only run when queries.run is called. |
| 386 |
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date on which to end the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. |
| 387 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 388 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 389 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 390 |
}, |
| 391 |
"frequency": "A String", # How frequently to run the query. If set to `ONE_TIME`, the query will only be run when queries.run is called. |
| 392 |
"nextRunTimezoneCode": "A String", # The canonical code for the timezone the query schedule is based on. Scheduled runs are usually conducted in the morning of a given day. Defaults to `America/New_York`. |
| 393 |
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The date on which to begin the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. |
| 394 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 395 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 396 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 397 |
}, |
| 398 |
}, |
| 399 |
}, |
| 400 |
], |
| 401 |
}</pre> |
| 402 |
</div> |
| 403 |
|
| 404 |
<div class="method"> |
| 405 |
<code class="details" id="list_next">list_next()</code> |
| 406 |
<pre>Retrieves the next page of results. |
| 407 |
|
| 408 |
Args: |
| 409 |
previous_request: The request for the previous page. (required) |
| 410 |
previous_response: The response from the request for the previous page. (required) |
| 411 |
|
| 412 |
Returns: |
| 413 |
A request object that you can call 'execute()' on to request the next |
| 414 |
page. Returns None if there are no more items in the collection. |
| 415 |
</pre> |
| 416 |
</div> |
| 417 |
|
| 418 |
<div class="method"> |
| 419 |
<code class="details" id="run">run(queryId, body=None, synchronous=None, x__xgafv=None)</code> |
| 420 |
<pre>Runs an existing query to generate a report. |
| 421 |
|
| 422 |
Args: |
| 423 |
queryId: string, Required. The ID of the query to run. (required) |
| 424 |
body: object, The request body. |
| 425 |
The object takes the form of: |
| 426 |
|
| 427 |
{ # Details specifying how to run a query. |
| 428 |
"dataRange": { # The date range to be reported on. # The date range used by the query to generate the report. If unspecified, the query's original data_range is used. |
| 429 |
"customEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the end date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 430 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 431 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 432 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 433 |
}, |
| 434 |
"customStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # If `CUSTOM_DATES` is assigned to range, this field specifies the starting date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. |
| 435 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 436 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 437 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 438 |
}, |
| 439 |
"range": "A String", # The preset date range to be reported on. If `CUSTOM_DATES` is assigned to this field, fields custom_start_date and custom_end_date must be set to specify the custom date range. |
| 440 |
}, |
| 441 |
} |
| 442 |
|
| 443 |
synchronous: boolean, Whether the query should be run synchronously. When `true`, the request won't return until the resulting report has finished running. This parameter is `false` by default. Setting this parameter to `true` is **not recommended**. |
| 444 |
x__xgafv: string, V1 error format. |
| 445 |
Allowed values |
| 446 |
1 - v1 error format |
| 447 |
2 - v2 error format |
| 448 |
|
| 449 |
Returns: |
| 450 |
An object of the form: |
| 451 |
|
| 452 |
{ # A single report generated by its parent report. |
| 453 |
"key": { # Identifying information of a report. # The key information identifying the report. |
| 454 |
"queryId": "A String", # Output only. The unique ID of the query that generated the report. |
| 455 |
"reportId": "A String", # Output only. The unique ID of the report. |
| 456 |
}, |
| 457 |
"metadata": { # The metadata of a report. # The metadata of the report. |
| 458 |
"googleCloudStoragePath": "A String", # Output only. The location of the generated report file in Google Cloud Storage. This field will be absent if status.state is not `DONE`. |
| 459 |
"reportDataEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The end date of the report data date range. |
| 460 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 461 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 462 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 463 |
}, |
| 464 |
"reportDataStartDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The start date of the report data date range. |
| 465 |
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| 466 |
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| 467 |
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| 468 |
}, |
| 469 |
"status": { # The status of a report. # The status of the report. |
| 470 |
"finishTime": "A String", # Output only. The timestamp of when report generation finished successfully or in failure. This field will not be set unless state is `DONE` or `FAILED`. |
| 471 |
"format": "A String", # The format of the generated report file. |
| 472 |
"state": "A String", # Output only. The state of the report generation. |
| 473 |
}, |
| 474 |
}, |
| 475 |
"params": { # Parameters of a generated report. # The parameters of the report. |
| 476 |
"filters": [ # Filters to limit the scope of reported data. |
| 477 |
{ # Represents a single filter rule. |
| 478 |
"type": "A String", # The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value. |
| 479 |
"value": "A String", # The identifying value to filter by, such as a relevant resource ID. |
| 480 |
}, |
| 481 |
], |
| 482 |
"groupBys": [ # Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values. |
| 483 |
"A String", |
| 484 |
], |
| 485 |
"metrics": [ # Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values. |
| 486 |
"A String", |
| 487 |
], |
| 488 |
"options": { # Report parameter options. # Additional report parameter options. |
| 489 |
"includeOnlyTargetedUserLists": True or False, # Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters. |
| 490 |
}, |
| 491 |
"type": "A String", # The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used. |
| 492 |
}, |
| 493 |
}</pre> |
| 494 |
</div> |
| 495 |
|
| 496 |
</body></html> |