Debian Codegraph @

docs/dyn/gmailpostmastertools_v2.domains.html

raw
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_v2.html">Gmail Postmaster Tools API</a> . <a href="gmailpostmastertools_v2.domains.html">domains</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="gmailpostmastertools_v2.domains.domainStats.html">domainStats()</a></code>
79 </p>
80 <p class="firstline">Returns the domainStats Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84 <p class="firstline">Close httplib2 connections.</p>
85 <p class="toc_element">
86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
87 <p class="firstline">Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user.</p>
88 <p class="toc_element">
89 <code><a href="#getComplianceStatus">getComplianceStatus(name, x__xgafv=None)</a></code></p>
90 <p class="firstline">Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain.</p>
91 <p class="toc_element">
92 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
93 <p class="firstline">Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list.</p>
94 <p class="toc_element">
95 <code><a href="#list_next">list_next()</a></code></p>
96 <p class="firstline">Retrieves the next page of results.</p>
97 <h3>Method Details</h3>
98 <div class="method">
99 <code class="details" id="close">close()</code>
100 <pre>Close httplib2 connections.</pre>
101 </div>
102
103 <div class="method">
104 <code class="details" id="get">get(name, x__xgafv=None)</code>
105 <pre>Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user.
106
107 Args:
108 name: string, Required. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com). (required)
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114 Returns:
115 An object of the form:
116
117 { # Information about a domain registered by the user.
118 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Immutable. The timestamp at which the domain was added to the user&#x27;s account.
119 &quot;lastVerifyTime&quot;: &quot;A String&quot;, # The timestamp at which the domain was last verified by the user.
120 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
121 &quot;permission&quot;: &quot;A String&quot;, # Output only. User&#x27;s permission of this domain.
122 &quot;verificationState&quot;: &quot;A String&quot;, # Output only. Information about a user&#x27;s verification history and properties for the domain.
123 }</pre>
124 </div>
125
126 <div class="method">
127 <code class="details" id="getComplianceStatus">getComplianceStatus(name, x__xgafv=None)</code>
128 <pre>Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don&#x27;t have permission to access compliance status for the domain.
129
130 Args:
131 name: string, Required. The resource name of the domain&#x27;s compliance status to retrieve. Format: `domains/{domain_id}/complianceStatus`. (required)
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137 Returns:
138 An object of the form:
139
140 { # Compliance status for a domain.
141 &quot;complianceData&quot;: { # Compliance data for a given domain. # Compliance data for the registrable domain part of the domain in `name`. For example, if `name` is `domains/example.com/complianceStatus`, this field contains compliance data for `example.com`.
142 &quot;domainId&quot;: &quot;A String&quot;, # Domain that this data is for.
143 &quot;honorUnsubscribeVerdict&quot;: { # Compliance verdict for whether a sender meets the unsubscribe honoring compliance requirement. # Unsubscribe honoring compliance verdict.
144 &quot;reason&quot;: &quot;A String&quot;, # The specific reason for the compliance verdict. Must be empty if the status is compliant.
145 &quot;status&quot;: { # The status of a sender compliance requirement. # The compliance status.
146 &quot;status&quot;: &quot;A String&quot;, # Output only. The compliance status.
147 },
148 },
149 &quot;oneClickUnsubscribeVerdict&quot;: { # Compliance verdict for whether a sender meets the one-click unsubscribe compliance requirement. # One-click unsubscribe compliance verdict.
150 &quot;reason&quot;: &quot;A String&quot;, # The specific reason for the compliance verdict. Must be empty if the status is compliant.
151 &quot;status&quot;: { # The status of a sender compliance requirement. # The compliance status.
152 &quot;status&quot;: &quot;A String&quot;, # Output only. The compliance status.
153 },
154 },
155 &quot;rowData&quot;: [ # Data for each of the rows of the table. Each message contains all the data that backs a single row.
156 { # Data for a single row of the compliance status table.
157 &quot;requirement&quot;: &quot;A String&quot;, # The compliance requirement.
158 &quot;status&quot;: { # The status of a sender compliance requirement. # The compliance status for the requirement.
159 &quot;status&quot;: &quot;A String&quot;, # Output only. The compliance status.
160 },
161 },
162 ],
163 },
164 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the domain&#x27;s compliance status. Format: `domains/{domain_id}/complianceStatus`.
165 &quot;subdomainComplianceData&quot;: { # Compliance data for a given domain. # Compliance data calculated specifically for the subdomain in `name`. This field is only populated if the domain in `name` is a subdomain that differs from its registrable domain (e.g., `sub.example.com`), and if compliance data is available for that specific subdomain.
166 &quot;domainId&quot;: &quot;A String&quot;, # Domain that this data is for.
167 &quot;honorUnsubscribeVerdict&quot;: { # Compliance verdict for whether a sender meets the unsubscribe honoring compliance requirement. # Unsubscribe honoring compliance verdict.
168 &quot;reason&quot;: &quot;A String&quot;, # The specific reason for the compliance verdict. Must be empty if the status is compliant.
169 &quot;status&quot;: { # The status of a sender compliance requirement. # The compliance status.
170 &quot;status&quot;: &quot;A String&quot;, # Output only. The compliance status.
171 },
172 },
173 &quot;oneClickUnsubscribeVerdict&quot;: { # Compliance verdict for whether a sender meets the one-click unsubscribe compliance requirement. # One-click unsubscribe compliance verdict.
174 &quot;reason&quot;: &quot;A String&quot;, # The specific reason for the compliance verdict. Must be empty if the status is compliant.
175 &quot;status&quot;: { # The status of a sender compliance requirement. # The compliance status.
176 &quot;status&quot;: &quot;A String&quot;, # Output only. The compliance status.
177 },
178 },
179 &quot;rowData&quot;: [ # Data for each of the rows of the table. Each message contains all the data that backs a single row.
180 { # Data for a single row of the compliance status table.
181 &quot;requirement&quot;: &quot;A String&quot;, # The compliance requirement.
182 &quot;status&quot;: { # The status of a sender compliance requirement. # The compliance status for the requirement.
183 &quot;status&quot;: &quot;A String&quot;, # Output only. The compliance status.
184 },
185 },
186 ],
187 },
188 }</pre>
189 </div>
190
191 <div class="method">
192 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
193 <pre>Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list.
194
195 Args:
196 pageSize: integer, Optional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200.
197 pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203 Returns:
204 An object of the form:
205
206 { # Response message for ListDomains.
207 &quot;domains&quot;: [ # The domains that have been registered by the user.
208 { # Information about a domain registered by the user.
209 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Immutable. The timestamp at which the domain was added to the user&#x27;s account.
210 &quot;lastVerifyTime&quot;: &quot;A String&quot;, # The timestamp at which the domain was last verified by the user.
211 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the domain. Format: `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).
212 &quot;permission&quot;: &quot;A String&quot;, # Output only. User&#x27;s permission of this domain.
213 &quot;verificationState&quot;: &quot;A String&quot;, # Output only. Information about a user&#x27;s verification history and properties for the domain.
214 },
215 ],
216 &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.
217 }</pre>
218 </div>
219
220 <div class="method">
221 <code class="details" id="list_next">list_next()</code>
222 <pre>Retrieves the next page of results.
223
224 Args:
225 previous_request: The request for the previous page. (required)
226 previous_response: The response from the request for the previous page. (required)
227
228 Returns:
229 A request object that you can call &#x27;execute()&#x27; on to request the next
230 page. Returns None if there are no more items in the collection.
231 </pre>
232 </div>
233
234 </body></html>