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="dfareporting_v3_3.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_3.reports.html">reports</a> . <a href="dfareporting_v3_3.reports.files.html">files</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(profileId, reportId, fileId)</a></code></p>
79<p class="firstline">Retrieves a report file. This method supports media download.</p>
80<p class="toc_element">
81  <code><a href="#get_media">get_media(profileId, reportId, fileId)</a></code></p>
82<p class="firstline">Retrieves a report file. This method supports media download.</p>
83<p class="toc_element">
84  <code><a href="#list">list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</a></code></p>
85<p class="firstline">Lists files for a report.</p>
86<p class="toc_element">
87  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="get">get(profileId, reportId, fileId)</code>
92  <pre>Retrieves a report file. This method supports media download.
93
94Args:
95  profileId: string, The DFA profile ID. (required)
96  reportId: string, The ID of the report. (required)
97  fileId: string, The ID of the report file. (required)
98
99Returns:
100  An object of the form:
101
102    { # 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".
103    "status": "A String", # The status of the report file.
104    "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
105    "format": "A String", # The output format of the report. Only available once the file is available.
106    "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.
107      "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
108      "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
109      "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
110      "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
111    },
112    "fileName": "A String", # The filename of the file.
113    "etag": "A String", # The eTag of this response for caching purposes.
114    "reportId": "A String", # The ID of the report this file was generated from.
115    "urls": { # The URLs where the completed report file can be downloaded.
116      "browserUrl": "A String", # The URL for downloading the report data through a browser.
117      "apiUrl": "A String", # The URL for downloading the report data through the API.
118    },
119    "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
120    "id": "A String", # The unique ID of this report file.
121  }</pre>
122</div>
123
124<div class="method">
125    <code class="details" id="get_media">get_media(profileId, reportId, fileId)</code>
126  <pre>Retrieves a report file. This method supports media download.
127
128Args:
129  profileId: string, The DFA profile ID. (required)
130  reportId: string, The ID of the report. (required)
131  fileId: string, The ID of the report file. (required)
132
133Returns:
134  The media object as a string.
135
136    </pre>
137</div>
138
139<div class="method">
140    <code class="details" id="list">list(profileId, reportId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)</code>
141  <pre>Lists files for a report.
142
143Args:
144  profileId: string, The DFA profile ID. (required)
145  reportId: string, The ID of the parent report. (required)
146  pageToken: string, The value of the nextToken from the previous result page.
147  sortField: string, The field by which to sort the list.
148    Allowed values
149      ID - Sort by file ID.
150      LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
151  maxResults: integer, Maximum number of results to return.
152  sortOrder: string, Order of sorted results.
153    Allowed values
154      ASCENDING - Ascending order.
155      DESCENDING - Descending order.
156
157Returns:
158  An object of the form:
159
160    { # Represents the list of File resources.
161    "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.
162    "items": [ # The files returned in this response.
163      { # 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".
164        "status": "A String", # The status of the report file.
165        "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
166        "format": "A String", # The output format of the report. Only available once the file is available.
167        "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.
168          "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
169          "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
170          "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
171          "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
172        },
173        "fileName": "A String", # The filename of the file.
174        "etag": "A String", # The eTag of this response for caching purposes.
175        "reportId": "A String", # The ID of the report this file was generated from.
176        "urls": { # The URLs where the completed report file can be downloaded.
177          "browserUrl": "A String", # The URL for downloading the report data through a browser.
178          "apiUrl": "A String", # The URL for downloading the report data through the API.
179        },
180        "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
181        "id": "A String", # The unique ID of this report file.
182      },
183    ],
184    "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
185    "etag": "A String", # The eTag of this response for caching purposes.
186  }</pre>
187</div>
188
189<div class="method">
190    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
191  <pre>Retrieves the next page of results.
192
193Args:
194  previous_request: The request for the previous page. (required)
195  previous_response: The response from the request for the previous page. (required)
196
197Returns:
198  A request object that you can call 'execute()' on to request the next
199  page. Returns None if there are no more items in the collection.
200    </pre>
201</div>
202
203</body></html>