1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="doubleclickbidmanager_v1_1.html">DoubleClick Bid Manager API</a> . <a href="doubleclickbidmanager_v1_1.reports.html">reports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#listreports">listreports(queryId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves stored reports.</p>
<p class="toc_element">
<code><a href="#listreports_next">listreports_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="listreports">listreports(queryId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieves stored reports.
Args:
queryId: string, Query ID with which the reports are associated. (required)
pageSize: integer, Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
pageToken: string, Optional pagination token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # List reports response.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "doubleclickbidmanager#listReportsResponse".
"nextPageToken": "A String", # Next page's pagination token if one exists.
"reports": [ # Retrieved reports.
{ # Represents a report.
"key": { # Key used to identify a report. # Key used to identify a report.
"queryId": "A String", # Query ID.
"reportId": "A String", # Report ID.
},
"metadata": { # Report metadata. # Report metadata.
"googleCloudStoragePath": "A String", # The path to the location in Google Cloud Storage where the report is stored.
"reportDataEndTimeMs": "A String", # The ending time for the data that is shown in the report.
"reportDataStartTimeMs": "A String", # The starting time for the data that is shown in the report.
"status": { # Report status. # Report status.
"failure": { # An explanation of a report failure. # If the report failed, this records the cause.
"errorCode": "A String", # Error code that shows why the report was not created.
},
"finishTimeMs": "A String", # The time when this report either completed successfully or failed.
"format": "A String", # The file type of the report.
"state": "A String", # The state of the report.
},
},
"params": { # Parameters of a query or report. # Report parameters.
"filters": [ # Filters used to match traffic data in your report.
{ # Filter used to match traffic data in your report.
"type": "A String", # Filter type.
"value": "A String", # Filter value.
},
],
"groupBys": [ # Data is grouped by the filters listed in this field.
"A String",
],
"includeInviteData": True or False, # Deprecated. This field is no longer in use.
"metrics": [ # Metrics to include as columns in your report.
"A String",
],
"options": { # Additional query options. # Additional query options.
"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.
"pathQueryOptions": { # Path Query Options for Report Options. # Options that contain Path Filters and Custom Channel Groupings.
"channelGrouping": { # A channel grouping defines a set of rules that can be used to categorize events in a path report. # Custom Channel Groupings.
"fallbackName": "A String", # The name to apply to an event that does not match any of the rules in the channel grouping.
"name": "A String", # Channel Grouping name.
"rules": [ # Rules within Channel Grouping. There is a limit of 100 rules that can be set per channel grouping.
{ # 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.
"disjunctiveMatchStatements": [
{ # DisjunctiveMatchStatement that OR's all contained filters.
"eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
},
],
"name": "A String", # Rule name.
},
],
},
"pathFilters": [ # Path Filters. There is a limit of 100 path filters that can be set per report.
{ # 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.
"eventFilters": [ # Filter on an event to be applied to some part of the path.
{ # Defines the type of filter to be applied to the path, a DV360 event dimension filter.
"dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension.
"filter": "A String", # Dimension the filter is applied to.
"match": "A String", # Indicates how the filter should be matched to the value.
"values": [ # Value to filter on.
"A String",
],
},
},
],
"pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path).
},
],
},
},
"type": "A String", # Report type.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="listreports_next">listreports_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
