162 lines
5.3 KiB
HTML
162 lines
5.3 KiB
HTML
<html><body>
|
||
<style>
|
||
|
||
body, h1, h2, h3, div, span, p, pre, a {
|
||
margin: 0;
|
||
padding: 0;
|
||
border: 0;
|
||
font-weight: inherit;
|
||
font-style: inherit;
|
||
font-size: 100%;
|
||
font-family: inherit;
|
||
vertical-align: baseline;
|
||
}
|
||
|
||
body {
|
||
font-size: 13px;
|
||
padding: 1em;
|
||
}
|
||
|
||
h1 {
|
||
font-size: 26px;
|
||
margin-bottom: 1em;
|
||
}
|
||
|
||
h2 {
|
||
font-size: 24px;
|
||
margin-bottom: 1em;
|
||
}
|
||
|
||
h3 {
|
||
font-size: 20px;
|
||
margin-bottom: 1em;
|
||
margin-top: 1em;
|
||
}
|
||
|
||
pre, code {
|
||
line-height: 1.5;
|
||
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
||
}
|
||
|
||
pre {
|
||
margin-top: 0.5em;
|
||
}
|
||
|
||
h1, h2, h3, p {
|
||
font-family: Arial, sans serif;
|
||
}
|
||
|
||
h1, h2, h3 {
|
||
border-bottom: solid #CCC 1px;
|
||
}
|
||
|
||
.toc_element {
|
||
margin-top: 0.5em;
|
||
}
|
||
|
||
.firstline {
|
||
margin-left: 2 em;
|
||
}
|
||
|
||
.method {
|
||
margin-top: 1em;
|
||
border: solid 1px #CCC;
|
||
padding: 1em;
|
||
background: #EEE;
|
||
}
|
||
|
||
.details {
|
||
font-weight: bold;
|
||
font-size: 14px;
|
||
}
|
||
|
||
</style>
|
||
|
||
<h1><a href="gmailpostmastertools_v1.html">Gmail Postmaster Tools API</a> . <a href="gmailpostmastertools_v1.domains.html">domains</a></h1>
|
||
<h2>Instance Methods</h2>
|
||
<p class="toc_element">
|
||
<code><a href="gmailpostmastertools_v1.domains.trafficStats.html">trafficStats()</a></code>
|
||
</p>
|
||
<p class="firstline">Returns the trafficStats Resource.</p>
|
||
|
||
<p class="toc_element">
|
||
<code><a href="#close">close()</a></code></p>
|
||
<p class="firstline">Close httplib2 connections.</p>
|
||
<p class="toc_element">
|
||
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
|
||
<p class="firstline">Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.</p>
|
||
<p class="toc_element">
|
||
<code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
|
||
<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>
|
||
<p class="toc_element">
|
||
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
||
<p class="firstline">Retrieves the next page of results.</p>
|
||
<h3>Method Details</h3>
|
||
<div class="method">
|
||
<code class="details" id="close">close()</code>
|
||
<pre>Close httplib2 connections.</pre>
|
||
</div>
|
||
|
||
<div class="method">
|
||
<code class="details" id="get">get(name, x__xgafv=None)</code>
|
||
<pre>Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.
|
||
|
||
Args:
|
||
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)
|
||
x__xgafv: string, V1 error format.
|
||
Allowed values
|
||
1 - v1 error format
|
||
2 - v2 error format
|
||
|
||
Returns:
|
||
An object of the form:
|
||
|
||
{ # A registered domain resource in the Postmaster API.
|
||
"createTime": "A String", # Timestamp when the user registered this domain. Assigned by the server.
|
||
"name": "A String", # 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).
|
||
"permission": "A String", # User’s permission for this domain. Assigned by the server.
|
||
}</pre>
|
||
</div>
|
||
|
||
<div class="method">
|
||
<code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
|
||
<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.
|
||
|
||
Args:
|
||
pageSize: integer, Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.
|
||
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.
|
||
x__xgafv: string, V1 error format.
|
||
Allowed values
|
||
1 - v1 error format
|
||
2 - v2 error format
|
||
|
||
Returns:
|
||
An object of the form:
|
||
|
||
{ # Response message for ListDomains.
|
||
"domains": [ # The list of domains.
|
||
{ # A registered domain resource in the Postmaster API.
|
||
"createTime": "A String", # Timestamp when the user registered this domain. Assigned by the server.
|
||
"name": "A String", # 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).
|
||
"permission": "A String", # User’s permission for this domain. Assigned by the server.
|
||
},
|
||
],
|
||
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
|
||
}</pre>
|
||
</div>
|
||
|
||
<div class="method">
|
||
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
||
<pre>Retrieves the next page of results.
|
||
|
||
Args:
|
||
previous_request: The request for the previous page. (required)
|
||
previous_response: The response from the request for the previous page. (required)
|
||
|
||
Returns:
|
||
A request object that you can call 'execute()' on to request the next
|
||
page. Returns None if there are no more items in the collection.
|
||
</pre>
|
||
</div>
|
||
|
||
</body></html> |