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