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_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.reports.html">reports</a> . <a href="dfareporting_v3_4.reports.files.html">files</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="#get">get(profileId, reportId, fileId, x__xgafv=None)</a></code></p> 82<p class="firstline">Retrieves a report file by its report ID and file ID. This method supports media download.</p> 83<p class="toc_element"> 84 <code><a href="#get_media">get_media(profileId, reportId, fileId, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a report file by its report ID and file ID. This method supports media download.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(profileId, reportId, maxResults=None, pageToken=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists files for a report.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="get">get(profileId, reportId, fileId, x__xgafv=None)</code> 100 <pre>Retrieves a report file by its report ID and file ID. This method supports media download. 101 102Args: 103 profileId: string, The Campaign Manager 360 user profile ID. (required) 104 reportId: string, The ID of the report. (required) 105 fileId: string, The ID of the report file. (required) 106 x__xgafv: string, V1 error format. 107 Allowed values 108 1 - v1 error format 109 2 - v2 error format 110 111Returns: 112 An object of the form: 113 114 { # 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". 115 "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. 116 "endDate": "A String", 117 "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange. 118 "relativeDateRange": "A String", # The date range relative to the date of when the report is run. 119 "startDate": "A String", 120 }, 121 "etag": "A String", # Etag of this resource. 122 "fileName": "A String", # The filename of the file. 123 "format": "A String", # The output format of the report. Only available once the file is available. 124 "id": "A String", # The unique ID of this report file. 125 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file". 126 "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified. 127 "reportId": "A String", # The ID of the report this file was generated from. 128 "status": "A String", # The status of the report file. 129 "urls": { # The URLs where the completed report file can be downloaded. 130 "apiUrl": "A String", # The URL for downloading the report data through the API. 131 "browserUrl": "A String", # The URL for downloading the report data through a browser. 132 }, 133}</pre> 134</div> 135 136<div class="method"> 137 <code class="details" id="get_media">get_media(profileId, reportId, fileId, x__xgafv=None)</code> 138 <pre>Retrieves a report file by its report ID and file ID. This method supports media download. 139 140Args: 141 profileId: string, The Campaign Manager 360 user profile ID. (required) 142 reportId: string, The ID of the report. (required) 143 fileId: string, The ID of the report file. (required) 144 x__xgafv: string, V1 error format. 145 Allowed values 146 1 - v1 error format 147 2 - v2 error format 148 149Returns: 150 The media object as a string. 151 152 </pre> 153</div> 154 155<div class="method"> 156 <code class="details" id="list">list(profileId, reportId, maxResults=None, pageToken=None, sortField=None, sortOrder=None, x__xgafv=None)</code> 157 <pre>Lists files for a report. 158 159Args: 160 profileId: string, The Campaign Manager 360 user profile ID. (required) 161 reportId: string, The ID of the parent report. (required) 162 maxResults: integer, Maximum number of results to return. 163 pageToken: string, The value of the nextToken from the previous result page. 164 sortField: string, The field by which to sort the list. 165 Allowed values 166 ID - 167 LAST_MODIFIED_TIME - 168 sortOrder: string, Order of sorted results. 169 Allowed values 170 ASCENDING - 171 DESCENDING - 172 x__xgafv: string, V1 error format. 173 Allowed values 174 1 - v1 error format 175 2 - v2 error format 176 177Returns: 178 An object of the form: 179 180 { # List of files for a report. 181 "etag": "A String", # Etag of this resource. 182 "items": [ # The files returned in this response. 183 { # 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". 184 "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. 185 "endDate": "A String", 186 "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange. 187 "relativeDateRange": "A String", # The date range relative to the date of when the report is run. 188 "startDate": "A String", 189 }, 190 "etag": "A String", # Etag of this resource. 191 "fileName": "A String", # The filename of the file. 192 "format": "A String", # The output format of the report. Only available once the file is available. 193 "id": "A String", # The unique ID of this report file. 194 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file". 195 "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified. 196 "reportId": "A String", # The ID of the report this file was generated from. 197 "status": "A String", # The status of the report file. 198 "urls": { # The URLs where the completed report file can be downloaded. 199 "apiUrl": "A String", # The URL for downloading the report data through the API. 200 "browserUrl": "A String", # The URL for downloading the report data through a browser. 201 }, 202 }, 203 ], 204 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#fileList". 205 "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. 206}</pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 211 <pre>Retrieves the next page of results. 212 213Args: 214 previous_request: The request for the previous page. (required) 215 previous_response: The response from the request for the previous page. (required) 216 217Returns: 218 A request object that you can call 'execute()' on to request the next 219 page. Returns None if there are no more items in the collection. 220 </pre> 221</div> 222 223</body></html>