Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / siteVerification_v1.webResource.html
blob: 97b6f4724da7a1fdf9ccd0863ca742969a803e8a [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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="siteVerification_v1.html">Google Site Verification API</a> . <a href="siteVerification_v1.webResource.html">webResource</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-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>
80<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]81 <code><a href="#delete">delete(id)</a></code></p>
82<p class="firstline">Relinquish ownership of a website or domain.</p>
83<p class="toc_element">
84 <code><a href="#get">get(id)</a></code></p>
85<p class="firstline">Get the most current data for a website or domain.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code><a href="#getToken">getToken(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Get a verification token for placing on a website or domain.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#insert">insert(verificationMethod, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Attempt verification of a website or domain.</p>
92<p class="toc_element">
93 <code><a href="#list">list()</a></code></p>
94<p class="firstline">Get the list of your verified websites and domains.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#patch">patch(id, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]97<p class="firstline">Modify the list of owners for your website or domain. This method supports patch semantics.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#update">update(id, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]100<p class="firstline">Modify the list of owners for your website or domain.</p>
101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108 <code class="details" id="delete">delete(id)</code>
109 <pre>Relinquish ownership of a website or domain.
110
111Args:
112 id: string, The id of a verified site or domain. (required)
113</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="get">get(id)</code>
118 <pre>Get the most current data for a website or domain.
119
120Args:
121 id: string, The id of a verified site or domain. (required)
122
123Returns:
124 An object of the form:
125
126 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]127 &quot;owners&quot;: [ # The email addresses of all verified owners.
128 &quot;A String&quot;,
129 ],
130 &quot;id&quot;: &quot;A String&quot;, # The string used to identify this site. This value should be used in the &quot;id&quot; portion of the REST URL for the Get, Update, and Delete operations.
131 &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
132 &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
133 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
134 },
135 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136</div>
137
138<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]139 <code class="details" id="getToken">getToken(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]140 <pre>Get a verification token for placing on a website or domain.
141
142Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 The object takes the form of:
145
146{
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;verificationMethod&quot;: &quot;A String&quot;, # The verification method that will be used to verify this site. For sites, &#x27;FILE&#x27; or &#x27;META&#x27; methods may be used. For domains, only &#x27;DNS&#x27; may be used.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]148 &quot;site&quot;: { # The site for which a verification token will be generated.
149 &quot;type&quot;: &quot;A String&quot;, # The type of resource to be verified. Can be SITE or INET_DOMAIN (domain name).
150 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
151 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152 }
153
154
155Returns:
156 An object of the form:
157
158 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;token&quot;: &quot;A String&quot;, # The verification token. The token must be placed appropriately in order for verification to succeed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]160 &quot;method&quot;: &quot;A String&quot;, # The verification method to use in conjunction with this token. For FILE, the token should be placed in the top-level directory of the site, stored inside a file of the same name. For META, the token should be placed in the HEAD tag of the default page that is loaded for the site. For DNS, the token should be placed in a TXT record of the domain.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 }</pre>
162</div>
163
164<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]165 <code class="details" id="insert">insert(verificationMethod, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]166 <pre>Attempt verification of a website or domain.
167
168Args:
169 verificationMethod: string, The method to use for verifying a site or domain. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]170 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 The object takes the form of:
172
173{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]174 &quot;owners&quot;: [ # The email addresses of all verified owners.
175 &quot;A String&quot;,
176 ],
177 &quot;id&quot;: &quot;A String&quot;, # The string used to identify this site. This value should be used in the &quot;id&quot; portion of the REST URL for the Get, Update, and Delete operations.
178 &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
179 &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
180 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
181 },
182 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]183
184
185Returns:
186 An object of the form:
187
188 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]189 &quot;owners&quot;: [ # The email addresses of all verified owners.
190 &quot;A String&quot;,
191 ],
192 &quot;id&quot;: &quot;A String&quot;, # The string used to identify this site. This value should be used in the &quot;id&quot; portion of the REST URL for the Get, Update, and Delete operations.
193 &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
194 &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
195 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
196 },
197 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]198</div>
199
200<div class="method">
201 <code class="details" id="list">list()</code>
202 <pre>Get the list of your verified websites and domains.
203
204Args:
205
206Returns:
207 An object of the form:
208
209 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 &quot;items&quot;: [ # The list of sites that are owned by the authenticated user.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]212 &quot;owners&quot;: [ # The email addresses of all verified owners.
213 &quot;A String&quot;,
214 ],
215 &quot;id&quot;: &quot;A String&quot;, # The string used to identify this site. This value should be used in the &quot;id&quot; portion of the REST URL for the Get, Update, and Delete operations.
216 &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
217 &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
218 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
219 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]220 },
221 ],
222 }</pre>
223</div>
224
225<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]226 <code class="details" id="patch">patch(id, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]227 <pre>Modify the list of owners for your website or domain. This method supports patch semantics.
228
229Args:
230 id: string, The id of a verified site or domain. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]231 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]232 The object takes the form of:
233
234{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]235 &quot;owners&quot;: [ # The email addresses of all verified owners.
236 &quot;A String&quot;,
237 ],
238 &quot;id&quot;: &quot;A String&quot;, # The string used to identify this site. This value should be used in the &quot;id&quot; portion of the REST URL for the Get, Update, and Delete operations.
239 &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
240 &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
241 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
242 },
243 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244
245
246Returns:
247 An object of the form:
248
249 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]250 &quot;owners&quot;: [ # The email addresses of all verified owners.
251 &quot;A String&quot;,
252 ],
253 &quot;id&quot;: &quot;A String&quot;, # The string used to identify this site. This value should be used in the &quot;id&quot; portion of the REST URL for the Get, Update, and Delete operations.
254 &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
255 &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
256 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
257 },
258 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]259</div>
260
261<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]262 <code class="details" id="update">update(id, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]263 <pre>Modify the list of owners for your website or domain.
264
265Args:
266 id: string, The id of a verified site or domain. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]267 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 The object takes the form of:
269
270{
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]271 &quot;owners&quot;: [ # The email addresses of all verified owners.
272 &quot;A String&quot;,
273 ],
274 &quot;id&quot;: &quot;A String&quot;, # The string used to identify this site. This value should be used in the &quot;id&quot; portion of the REST URL for the Get, Update, and Delete operations.
275 &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
276 &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
277 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
278 },
279 }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280
281
282Returns:
283 An object of the form:
284
285 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]286 &quot;owners&quot;: [ # The email addresses of all verified owners.
287 &quot;A String&quot;,
288 ],
289 &quot;id&quot;: &quot;A String&quot;, # The string used to identify this site. This value should be used in the &quot;id&quot; portion of the REST URL for the Get, Update, and Delete operations.
290 &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
291 &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
292 &quot;identifier&quot;: &quot;A String&quot;, # The site identifier. If the type is set to SITE, the identifier is a URL. If the type is set to INET_DOMAIN, the site identifier is a domain name.
293 },
294 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]295</div>
296
297</body></html>