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