blob: b13586fa385fb1683d379b2e16cd27d306d2f8b2 [file] [log] [blame]
Bu Sun Kimd059ad82020-07-22 17:02:09 -07001<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="gmailpostmastertools_v1beta1.html">Gmail Postmaster Tools API</a> . <a href="gmailpostmastertools_v1beta1.domains.html">domains</a> . <a href="gmailpostmastertools_v1beta1.domains.trafficStats.html">trafficStats</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070080<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070081 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#list">list(parent, endDate_day=None, endDate_month=None, endDate_year=None, pageSize=None, pageToken=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070086<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070096 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <pre>Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
Bu Sun Kimd059ad82020-07-22 17:02:09 -070098
99Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 name: string, The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 { # Email traffic statistics pertaining to a specific date.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800110 &quot;deliveryErrors&quot;: [ # Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
111 { # Metric on a particular delivery error type.
112 &quot;errorClass&quot;: &quot;A String&quot;, # The class of delivery error.
113 &quot;errorRatio&quot;: 3.14, # The ratio of messages where the error occurred vs all authenticated traffic.
114 &quot;errorType&quot;: &quot;A String&quot;, # The type of delivery error.
115 },
116 ],
117 &quot;dkimSuccessRatio&quot;: 3.14, # The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is excluded.
118 &quot;dmarcSuccessRatio&quot;: 3.14, # The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
119 &quot;domainReputation&quot;: &quot;A String&quot;, # Reputation of the domain.
120 &quot;inboundEncryptionRatio&quot;: 3.14, # The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
121 &quot;ipReputations&quot;: [ # Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except REPUTATION_CATEGORY_UNSPECIFIED.
122 { # IP Reputation information for a set of IPs in a specific reputation category.
123 &quot;ipCount&quot;: &quot;A String&quot;, # Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
124 &quot;numIps&quot;: &quot;A String&quot;, # Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). Deprecated to be complied with ApiLinter for Quantities. Use ip_count instead.
125 &quot;reputation&quot;: &quot;A String&quot;, # The reputation category this IP reputation represents.
126 &quot;sampleIps&quot;: [ # A sample of IPs in this reputation category.
127 &quot;A String&quot;,
128 ],
129 },
130 ],
131 &quot;name&quot;: &quot;A String&quot;, # The resource name of the traffic statistics. Traffic statistic names have the form `domains/{domain}/trafficStats/{date}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example: domains/mymail.mydomain.com/trafficStats/20160807
132 &quot;outboundEncryptionRatio&quot;: 3.14, # The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
133 &quot;spammyFeedbackLoops&quot;: [ # Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates. This metric only pertains to traffic that is authenticated by [DKIM](http://www.dkim.org/).
134 { # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.
135 &quot;id&quot;: &quot;A String&quot;, # Feedback loop identifier that uniquely identifies individual campaigns.
136 &quot;spamRatio&quot;: 3.14, # The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier.
137 },
138 ],
139 &quot;spfSuccessRatio&quot;: 3.14, # The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is excluded.
140 &quot;userReportedSpamRatio&quot;: 3.14, # The ratio of user-report spam vs. email that was sent to the inbox. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
141}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700142</div>
143
144<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800145 <code class="details" id="list">list(parent, endDate_day=None, endDate_month=None, endDate_year=None, pageSize=None, pageToken=None, startDate_day=None, startDate_month=None, startDate_year=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700146 <pre>List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700147
148Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700149 parent: string, The resource name of the domain whose traffic statistics we&#x27;d like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800150 endDate_day: integer, 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800151 endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800152 endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800153 pageSize: integer, Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800154 pageToken: string, The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to `ListTrafficStats` method.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800155 startDate_day: integer, 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.
156 startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800157 startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700158 x__xgafv: string, V1 error format.
159 Allowed values
160 1 - v1 error format
161 2 - v2 error format
162
163Returns:
164 An object of the form:
165
166 { # Response message for ListTrafficStats.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800167 &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.
168 &quot;trafficStats&quot;: [ # The list of TrafficStats.
169 { # Email traffic statistics pertaining to a specific date.
170 &quot;deliveryErrors&quot;: [ # Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
171 { # Metric on a particular delivery error type.
172 &quot;errorClass&quot;: &quot;A String&quot;, # The class of delivery error.
173 &quot;errorRatio&quot;: 3.14, # The ratio of messages where the error occurred vs all authenticated traffic.
174 &quot;errorType&quot;: &quot;A String&quot;, # The type of delivery error.
175 },
176 ],
177 &quot;dkimSuccessRatio&quot;: 3.14, # The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is excluded.
178 &quot;dmarcSuccessRatio&quot;: 3.14, # The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
179 &quot;domainReputation&quot;: &quot;A String&quot;, # Reputation of the domain.
180 &quot;inboundEncryptionRatio&quot;: 3.14, # The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
181 &quot;ipReputations&quot;: [ # Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except REPUTATION_CATEGORY_UNSPECIFIED.
182 { # IP Reputation information for a set of IPs in a specific reputation category.
183 &quot;ipCount&quot;: &quot;A String&quot;, # Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
184 &quot;numIps&quot;: &quot;A String&quot;, # Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/). Deprecated to be complied with ApiLinter for Quantities. Use ip_count instead.
185 &quot;reputation&quot;: &quot;A String&quot;, # The reputation category this IP reputation represents.
186 &quot;sampleIps&quot;: [ # A sample of IPs in this reputation category.
187 &quot;A String&quot;,
188 ],
189 },
190 ],
191 &quot;name&quot;: &quot;A String&quot;, # The resource name of the traffic statistics. Traffic statistic names have the form `domains/{domain}/trafficStats/{date}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example: domains/mymail.mydomain.com/trafficStats/20160807
192 &quot;outboundEncryptionRatio&quot;: 3.14, # The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
193 &quot;spammyFeedbackLoops&quot;: [ # Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates. This metric only pertains to traffic that is authenticated by [DKIM](http://www.dkim.org/).
194 { # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.
195 &quot;id&quot;: &quot;A String&quot;, # Feedback loop identifier that uniquely identifies individual campaigns.
196 &quot;spamRatio&quot;: 3.14, # The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier.
197 },
198 ],
199 &quot;spfSuccessRatio&quot;: 3.14, # The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is excluded.
200 &quot;userReportedSpamRatio&quot;: 3.14, # The ratio of user-report spam vs. email that was sent to the inbox. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
201 },
202 ],
203}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700204</div>
205
206<div class="method">
207 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
208 <pre>Retrieves the next page of results.
209
210Args:
211 previous_request: The request for the previous page. (required)
212 previous_response: The response from the request for the previous page. (required)
213
214Returns:
215 A request object that you can call &#x27;execute()&#x27; on to request the next
216 page. Returns None if there are no more items in the collection.
217 </pre>
218</div>
219
220</body></html>