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

blob: d3dee4783b57d3b943405d53806edc610a3ed12d [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">
Dmitry Frenkel	3e17f89	2020-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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	80	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-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">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	84	<code><a href="#list">list(parent, endDate_month=None, startDate_day=None, pageSize=None, endDate_year=None, startDate_year=None, startDate_month=None, pageToken=None, endDate_day=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-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 Kim	d059ad8	2020-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 Frenkel	3e17f89	2020-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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	96	<code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	98
				99	Args:
Dmitry Frenkel	3e17f89	2020-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 Kim	d059ad8	2020-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
				106	Returns:
				107	An object of the form:
				108
				109	{ # Email traffic statistics pertaining to a specific date.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	110	"dmarcSuccessRatio": 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/).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	111	"inboundEncryptionRatio": 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/).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	112	"userReportedSpamRatio": 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/).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	113	"spfSuccessRatio": 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.
				114	"spammyFeedbackLoops": [ # 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/).
				115	{ # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.
				116	"spamRatio": 3.14, # The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier.
				117	"id": "A String", # Feedback loop identifier that uniquely identifies individual campaigns.
				118	},
				119	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	120	"deliveryErrors": [ # Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
				121	{ # Metric on a particular delivery error type.
				122	"errorRatio": 3.14, # The ratio of messages where the error occurred vs all authenticated traffic.
				123	"errorType": "A String", # The type of delivery error.
				124	"errorClass": "A String", # The class of delivery error.
				125	},
				126	],
				127	"ipReputations": [ # 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.
				128	{ # IP Reputation information for a set of IPs in a specific reputation category.
				129	"reputation": "A String", # The reputation category this IP reputation represents.
				130	"sampleIps": [ # A sample of IPs in this reputation category.
				131	"A String",
				132	],
				133	"numIps": "A String", # 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/).
				134	},
				135	],
				136	"name": "A String", # 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
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	137	"outboundEncryptionRatio": 3.14, # The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	138	"dkimSuccessRatio": 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.
				139	"domainReputation": "A String", # Reputation of the domain.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	140	}</pre>
				141	</div>
				142
				143	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	144	<code class="details" id="list">list(parent, endDate_month=None, startDate_day=None, pageSize=None, endDate_year=None, startDate_year=None, startDate_month=None, pageToken=None, endDate_day=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	145	<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 Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	146
				147	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	148	parent: string, The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. (required)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	149	endDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
				150	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't significant.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	151	pageSize: integer, Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	152	endDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
				153	startDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
				154	startDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
				155	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.
				156	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't significant.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	157	x__xgafv: string, V1 error format.
				158	Allowed values
				159	1 - v1 error format
				160	2 - v2 error format
				161
				162	Returns:
				163	An object of the form:
				164
				165	{ # Response message for ListTrafficStats.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	166	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	167	"trafficStats": [ # The list of TrafficStats.
				168	{ # Email traffic statistics pertaining to a specific date.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	169	"dmarcSuccessRatio": 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/).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	170	"inboundEncryptionRatio": 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/).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	171	"userReportedSpamRatio": 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/).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	172	"spfSuccessRatio": 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.
				173	"spammyFeedbackLoops": [ # 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/).
				174	{ # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.
				175	"spamRatio": 3.14, # The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier.
				176	"id": "A String", # Feedback loop identifier that uniquely identifies individual campaigns.
				177	},
				178	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	179	"deliveryErrors": [ # Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
				180	{ # Metric on a particular delivery error type.
				181	"errorRatio": 3.14, # The ratio of messages where the error occurred vs all authenticated traffic.
				182	"errorType": "A String", # The type of delivery error.
				183	"errorClass": "A String", # The class of delivery error.
				184	},
				185	],
				186	"ipReputations": [ # 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.
				187	{ # IP Reputation information for a set of IPs in a specific reputation category.
				188	"reputation": "A String", # The reputation category this IP reputation represents.
				189	"sampleIps": [ # A sample of IPs in this reputation category.
				190	"A String",
				191	],
				192	"numIps": "A String", # 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/).
				193	},
				194	],
				195	"name": "A String", # 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
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	196	"outboundEncryptionRatio": 3.14, # The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	197	"dkimSuccessRatio": 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.
				198	"domainReputation": "A String", # Reputation of the domain.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	199	},
				200	],
				201	}</pre>
				202	</div>
				203
				204	<div class="method">
				205	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				206	<pre>Retrieves the next page of results.
				207
				208	Args:
				209	previous_request: The request for the previous page. (required)
				210	previous_response: The response from the request for the previous page. (required)
				211
				212	Returns:
				213	A request object that you can call 'execute()' on to request the next
				214	page. Returns None if there are no more items in the collection.
				215	</pre>
				216	</div>
				217
				218	</body></html>