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