File: siteVerification_v1.webResource.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (297 lines) | stat: -rw-r--r-- 11,532 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<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="siteVerification_v1.html">Google Site Verification API</a> . <a href="siteVerification_v1.webResource.html">webResource</a></h1>
<h2>Instance Methods</h2>
<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="#delete">delete(id)</a></code></p>
<p class="firstline">Relinquish ownership of a website or domain.</p>
<p class="toc_element">
  <code><a href="#get">get(id)</a></code></p>
<p class="firstline">Get the most current data for a website or domain.</p>
<p class="toc_element">
  <code><a href="#getToken">getToken(body=None)</a></code></p>
<p class="firstline">Get a verification token for placing on a website or domain.</p>
<p class="toc_element">
  <code><a href="#insert">insert(verificationMethod, body=None)</a></code></p>
<p class="firstline">Attempt verification of a website or domain.</p>
<p class="toc_element">
  <code><a href="#list">list()</a></code></p>
<p class="firstline">Get the list of your verified websites and domains.</p>
<p class="toc_element">
  <code><a href="#patch">patch(id, body=None)</a></code></p>
<p class="firstline">Modify the list of owners for your website or domain. This method supports patch semantics.</p>
<p class="toc_element">
  <code><a href="#update">update(id, body=None)</a></code></p>
<p class="firstline">Modify the list of owners for your website or domain.</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="delete">delete(id)</code>
  <pre>Relinquish ownership of a website or domain.

Args:
  id: string, The id of a verified site or domain. (required)
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(id)</code>
  <pre>Get the most current data for a website or domain.

Args:
  id: string, The id of a verified site or domain. (required)

Returns:
  An object of the form:

    {
  &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.
  &quot;owners&quot;: [ # The email addresses of all verified owners.
    &quot;A String&quot;,
  ],
  &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
    &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.
    &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="getToken">getToken(body=None)</code>
  <pre>Get a verification token for placing on a website or domain.

Args:
  body: object, The request body.
    The object takes the form of:

{
  &quot;site&quot;: { # The site for which a verification token will be generated.
    &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.
    &quot;type&quot;: &quot;A String&quot;, # The type of resource to be verified. Can be SITE or INET_DOMAIN (domain name).
  },
  &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.
}


Returns:
  An object of the form:

    {
  &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.
  &quot;token&quot;: &quot;A String&quot;, # The verification token. The token must be placed appropriately in order for verification to succeed.
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(verificationMethod, body=None)</code>
  <pre>Attempt verification of a website or domain.

Args:
  verificationMethod: string, The method to use for verifying a site or domain. (required)
  body: object, The request body.
    The object takes the form of:

{
  &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.
  &quot;owners&quot;: [ # The email addresses of all verified owners.
    &quot;A String&quot;,
  ],
  &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
    &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.
    &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
  },
}


Returns:
  An object of the form:

    {
  &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.
  &quot;owners&quot;: [ # The email addresses of all verified owners.
    &quot;A String&quot;,
  ],
  &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
    &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.
    &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list()</code>
  <pre>Get the list of your verified websites and domains.

Args:

Returns:
  An object of the form:

    {
  &quot;items&quot;: [ # The list of sites that are owned by the authenticated user.
    {
      &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.
      &quot;owners&quot;: [ # The email addresses of all verified owners.
        &quot;A String&quot;,
      ],
      &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
        &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.
        &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
      },
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(id, body=None)</code>
  <pre>Modify the list of owners for your website or domain. This method supports patch semantics.

Args:
  id: string, The id of a verified site or domain. (required)
  body: object, The request body.
    The object takes the form of:

{
  &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.
  &quot;owners&quot;: [ # The email addresses of all verified owners.
    &quot;A String&quot;,
  ],
  &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
    &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.
    &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
  },
}


Returns:
  An object of the form:

    {
  &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.
  &quot;owners&quot;: [ # The email addresses of all verified owners.
    &quot;A String&quot;,
  ],
  &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
    &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.
    &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(id, body=None)</code>
  <pre>Modify the list of owners for your website or domain.

Args:
  id: string, The id of a verified site or domain. (required)
  body: object, The request body.
    The object takes the form of:

{
  &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.
  &quot;owners&quot;: [ # The email addresses of all verified owners.
    &quot;A String&quot;,
  ],
  &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
    &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.
    &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
  },
}


Returns:
  An object of the form:

    {
  &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.
  &quot;owners&quot;: [ # The email addresses of all verified owners.
    &quot;A String&quot;,
  ],
  &quot;site&quot;: { # The address and type of a site that is verified or will be verified.
    &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.
    &quot;type&quot;: &quot;A String&quot;, # The site type. Can be SITE or INET_DOMAIN (domain name).
  },
}</pre>
</div>

</body></html>