| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: class Resource</title> |
| </head><body bgcolor="#f0f0f8"> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Relinquish ownership of a website or domain.<br> |
| <br> |
| Args:<br> |
| id: string, The id of a verified site or domain. (required)</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get the most current data for a website or domain.<br> |
| <br> |
| Args:<br> |
| id: string, The id of a verified site or domain. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "owners": [ # The email addresses of all verified owners.<br> |
| "A String",<br> |
| ],<br> |
| "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.<br> |
| "site": { # The address and type of a site that is verified or will be verified.<br> |
| "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.<br> |
| "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).<br> |
| },<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-getToken"><strong>getToken</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a verification token for placing on a website or domain.<br> |
| <br> |
| Args:<br> |
| verificationMethod: string, The method to use for verifying a site or domain.<br> |
| identifier: string, The URL or domain to verify.<br> |
| type: string, Type of resource to verify. Can be 'site' (URL) or 'inet_domain' (domain name).<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "token": "A String", # The verification token. The token must be placed appropriately in order for verification to succeed.<br> |
| "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.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Attempt verification of a website or domain.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "owners": [ # The email addresses of all verified owners.<br> |
| "A String",<br> |
| ],<br> |
| "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.<br> |
| "site": { # The address and type of a site that is verified or will be verified.<br> |
| "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.<br> |
| "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).<br> |
| },<br> |
| }<br> |
| <br> |
| verificationMethod: string, The method to use for verifying a site or domain. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "owners": [ # The email addresses of all verified owners.<br> |
| "A String",<br> |
| ],<br> |
| "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.<br> |
| "site": { # The address and type of a site that is verified or will be verified.<br> |
| "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.<br> |
| "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).<br> |
| },<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Get the list of your verified websites and domains.<br> |
| <br> |
| Args:<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "items": [ # The list of sites that are owned by the authenticated user.<br> |
| {<br> |
| "owners": [ # The email addresses of all verified owners.<br> |
| "A String",<br> |
| ],<br> |
| "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.<br> |
| "site": { # The address and type of a site that is verified or will be verified.<br> |
| "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.<br> |
| "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).<br> |
| },<br> |
| },<br> |
| ],<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Modify the list of owners for your website or domain. This method supports patch semantics.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "owners": [ # The email addresses of all verified owners.<br> |
| "A String",<br> |
| ],<br> |
| "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.<br> |
| "site": { # The address and type of a site that is verified or will be verified.<br> |
| "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.<br> |
| "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).<br> |
| },<br> |
| }<br> |
| <br> |
| id: string, The id of a verified site or domain. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "owners": [ # The email addresses of all verified owners.<br> |
| "A String",<br> |
| ],<br> |
| "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.<br> |
| "site": { # The address and type of a site that is verified or will be verified.<br> |
| "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.<br> |
| "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).<br> |
| },<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Modify the list of owners for your website or domain.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "owners": [ # The email addresses of all verified owners.<br> |
| "A String",<br> |
| ],<br> |
| "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.<br> |
| "site": { # The address and type of a site that is verified or will be verified.<br> |
| "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.<br> |
| "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).<br> |
| },<br> |
| }<br> |
| <br> |
| id: string, The id of a verified site or domain. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "owners": [ # The email addresses of all verified owners.<br> |
| "A String",<br> |
| ],<br> |
| "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.<br> |
| "site": { # The address and type of a site that is verified or will be verified.<br> |
| "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.<br> |
| "type": "A String", # The site type. Can be SITE or INET_DOMAIN (domain name).<br> |
| },<br> |
| }</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |