Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / gmailpostmastertools_v1beta1.domains.trafficStats.html
blob: 8fe2c81bc63807ed72ac461d1b587f3c2ef5e899 [file] [log] [blame]
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]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="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 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <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 Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]84 <code><a href="#list">list(parent, endDate_day=None, startDate_day=None, pageSize=None, endDate_year=None, endDate_month=None, startDate_month=None, pageToken=None, startDate_year=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<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 -0700[diff] [blame]86<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 -0700[diff] [blame]91 <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 -0700[diff] [blame]96 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <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 -0700[diff] [blame]98
99Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 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 -0700[diff] [blame]101 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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]110 &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.
111 { # IP Reputation information for a set of IPs in a specific reputation category.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]112 &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/).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]113 &quot;sampleIps&quot;: [ # A sample of IPs in this reputation category.
114 &quot;A String&quot;,
115 ],
116 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]117 &quot;reputation&quot;: &quot;A String&quot;, # The reputation category this IP reputation represents.
118 },
119 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]120 &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/).
121 &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/).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]122 &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.
123 &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.
124 &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
125 &quot;domainReputation&quot;: &quot;A String&quot;, # Reputation of the domain.
126 &quot;outboundEncryptionRatio&quot;: 3.14, # The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]127 &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/).
128 { # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]129 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]130 &quot;id&quot;: &quot;A String&quot;, # Feedback loop identifier that uniquely identifies individual campaigns.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]131 },
132 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]133 &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/).
134 &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/).
135 { # Metric on a particular delivery error type.
136 &quot;errorRatio&quot;: 3.14, # The ratio of messages where the error occurred vs all authenticated traffic.
137 &quot;errorType&quot;: &quot;A String&quot;, # The type of delivery error.
138 &quot;errorClass&quot;: &quot;A String&quot;, # The class of delivery error.
139 },
140 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]141 }</pre>
142</div>
143
144<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]145 <code class="details" id="list">list(parent, endDate_day=None, startDate_day=None, pageSize=None, endDate_year=None, endDate_month=None, startDate_month=None, pageToken=None, startDate_year=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]146 <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 -0700[diff] [blame]147
148Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]149 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 -0800[diff] [blame^]150 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.
151 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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]152 pageSize: integer, Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]153 endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]154 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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]155 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 Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]156 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 Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]157 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 -0700[diff] [blame]158 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]167 &quot;trafficStats&quot;: [ # The list of TrafficStats.
168 { # Email traffic statistics pertaining to a specific date.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]169 &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.
170 { # IP Reputation information for a set of IPs in a specific reputation category.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]171 &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/).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]172 &quot;sampleIps&quot;: [ # A sample of IPs in this reputation category.
173 &quot;A String&quot;,
174 ],
175 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]176 &quot;reputation&quot;: &quot;A String&quot;, # The reputation category this IP reputation represents.
177 },
178 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]179 &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/).
180 &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/).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]181 &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.
182 &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.
183 &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
184 &quot;domainReputation&quot;: &quot;A String&quot;, # Reputation of the domain.
185 &quot;outboundEncryptionRatio&quot;: 3.14, # The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]186 &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/).
187 { # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]188 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]189 &quot;id&quot;: &quot;A String&quot;, # Feedback loop identifier that uniquely identifies individual campaigns.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]190 },
191 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]192 &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/).
193 &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/).
194 { # Metric on a particular delivery error type.
195 &quot;errorRatio&quot;: 3.14, # The ratio of messages where the error occurred vs all authenticated traffic.
196 &quot;errorType&quot;: &quot;A String&quot;, # The type of delivery error.
197 &quot;errorClass&quot;: &quot;A String&quot;, # The class of delivery error.
198 },
199 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]200 },
201 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]202 &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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]203 }</pre>
204</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>