Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, 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 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, 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_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.files.html">files</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(reportId, fileId)</a></code></p>
     79 <p class="firstline">Retrieves a report file by its report ID and file ID. This method supports media download.</p>
     80 <p class="toc_element">
     81   <code><a href="#get_media">get_media(reportId, fileId)</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="#list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</a></code></p>
     85 <p class="firstline">Lists files for a user profile.</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(reportId, fileId)</code>
     92   <pre>Retrieves a report file by its report ID and file ID. This method supports media download.
     93 
     94 Args:
     95   reportId: string, The ID of the report. (required)
     96   fileId: string, The ID of the report file. (required)
     97 
     98 Returns:
     99   An object of the form:
    100 
    101     { # 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".
    102     "status": "A String", # The status of the report file.
    103     "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
    104     "format": "A String", # The output format of the report. Only available once the file is available.
    105     "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.
    106       "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
    107       "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
    108       "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
    109       "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
    110     },
    111     "fileName": "A String", # The filename of the file.
    112     "etag": "A String", # The eTag of this response for caching purposes.
    113     "reportId": "A String", # The ID of the report this file was generated from.
    114     "urls": { # The URLs where the completed report file can be downloaded.
    115       "browserUrl": "A String", # The URL for downloading the report data through a browser.
    116       "apiUrl": "A String", # The URL for downloading the report data through the API.
    117     },
    118     "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
    119     "id": "A String", # The unique ID of this report file.
    120   }</pre>
    121 </div>
    122 
    123 <div class="method">
    124     <code class="details" id="get_media">get_media(reportId, fileId)</code>
    125   <pre>Retrieves a report file by its report ID and file ID. This method supports media download.
    126 
    127 Args:
    128   reportId: string, The ID of the report. (required)
    129   fileId: string, The ID of the report file. (required)
    130 
    131 Returns:
    132   The media object as a string.
    133 
    134     </pre>
    135 </div>
    136 
    137 <div class="method">
    138     <code class="details" id="list">list(profileId, pageToken=None, maxResults=None, sortOrder=None, sortField=None, scope=None)</code>
    139   <pre>Lists files for a user profile.
    140 
    141 Args:
    142   profileId: string, The DFA profile ID. (required)
    143   pageToken: string, The value of the nextToken from the previous result page.
    144   maxResults: integer, Maximum number of results to return.
    145   sortOrder: string, Order of sorted results.
    146     Allowed values
    147       ASCENDING - Ascending order.
    148       DESCENDING - Descending order.
    149   sortField: string, The field by which to sort the list.
    150     Allowed values
    151       ID - Sort by file ID.
    152       LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
    153   scope: string, The scope that defines which results are returned.
    154     Allowed values
    155       ALL - All files in account.
    156       MINE - My files.
    157       SHARED_WITH_ME - Files shared with me.
    158 
    159 Returns:
    160   An object of the form:
    161 
    162     { # Represents the list of File resources.
    163     "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.
    164     "items": [ # The files returned in this response.
    165       { # 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".
    166         "status": "A String", # The status of the report file.
    167         "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
    168         "format": "A String", # The output format of the report. Only available once the file is available.
    169         "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.
    170           "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
    171           "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
    172           "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
    173           "relativeDateRange": "A String", # The date range relative to the date of when the report is run.
    174         },
    175         "fileName": "A String", # The filename of the file.
    176         "etag": "A String", # The eTag of this response for caching purposes.
    177         "reportId": "A String", # The ID of the report this file was generated from.
    178         "urls": { # The URLs where the completed report file can be downloaded.
    179           "browserUrl": "A String", # The URL for downloading the report data through a browser.
    180           "apiUrl": "A String", # The URL for downloading the report data through the API.
    181         },
    182         "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
    183         "id": "A String", # The unique ID of this report file.
    184       },
    185     ],
    186     "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
    187     "etag": "A String", # The eTag of this response for caching purposes.
    188   }</pre>
    189 </div>
    190 
    191 <div class="method">
    192     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    193   <pre>Retrieves the next page of results.
    194 
    195 Args:
    196   previous_request: The request for the previous page. (required)
    197   previous_response: The response from the request for the previous page. (required)
    198 
    199 Returns:
    200   A request object that you can call 'execute()' on to request the next
    201   page. Returns None if there are no more items in the collection.
    202     </pre>
    203 </div>
    204 
    205 </body></html>