| <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_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.files.html">files</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="#get">get(reportId, fileId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a report file by its report ID and file ID. This method supports media download.</p> |
| <p class="toc_element"> |
| <code><a href="#get_media">get_media(reportId, fileId, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a report file by its report ID and file ID. This method supports media download.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(profileId, maxResults=None, pageToken=None, scope=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists files for a user profile.</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="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(reportId, fileId, x__xgafv=None)</code> |
| <pre>Retrieves a report file by its report ID and file ID. This method supports media download. |
| |
| Args: |
| reportId: string, The ID of the report. (required) |
| fileId: string, The ID of the report file. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| 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". |
| "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. |
| "endDate": "A String", |
| "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange. |
| "relativeDateRange": "A String", # The date range relative to the date of when the report is run. |
| "startDate": "A String", |
| }, |
| "etag": "A String", # Etag of this resource. |
| "fileName": "A String", # The filename of the file. |
| "format": "A String", # The output format of the report. Only available once the file is available. |
| "id": "A String", # The unique ID of this report file. |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file". |
| "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified. |
| "reportId": "A String", # The ID of the report this file was generated from. |
| "status": "A String", # The status of the report file. |
| "urls": { # The URLs where the completed report file can be downloaded. |
| "apiUrl": "A String", # The URL for downloading the report data through the API. |
| "browserUrl": "A String", # The URL for downloading the report data through a browser. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get_media">get_media(reportId, fileId, x__xgafv=None)</code> |
| <pre>Retrieves a report file by its report ID and file ID. This method supports media download. |
| |
| Args: |
| reportId: string, The ID of the report. (required) |
| fileId: string, The ID of the report file. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| The media object as a string. |
| |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(profileId, maxResults=None, pageToken=None, scope=None, sortField=None, sortOrder=None, x__xgafv=None)</code> |
| <pre>Lists files for a user profile. |
| |
| Args: |
| profileId: string, The Campaign Manager 360 user profile ID. (required) |
| maxResults: integer, Maximum number of results to return. |
| pageToken: string, The value of the nextToken from the previous result page. |
| scope: string, The scope that defines which results are returned. |
| Allowed values |
| ALL - All files in account. |
| MINE - My files. |
| SHARED_WITH_ME - Files shared with me. |
| sortField: string, The field by which to sort the list. |
| Allowed values |
| ID - Sort by file ID. |
| LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field. |
| sortOrder: string, Order of sorted results. |
| Allowed values |
| ASCENDING - Ascending order. |
| DESCENDING - Descending order. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # List of files for a report. |
| "etag": "A String", # Etag of this resource. |
| "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". |
| "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. |
| "endDate": "A String", |
| "kind": "A String", # The kind of resource this is, in this case dfareporting#dateRange. |
| "relativeDateRange": "A String", # The date range relative to the date of when the report is run. |
| "startDate": "A String", |
| }, |
| "etag": "A String", # Etag of this resource. |
| "fileName": "A String", # The filename of the file. |
| "format": "A String", # The output format of the report. Only available once the file is available. |
| "id": "A String", # The unique ID of this report file. |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#file". |
| "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified. |
| "reportId": "A String", # The ID of the report this file was generated from. |
| "status": "A String", # The status of the report file. |
| "urls": { # The URLs where the completed report file can be downloaded. |
| "apiUrl": "A String", # The URL for downloading the report data through the API. |
| "browserUrl": "A String", # The URL for downloading the report data through a browser. |
| }, |
| }, |
| ], |
| "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#fileList". |
| "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. |
| }</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> |
