Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1adde1a2b51f7de770d5100c99aa3e3b21a7f2d8 / . / docs / dyn / siteVerification.v1.webResource.html
blob: 1f702be6dcbbed38435e705ad1839de8c692cbdd [file] [log] [blame]
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Relinquish&nbsp;ownership&nbsp;of&nbsp;a&nbsp;website&nbsp;or&nbsp;domain.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;a&nbsp;verified&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)</tt></dd></dl>
21
22<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;the&nbsp;most&nbsp;current&nbsp;data&nbsp;for&nbsp;a&nbsp;website&nbsp;or&nbsp;domain.<br>
23&nbsp;<br>
24Args:<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]25&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;a&nbsp;verified&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)<br>
26&nbsp;<br>
27Returns:<br>
28&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
29&nbsp;<br>
30&nbsp;&nbsp;&nbsp;&nbsp;{<br>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
32&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
33&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
39&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]40
41<dl><dt><a name="Resource-getToken"><strong>getToken</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;verification&nbsp;token&nbsp;for&nbsp;placing&nbsp;on&nbsp;a&nbsp;website&nbsp;or&nbsp;domain.<br>
42&nbsp;<br>
43Args:<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]44&nbsp;&nbsp;verificationMethod:&nbsp;string,&nbsp;The&nbsp;method&nbsp;to&nbsp;use&nbsp;for&nbsp;verifying&nbsp;a&nbsp;site&nbsp;or&nbsp;domain.<br>
45&nbsp;&nbsp;identifier:&nbsp;string,&nbsp;The&nbsp;URL&nbsp;or&nbsp;domain&nbsp;to&nbsp;verify.<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]46&nbsp;&nbsp;type:&nbsp;string,&nbsp;Type&nbsp;of&nbsp;resource&nbsp;to&nbsp;verify.&nbsp;Can&nbsp;be&nbsp;'site'&nbsp;(URL)&nbsp;or&nbsp;'inet_domain'&nbsp;(domain&nbsp;name).<br>
47&nbsp;<br>
48Returns:<br>
49&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
50&nbsp;<br>
51&nbsp;&nbsp;&nbsp;&nbsp;{<br>
52&nbsp;&nbsp;&nbsp;&nbsp;"token":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;verification&nbsp;token.&nbsp;The&nbsp;token&nbsp;must&nbsp;be&nbsp;placed&nbsp;appropriately&nbsp;in&nbsp;order&nbsp;for&nbsp;verification&nbsp;to&nbsp;succeed.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;"method":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;verification&nbsp;method&nbsp;to&nbsp;use&nbsp;in&nbsp;conjunction&nbsp;with&nbsp;this&nbsp;token.&nbsp;For&nbsp;FILE,&nbsp;the&nbsp;token&nbsp;should&nbsp;be&nbsp;placed&nbsp;in&nbsp;the&nbsp;top-level&nbsp;directory&nbsp;of&nbsp;the&nbsp;site,&nbsp;stored&nbsp;inside&nbsp;a&nbsp;file&nbsp;of&nbsp;the&nbsp;same&nbsp;name.&nbsp;For&nbsp;META,&nbsp;the&nbsp;token&nbsp;should&nbsp;be&nbsp;placed&nbsp;in&nbsp;the&nbsp;HEAD&nbsp;tag&nbsp;of&nbsp;the&nbsp;default&nbsp;page&nbsp;that&nbsp;is&nbsp;loaded&nbsp;for&nbsp;the&nbsp;site.&nbsp;For&nbsp;DNS,&nbsp;the&nbsp;token&nbsp;should&nbsp;be&nbsp;placed&nbsp;in&nbsp;a&nbsp;TXT&nbsp;record&nbsp;of&nbsp;the&nbsp;domain.<br>
54&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]55
56<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Attempt&nbsp;verification&nbsp;of&nbsp;a&nbsp;website&nbsp;or&nbsp;domain.<br>
57&nbsp;<br>
58Args:<br>
59&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]60&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
61&nbsp;<br>
62{<br>
63&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
65&nbsp;&nbsp;&nbsp;&nbsp;],<br>
66&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
67&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
68&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
69&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
70&nbsp;&nbsp;&nbsp;&nbsp;},<br>
71&nbsp;&nbsp;}<br>
72&nbsp;<br>
73&nbsp;&nbsp;verificationMethod:&nbsp;string,&nbsp;The&nbsp;method&nbsp;to&nbsp;use&nbsp;for&nbsp;verifying&nbsp;a&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)<br>
74&nbsp;<br>
75Returns:<br>
76&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
77&nbsp;<br>
78&nbsp;&nbsp;&nbsp;&nbsp;{<br>
79&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
87&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]88
89<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;the&nbsp;list&nbsp;of&nbsp;your&nbsp;verified&nbsp;websites&nbsp;and&nbsp;domains.<br>
90&nbsp;<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]91Args:<br>
92&nbsp;<br>
93Returns:<br>
94&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
95&nbsp;<br>
96&nbsp;&nbsp;&nbsp;&nbsp;{<br>
97&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;list&nbsp;of&nbsp;sites&nbsp;that&nbsp;are&nbsp;owned&nbsp;by&nbsp;the&nbsp;authenticated&nbsp;user.<br>
98&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
99&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
100&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
104&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
105&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
108&nbsp;&nbsp;&nbsp;&nbsp;],<br>
109&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]110
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]111<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Modify&nbsp;the&nbsp;list&nbsp;of&nbsp;owners&nbsp;for&nbsp;your&nbsp;website&nbsp;or&nbsp;domain.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
112&nbsp;<br>
113Args:<br>
114&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]115&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
116&nbsp;<br>
117{<br>
118&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
119&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
120&nbsp;&nbsp;&nbsp;&nbsp;],<br>
121&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
122&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
124&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
125&nbsp;&nbsp;&nbsp;&nbsp;},<br>
126&nbsp;&nbsp;}<br>
127&nbsp;<br>
128&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;a&nbsp;verified&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)<br>
129&nbsp;<br>
130Returns:<br>
131&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
132&nbsp;<br>
133&nbsp;&nbsp;&nbsp;&nbsp;{<br>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
142&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]143
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]144<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Modify&nbsp;the&nbsp;list&nbsp;of&nbsp;owners&nbsp;for&nbsp;your&nbsp;website&nbsp;or&nbsp;domain.<br>
145&nbsp;<br>
146Args:<br>
147&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]148&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
149&nbsp;<br>
150{<br>
151&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
153&nbsp;&nbsp;&nbsp;&nbsp;],<br>
154&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
155&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
158&nbsp;&nbsp;&nbsp;&nbsp;},<br>
159&nbsp;&nbsp;}<br>
160&nbsp;<br>
161&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;a&nbsp;verified&nbsp;site&nbsp;or&nbsp;domain.&nbsp;(required)<br>
162&nbsp;<br>
163Returns:<br>
164&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
165&nbsp;<br>
166&nbsp;&nbsp;&nbsp;&nbsp;{<br>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owners":&nbsp;[&nbsp;#&nbsp;The&nbsp;email&nbsp;addresses&nbsp;of&nbsp;all&nbsp;verified&nbsp;owners.<br>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;string&nbsp;used&nbsp;to&nbsp;identify&nbsp;this&nbsp;site.&nbsp;This&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;in&nbsp;the&nbsp;"id"&nbsp;portion&nbsp;of&nbsp;the&nbsp;REST&nbsp;URL&nbsp;for&nbsp;the&nbsp;Get,&nbsp;Update,&nbsp;and&nbsp;Delete&nbsp;operations.<br>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site":&nbsp;{&nbsp;#&nbsp;The&nbsp;address&nbsp;and&nbsp;type&nbsp;of&nbsp;a&nbsp;site&nbsp;that&nbsp;is&nbsp;verified&nbsp;or&nbsp;will&nbsp;be&nbsp;verified.<br>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"identifier":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;identifier.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;SITE,&nbsp;the&nbsp;identifier&nbsp;is&nbsp;a&nbsp;URL.&nbsp;If&nbsp;the&nbsp;type&nbsp;is&nbsp;set&nbsp;to&nbsp;INET_DOMAIN,&nbsp;the&nbsp;site&nbsp;identifier&nbsp;is&nbsp;a&nbsp;domain&nbsp;name.<br>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;type.&nbsp;Can&nbsp;be&nbsp;SITE&nbsp;or&nbsp;INET_DOMAIN&nbsp;(domain&nbsp;name).<br>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
175&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]176
177<hr>
178Data descriptors defined here:<br>
179<dl><dt><strong>__dict__</strong></dt>
180<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
181</dl>
182<dl><dt><strong>__weakref__</strong></dt>
183<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
184</dl>
185</td></tr></table>
186</body></html>