Blame - docs/dyn/gmailpostmastertools_v1beta1.domains.trafficStats.html - platform/external/python/google-api-python-client

blob: ef2a59aaf3d36d6eae81f4c26159003991819c9d [file] [log] [blame]

Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	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_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">
				78	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Get traffic statistics for a domain on a specific date.</p>
				80	<p class="toc_element">
				81	<code><a href="#list">list(parent, startDate_month=None, startDate_day=None, pageSize=None, pageToken=None, startDate_year=None, endDate_day=None, endDate_year=None, endDate_month=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">List traffic statistics for all available days.</p>
				83	<p class="toc_element">
				84	<code><a href="#list_next">list_next(previous_request, previous_response)</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="get">get(name, x__xgafv=None)</code>
				89	<pre>Get traffic statistics for a domain on a specific date.
				90	Returns PERMISSION_DENIED if user does not have permission to access
				91	TrafficStats for the domain.
				92
				93	Args:
				94	name: string, The resource name of the traffic statistics to get.
				95	E.g., domains/mymail.mydomain.com/trafficStats/20160807. (required)
				96	x__xgafv: string, V1 error format.
				97	Allowed values
				98	1 - v1 error format
				99	2 - v2 error format
				100
				101	Returns:
				102	An object of the form:
				103
				104	{ # Email traffic statistics pertaining to a specific date.
				105	"outboundEncryptionRatio": 3.14, # The ratio of outgoing mail (from Gmail) that was accepted over secure
				106	# transport (TLS).
				107	"spfSuccessRatio": 3.14, # The ratio of mail that successfully authenticated with SPF vs. all mail
				108	# that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed
				109	# mail is excluded.
				110	"name": "A String", # The resource name of the traffic statistics. Traffic statistic names have
				111	# the form `domains/{domain}/trafficStats/{date}`, where
				112	# domain_name is the fully qualified domain name (i.e., mymail.mydomain.com)
				113	# of the domain this traffic statistics pertains to and date is the date in
				114	# yyyymmdd format that these statistics corresponds to.
				115	# For example: domains/mymail.mydomain.com/trafficStats/20160807
				116	"domainReputation": "A String", # Reputation of the domain.
				117	"dkimSuccessRatio": 3.14, # The ratio of mail that successfully authenticated with DKIM vs. all mail
				118	# that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed
				119	# mail is excluded.
				120	"dmarcSuccessRatio": 3.14, # The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks
				121	# vs all mail received from the domain that successfully authenticated with
				122	# either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
				123	"deliveryErrors": [ # Delivery errors for the domain. This metric only pertains to traffic that
				124	# passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
				125	{ # Metric on a particular delivery error type.
				126	"errorClass": "A String", # The class of delivery error.
				127	"errorType": "A String", # The type of delivery error.
				128	"errorRatio": 3.14, # The ratio of messages where the error occurred vs all authenticated
				129	# traffic.
				130	},
				131	],
				132	"userReportedSpamRatio": 3.14, # The ratio of user-report spam vs. email that was sent to the inbox. This
				133	# metric only pertains to emails authenticated by
				134	# [DKIM](http://www.dkim.org/).
				135	"spammyFeedbackLoops": [ # Spammy [Feedback loop identifiers]
				136	# (https://support.google.com/mail/answer/6254652) with their individual spam
				137	# rates. This metric only pertains to traffic that is authenticated by
				138	# [DKIM](http://www.dkim.org/).
				139	{ # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier
				140	# information.
				141	"spamRatio": 3.14, # The ratio of user marked spam messages with the identifier vs the total
				142	# number of inboxed messages with that identifier.
				143	"id": "A String", # Feedback loop identifier that uniquely identifies individual campaigns.
				144	},
				145	],
				146	"ipReputations": [ # Reputation information pertaining to the IP addresses of the email servers
				147	# for the domain. There is exactly one entry for each reputation category
				148	# except
				149	# REPUTATION_CATEGORY_UNSPECIFIED.
				150	{ # IP Reputation information for a set of IPs in a specific reputation category.
				151	"numIps": "A String", # Total number of unique IPs in this reputation category. This metric only
				152	# pertains to traffic that passed [SPF](http://www.openspf.org/) or
				153	# [DKIM](http://www.dkim.org/).
				154	"reputation": "A String", # The reputation category this IP reputation represents.
				155	"sampleIps": [ # A sample of IPs in this reputation category.
				156	"A String",
				157	],
				158	},
				159	],
				160	"inboundEncryptionRatio": 3.14, # The ratio of incoming mail (to Gmail), that passed secure transport (TLS)
				161	# vs all mail received from that domain. This metric only pertains to traffic
				162	# that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
				163	}</pre>
				164	</div>
				165
				166	<div class="method">
				167	<code class="details" id="list">list(parent, startDate_month=None, startDate_day=None, pageSize=None, pageToken=None, startDate_year=None, endDate_day=None, endDate_year=None, endDate_month=None, x__xgafv=None)</code>
				168	<pre>List traffic statistics for all available days.
				169	Returns PERMISSION_DENIED if user does not have permission to access
				170	TrafficStats for the domain.
				171
				172	Args:
				173	parent: string, The resource name of the domain whose traffic statistics we'd like to list.
				174	It should have the form `domains/{domain_name}`, where domain_name is
				175	the fully qualified domain name. (required)
				176	startDate_month: integer, Month of year. Must be from 1 to 12, or 0 if specifying a year without a
				177	month and day.
				178	startDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month, or 0
				179	if specifying a year by itself or a year and month where the day is not
				180	significant.
				181	pageSize: integer, Requested page size. Server may return fewer TrafficStats than
				182	requested. If unspecified, server will pick an appropriate default.
				183	pageToken: string, The next_page_token value returned from a previous List request, if any.
				184	This is the value of
				185	ListTrafficStatsResponse.next_page_token
				186	returned from the previous call to `ListTrafficStats` method.
				187	startDate_year: integer, Year of date. Must be from 1 to 9999, or 0 if specifying a date without
				188	a year.
				189	endDate_day: integer, Day of month. Must be from 1 to 31 and valid for the year and month, or 0
				190	if specifying a year by itself or a year and month where the day is not
				191	significant.
				192	endDate_year: integer, Year of date. Must be from 1 to 9999, or 0 if specifying a date without
				193	a year.
				194	endDate_month: integer, Month of year. Must be from 1 to 12, or 0 if specifying a year without a
				195	month and day.
				196	x__xgafv: string, V1 error format.
				197	Allowed values
				198	1 - v1 error format
				199	2 - v2 error format
				200
				201	Returns:
				202	An object of the form:
				203
				204	{ # Response message for ListTrafficStats.
				205	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
				206	# more results in the list.
				207	"trafficStats": [ # The list of TrafficStats.
				208	{ # Email traffic statistics pertaining to a specific date.
				209	"outboundEncryptionRatio": 3.14, # The ratio of outgoing mail (from Gmail) that was accepted over secure
				210	# transport (TLS).
				211	"spfSuccessRatio": 3.14, # The ratio of mail that successfully authenticated with SPF vs. all mail
				212	# that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed
				213	# mail is excluded.
				214	"name": "A String", # The resource name of the traffic statistics. Traffic statistic names have
				215	# the form `domains/{domain}/trafficStats/{date}`, where
				216	# domain_name is the fully qualified domain name (i.e., mymail.mydomain.com)
				217	# of the domain this traffic statistics pertains to and date is the date in
				218	# yyyymmdd format that these statistics corresponds to.
				219	# For example: domains/mymail.mydomain.com/trafficStats/20160807
				220	"domainReputation": "A String", # Reputation of the domain.
				221	"dkimSuccessRatio": 3.14, # The ratio of mail that successfully authenticated with DKIM vs. all mail
				222	# that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed
				223	# mail is excluded.
				224	"dmarcSuccessRatio": 3.14, # The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks
				225	# vs all mail received from the domain that successfully authenticated with
				226	# either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
				227	"deliveryErrors": [ # Delivery errors for the domain. This metric only pertains to traffic that
				228	# passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
				229	{ # Metric on a particular delivery error type.
				230	"errorClass": "A String", # The class of delivery error.
				231	"errorType": "A String", # The type of delivery error.
				232	"errorRatio": 3.14, # The ratio of messages where the error occurred vs all authenticated
				233	# traffic.
				234	},
				235	],
				236	"userReportedSpamRatio": 3.14, # The ratio of user-report spam vs. email that was sent to the inbox. This
				237	# metric only pertains to emails authenticated by
				238	# [DKIM](http://www.dkim.org/).
				239	"spammyFeedbackLoops": [ # Spammy [Feedback loop identifiers]
				240	# (https://support.google.com/mail/answer/6254652) with their individual spam
				241	# rates. This metric only pertains to traffic that is authenticated by
				242	# [DKIM](http://www.dkim.org/).
				243	{ # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier
				244	# information.
				245	"spamRatio": 3.14, # The ratio of user marked spam messages with the identifier vs the total
				246	# number of inboxed messages with that identifier.
				247	"id": "A String", # Feedback loop identifier that uniquely identifies individual campaigns.
				248	},
				249	],
				250	"ipReputations": [ # Reputation information pertaining to the IP addresses of the email servers
				251	# for the domain. There is exactly one entry for each reputation category
				252	# except
				253	# REPUTATION_CATEGORY_UNSPECIFIED.
				254	{ # IP Reputation information for a set of IPs in a specific reputation category.
				255	"numIps": "A String", # Total number of unique IPs in this reputation category. This metric only
				256	# pertains to traffic that passed [SPF](http://www.openspf.org/) or
				257	# [DKIM](http://www.dkim.org/).
				258	"reputation": "A String", # The reputation category this IP reputation represents.
				259	"sampleIps": [ # A sample of IPs in this reputation category.
				260	"A String",
				261	],
				262	},
				263	],
				264	"inboundEncryptionRatio": 3.14, # The ratio of incoming mail (to Gmail), that passed secure transport (TLS)
				265	# vs all mail received from that domain. This metric only pertains to traffic
				266	# that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
				267	},
				268	],
				269	}</pre>
				270	</div>
				271
				272	<div class="method">
				273	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				274	<pre>Retrieves the next page of results.
				275
				276	Args:
				277	previous_request: The request for the previous page. (required)
				278	previous_response: The response from the request for the previous page. (required)
				279
				280	Returns:
				281	A request object that you can call 'execute()' on to request the next
				282	page. Returns None if there are no more items in the collection.
				283	</pre>
				284	</div>
				285
				286	</body></html>