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="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.environments.html">environments</a> . <a href="apigee_v1.organizations.environments.analytics.html">analytics</a> . <a href="apigee_v1.organizations.environments.analytics.admin.html">admin</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="#getSchemav2">getSchemav2(name, disableCache=None, type=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="close">close()</code>
86  <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
90    <code class="details" id="getSchemav2">getSchemav2(name, disableCache=None, type=None, x__xgafv=None)</code>
91  <pre>Gets a list of metrics and dimensions that can be used to create analytics queries and reports. Each schema element contains the name of the field, its associated type, and a flag indicating whether it is a standard or custom field.
92
93Args:
94  name: string, Required. Path to the schema. Use the following structure in your request: `organizations/{org}/environments/{env}/analytics/admin/schemav2`. (required)
95  disableCache: boolean, Flag that specifies whether the schema is be read from the database or cache. Set to `true` to read the schema from the database. Defaults to cache.
96  type: string, Required. Name of the dataset for which you want to retrieve the schema. For example: `fact` or `agg_cus1`
97  x__xgafv: string, V1 error format.
98    Allowed values
99      1 - v1 error format
100      2 - v2 error format
101
102Returns:
103  An object of the form:
104
105    { # Response for Schema call
106  &quot;dimensions&quot;: [ # List of schema fields grouped as dimensions.
107    { # Message type for the schema element
108      &quot;name&quot;: &quot;A String&quot;, # Name of the field.
109      &quot;properties&quot;: { # Properties for the schema field. # Properties for the schema field. For example: { &quot;createTime&quot;: &quot;2016-02-26T10:23:09.592Z&quot;, &quot;custom&quot;: &quot;false&quot;, &quot;type&quot;: &quot;string&quot; }
110        &quot;createTime&quot;: &quot;A String&quot;, # Time the field was created in RFC3339 string form. For example: `2016-02-26T10:23:09.592Z`.
111        &quot;custom&quot;: &quot;A String&quot;, # Flag that specifies whether the field is standard in the dataset or a custom field created by the customer. `true` indicates that it is a custom field.
112        &quot;type&quot;: &quot;A String&quot;, # Data type of the field.
113      },
114    },
115  ],
116  &quot;meta&quot;: [ # Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings.
117    &quot;A String&quot;,
118  ],
119  &quot;metrics&quot;: [ # List of schema fields grouped as dimensions that can be used with an aggregate function such as `sum`, `avg`, `min`, and `max`.
120    { # Message type for the schema element
121      &quot;name&quot;: &quot;A String&quot;, # Name of the field.
122      &quot;properties&quot;: { # Properties for the schema field. # Properties for the schema field. For example: { &quot;createTime&quot;: &quot;2016-02-26T10:23:09.592Z&quot;, &quot;custom&quot;: &quot;false&quot;, &quot;type&quot;: &quot;string&quot; }
123        &quot;createTime&quot;: &quot;A String&quot;, # Time the field was created in RFC3339 string form. For example: `2016-02-26T10:23:09.592Z`.
124        &quot;custom&quot;: &quot;A String&quot;, # Flag that specifies whether the field is standard in the dataset or a custom field created by the customer. `true` indicates that it is a custom field.
125        &quot;type&quot;: &quot;A String&quot;, # Data type of the field.
126      },
127    },
128  ],
129}</pre>
130</div>
131
132</body></html>