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
|
<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="dfareporting_v3_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_2.reports.html">reports</a> . <a href="dfareporting_v3_2.reports.files.html">files</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(profileId, reportId, fileId)</a></code></p>
<p class="firstline">Retrieves a report file. This method supports media download.</p>
<p class="toc_element">
<code><a href="#get_media">get_media(profileId, reportId, fileId)</a></code></p>
<p class="firstline">Retrieves a report file. This method supports media download.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</a></code></p>
<p class="firstline">Lists files for a report.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(profileId, reportId, fileId)</code>
<pre>Retrieves a report file. This method supports media download.
Args:
profileId: string, The DFA profile ID. (required)
reportId: string, The ID of the report. (required)
fileId: string, The ID of the report file. (required)
Returns:
An object of the form:
{ # Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
"status": "A String", # The status of the report file.
"kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
"format": "A String", # The output format of the report. Only available once the file is available.
"dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"fileName": "A String", # The filename of the file.
"etag": "A String", # The eTag of this response for caching purposes.
"reportId": "A String", # The ID of the report this file was generated from.
"urls": { # The URLs where the completed report file can be downloaded.
"browserUrl": "A String", # The URL for downloading the report data through a browser.
"apiUrl": "A String", # The URL for downloading the report data through the API.
},
"lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
"id": "A String", # The unique ID of this report file.
}</pre>
</div>
<div class="method">
<code class="details" id="get_media">get_media(profileId, reportId, fileId)</code>
<pre>Retrieves a report file. This method supports media download.
Args:
profileId: string, The DFA profile ID. (required)
reportId: string, The ID of the report. (required)
fileId: string, The ID of the report file. (required)
Returns:
The media object as a string.
</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</code>
<pre>Lists files for a report.
Args:
profileId: string, The DFA profile ID. (required)
reportId: string, The ID of the parent report. (required)
pageToken: string, The value of the nextToken from the previous result page.
sortField: string, The field by which to sort the list.
Allowed values
ID - Sort by file ID.
LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
maxResults: integer, Maximum number of results to return.
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
Returns:
An object of the form:
{ # Represents the list of File resources.
"nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
"items": [ # The files returned in this response.
{ # Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
"status": "A String", # The status of the report file.
"kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
"format": "A String", # The output format of the report. Only available once the file is available.
"dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
"relativeDateRange": "A String", # The date range relative to the date of when the report is run.
},
"fileName": "A String", # The filename of the file.
"etag": "A String", # The eTag of this response for caching purposes.
"reportId": "A String", # The ID of the report this file was generated from.
"urls": { # The URLs where the completed report file can be downloaded.
"browserUrl": "A String", # The URL for downloading the report data through a browser.
"apiUrl": "A String", # The URL for downloading the report data through the API.
},
"lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
"id": "A String", # The unique ID of this report file.
},
],
"kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
"etag": "A String", # The eTag of this response for caching purposes.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
