Debian Codegraph @

docs/dyn/gmailpostmastertools_v2.domains.domainStats.html

raw
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="gmailpostmastertools_v2.html">Gmail Postmaster Tools API</a> . <a href="gmailpostmastertools_v2.domains.html">domains</a> . <a href="gmailpostmastertools_v2.domains.domainStats.html">domainStats</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="#query">query(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for the domain.</p>
83 <p class="toc_element">
84 <code><a href="#query_next">query_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="query">query(parent, body=None, x__xgafv=None)</code>
94 <pre>Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don&#x27;t have permission to access DomainStats for the domain.
95
96 Args:
97 parent: string, Required. The parent resource name where the stats are queried. Format: domains/{domain} (required)
98 body: object, The request body.
99 The object takes the form of:
100
101 { # Request message for QueryDomainStats.
102 &quot;aggregationGranularity&quot;: &quot;A String&quot;, # Optional. The granularity at which to aggregate the statistics. If unspecified, defaults to DAILY.
103 &quot;metricDefinitions&quot;: [ # Required. The specific metrics to query. You can define a custom name for each metric, which will be used in the response.
104 { # Defines a specific metric to query, including a user-defined name, the base metric type, and optional filters.
105 &quot;baseMetric&quot;: { # Specifies the base metric to query, which can be a predefined standard metric or a user-defined custom metric (if supported in the future). # Required. The underlying metric to query.
106 &quot;standardMetric&quot;: &quot;A String&quot;, # A predefined standard metric.
107 },
108 &quot;filter&quot;: &quot;A String&quot;, # Optional. Optional filters to apply to the metric.
109 &quot;name&quot;: &quot;A String&quot;, # Required. The user-defined name for this metric. This name will be used as the key for this metric&#x27;s value in the response.
110 },
111 ],
112 &quot;pageSize&quot;: 42, # Optional. The maximum number of DomainStats resources to return in the response. The server may return fewer than this value. If unspecified, a default value of 10 will be used. The maximum value is 200.
113 &quot;pageToken&quot;: &quot;A String&quot;, # Optional. The next_page_token value returned from a previous List request, if any. If the aggregation granularity is DAILY, the page token will be the encoded date + &quot;/&quot; + metric name. If the aggregation granularity is OVERALL, the page token will be the encoded metric name.
114 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent resource name where the stats are queried. Format: domains/{domain}
115 &quot;timeQuery&quot;: { # The date ranges or specific dates for which you want to retrieve data. # Required. The time range or specific dates for which to retrieve the metrics.
116 &quot;dateList&quot;: { # A set of specific dates. # A list of specific dates.
117 &quot;dates&quot;: [ # Required. The list of specific dates for which to retrieve data.
118 { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
119 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
120 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
121 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
122 },
123 ],
124 },
125 &quot;dateRanges&quot;: { # A set of date ranges. # A list of date ranges.
126 &quot;dateRanges&quot;: [ # Required. The list of date ranges for which to retrieve data.
127 { # A single date range defined by a start and end date.
128 &quot;end&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The inclusive end date of the date range.
129 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
130 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
131 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
132 },
133 &quot;start&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The inclusive start date of the date range.
134 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
135 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
136 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
137 },
138 },
139 ],
140 },
141 },
142 }
143
144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149 Returns:
150 An object of the form:
151
152 { # Response message for QueryDomainStats.
153 &quot;domainStats&quot;: [ # The list of domain statistics. Each DomainStat object contains the value for a metric requested in the QueryDomainStatsRequest.
154 { # Email statistics for a domain for a specified time period or date.
155 &quot;date&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The specific date for these stats, if granularity is DAILY. This field is populated if the QueryDomainStatsRequest specified a DAILY aggregation granularity.
156 &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
157 &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
158 &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
159 },
160 &quot;metric&quot;: &quot;A String&quot;, # The user-defined name from MetricDefinition.name in the request, used to correlate this result with the requested metric.
161 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DomainStat resource. Format: domains/{domain}/domainStats/{domain_stat} The `{domain_stat}` segment is an opaque, server-generated ID. We recommend using the `metric` field to identify queried metrics instead of parsing the name.
162 &quot;value&quot;: { # The actual value of a statistic. # The value of the corresponding metric.
163 &quot;doubleValue&quot;: 3.14, # Double value.
164 &quot;floatValue&quot;: 3.14, # Float value.
165 &quot;intValue&quot;: &quot;A String&quot;, # Integer value.
166 &quot;stringList&quot;: { # Represents a list of strings. # List of string values.
167 &quot;values&quot;: [ # The string values.
168 &quot;A String&quot;,
169 ],
170 },
171 &quot;stringValue&quot;: &quot;A String&quot;, # String value.
172 },
173 },
174 ],
175 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
176 }</pre>
177 </div>
178
179 <div class="method">
180 <code class="details" id="query_next">query_next()</code>
181 <pre>Retrieves the next page of results.
182
183 Args:
184 previous_request: The request for the previous page. (required)
185 previous_response: The response from the request for the previous page. (required)
186
187 Returns:
188 A request object that you can call &#x27;execute()&#x27; on to request the next
189 page. Returns None if there are no more items in the collection.
190 </pre>
191 </div>
192
193 </body></html>