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="admin_reports_v1.html">Admin Reports API</a> . <a href="admin_reports_v1.customerUsageReports.html">customerUsageReports</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(date, parameters=None, pageToken=None, customerId=None)</a></code></p>
     79 <p class="firstline">Retrieves a report which is a collection of properties / statistics for a specific customer.</p>
     80 <p class="toc_element">
     81   <code><a href="#get_next">get_next(previous_request, previous_response)</a></code></p>
     82 <p class="firstline">Retrieves the next page of results.</p>
     83 <h3>Method Details</h3>
     84 <div class="method">
     85     <code class="details" id="get">get(date, parameters=None, pageToken=None, customerId=None)</code>
     86   <pre>Retrieves a report which is a collection of properties / statistics for a specific customer.
     87 
     88 Args:
     89   date: string, Represents the date in yyyy-mm-dd format for which the data is to be fetched. (required)
     90   parameters: string, Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.
     91   pageToken: string, Token to specify next page.
     92   customerId: string, Represents the customer for which the data is to be fetched.
     93 
     94 Returns:
     95   An object of the form:
     96 
     97     { # JSON template for a collection of usage reports.
     98     "nextPageToken": "A String", # Token for retrieving the next page
     99     "kind": "admin#reports#usageReports", # The kind of object.
    100     "etag": "A String", # ETag of the resource.
    101     "usageReports": [ # Various application parameter records.
    102       { # JSON template for a usage report.
    103         "date": "A String", # The date to which the record belongs.
    104         "kind": "admin#reports#usageReport", # The kind of object.
    105         "etag": "A String", # ETag of the resource.
    106         "parameters": [ # Parameter value pairs for various applications.
    107           {
    108             "msgValue": [ # Nested message value of the parameter.
    109               {
    110                 "a_key": "",
    111               },
    112             ],
    113             "name": "A String", # The name of the parameter.
    114             "intValue": "A String", # Integral value of the parameter.
    115             "boolValue": True or False, # Boolean value of the parameter.
    116             "datetimeValue": "A String", # RFC 3339 formatted value of the parameter.
    117             "stringValue": "A String", # String value of the parameter.
    118           },
    119         ],
    120         "entity": { # Information about the type of the item.
    121           "profileId": "A String", # Obfuscated user id for the record.
    122           "userEmail": "A String", # user's email.
    123           "type": "A String", # The type of item, can be a customer or user.
    124           "customerId": "A String", # Obfuscated customer id for the record.
    125         },
    126       },
    127     ],
    128     "warnings": [ # Warnings if any.
    129       {
    130         "message": "A String", # Human readable message for the warning.
    131         "code": "A String", # Machine readable code / warning type.
    132         "data": [ # Key-Value pairs to give detailed information on the warning.
    133           {
    134             "value": "A String", # Value associated with a key-value pair to give detailed information on the warning.
    135             "key": "A String", # Key associated with a key-value pair to give detailed information on the warning.
    136           },
    137         ],
    138       },
    139     ],
    140   }</pre>
    141 </div>
    142 
    143 <div class="method">
    144     <code class="details" id="get_next">get_next(previous_request, previous_response)</code>
    145   <pre>Retrieves the next page of results.
    146 
    147 Args:
    148   previous_request: The request for the previous page. (required)
    149   previous_response: The response from the request for the previous page. (required)
    150 
    151 Returns:
    152   A request object that you can call 'execute()' on to request the next
    153   page. Returns None if there are no more items in the collection.
    154     </pre>
    155 </div>
    156 
    157 </body></html>