Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / gmailpostmastertools_v1beta1.domains.html
blob: 1d6b2dd6b6843fa9c0f9a82996e6868d2cce6ef3 [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="gmailpostmastertools_v1beta1.domains.trafficStats.html">trafficStats()</a></code>
79</p>
80<p class="firstline">Returns the trafficStats Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]87<p class="firstline">Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]88<p class="toc_element">
89 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]90<p class="firstline">Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<h3>Method Details</h3>
95<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]96 <code class="details" id="close">close()</code>
97 <pre>Close httplib2 connections.</pre>
98</div>
99
100<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]101 <code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]102 <pre>Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]103
104Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]105 name: string, The resource name of the domain. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
114 { # A registered domain resource in the Postmaster API.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]115 &quot;createTime&quot;: &quot;A String&quot;, # Timestamp when the user registered this domain. Assigned by the server.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]116 &quot;permission&quot;: &quot;A String&quot;, # User’s permission for this domain. Assigned by the server.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]117 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Domain. Domain names have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]118 }</pre>
119</div>
120
121<div class="method">
122 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]123 <pre>Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]124
125Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]126 pageSize: integer, Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.
127 pageToken: string, The next_page_token value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to `ListDomains` method.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
132
133Returns:
134 An object of the form:
135
136 { # Response message for ListDomains.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]137 &quot;domains&quot;: [ # The list of domains.
138 { # A registered domain resource in the Postmaster API.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]139 &quot;createTime&quot;: &quot;A String&quot;, # Timestamp when the user registered this domain. Assigned by the server.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]140 &quot;permission&quot;: &quot;A String&quot;, # User’s permission for this domain. Assigned by the server.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]141 &quot;name&quot;: &quot;A String&quot;, # The resource name of the Domain. Domain names have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 },
143 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]144 &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]145 }</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
150 <pre>Retrieves the next page of results.
151
152Args:
153 previous_request: The request for the previous page. (required)
154 previous_response: The response from the request for the previous page. (required)
155
156Returns:
157 A request object that you can call &#x27;execute()&#x27; on to request the next
158 page. Returns None if there are no more items in the collection.
159 </pre>
160</div>
161
162</body></html>