| 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></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"> |
| 83 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Gets a specific domain registered by the client.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Lists the domains that have been registered by the client. The order of</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 90 | <p class="firstline">Retrieves the next page of results.</p> |
| 91 | <h3>Method Details</h3> |
| 92 | <div class="method"> |
| 93 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 94 | <pre>Gets a specific domain registered by the client. |
| 95 | Returns NOT_FOUND if the domain does not exist. |
| 96 | |
| 97 | Args: |
| 98 | name: string, The resource name of the domain. It should have the form |
| 99 | `domains/{domain_name}`, where domain_name is the fully qualified |
| 100 | domain name. (required) |
| 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 | { # A registered domain resource in the Postmaster API. |
| 110 | "permission": "A String", # User’s permission for this domain. Assigned by the server. |
| 111 | "name": "A String", # The resource name of the Domain. |
| 112 | # Domain names have the form `domains/{domain_name}`, where domain_name |
| 113 | # is the fully qualified domain name (i.e., mymail.mydomain.com). |
| 114 | "createTime": "A String", # Timestamp when the user registered this domain. Assigned by |
| 115 | # the server. |
| 116 | }</pre> |
| 117 | </div> |
| 118 | |
| 119 | <div class="method"> |
| 120 | <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 121 | <pre>Lists the domains that have been registered by the client. The order of |
| 122 | domains in the response is unspecified and non-deterministic. Newly created |
| 123 | domains will not necessarily be added to the end of this list. |
| 124 | |
| 125 | Args: |
| 126 | pageSize: integer, Requested page size. Server may return fewer domains than requested. |
| 127 | If unspecified, server will pick an appropriate default. |
| 128 | pageToken: string, The next_page_token value returned from a previous List request, if any. |
| 129 | This is the value of |
| 130 | ListDomainsResponse.next_page_token |
| 131 | returned from the previous call to `ListDomains` method. |
| 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 | { # Response message for ListDomains. |
| 141 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no |
| 142 | # more results in the list. |
| 143 | "domains": [ # The list of domains. |
| 144 | { # A registered domain resource in the Postmaster API. |
| 145 | "permission": "A String", # User’s permission for this domain. Assigned by the server. |
| 146 | "name": "A String", # The resource name of the Domain. |
| 147 | # Domain names have the form `domains/{domain_name}`, where domain_name |
| 148 | # is the fully qualified domain name (i.e., mymail.mydomain.com). |
| 149 | "createTime": "A String", # Timestamp when the user registered this domain. Assigned by |
| 150 | # the server. |
| 151 | }, |
| 152 | ], |
| 153 | }</pre> |
| 154 | </div> |
| 155 | |
| 156 | <div class="method"> |
| 157 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 158 | <pre>Retrieves the next page of results. |
| 159 | |
| 160 | Args: |
| 161 | previous_request: The request for the previous page. (required) |
| 162 | previous_response: The response from the request for the previous page. (required) |
| 163 | |
| 164 | Returns: |
| 165 | A request object that you can call 'execute()' on to request the next |
| 166 | page. Returns None if there are no more items in the collection. |
| 167 | </pre> |
| 168 | </div> |
| 169 | |
| 170 | </body></html> |