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="plusDomains_v1.html">Google+ Domains API</a> . <a href="plusDomains_v1.circles.html">circles</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#addPeople">addPeople(circleId, userId=None, email=None)</a></code></p> 79 <p class="firstline">Add a person to a circle. Google+ limits certain circle operations, including the number of circle adds. Learn More.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(circleId)</a></code></p> 82 <p class="firstline">Get a circle.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(userId, body)</a></code></p> 85 <p class="firstline">Create a new circle for the authenticated user.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(userId, pageToken=None, maxResults=None)</a></code></p> 88 <p class="firstline">List all of the circles for a user.</p> 89 <p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91 <p class="firstline">Retrieves the next page of results.</p> 92 <p class="toc_element"> 93 <code><a href="#patch">patch(circleId, body)</a></code></p> 94 <p class="firstline">Update a circle's description. This method supports patch semantics.</p> 95 <p class="toc_element"> 96 <code><a href="#remove">remove(circleId)</a></code></p> 97 <p class="firstline">Delete a circle.</p> 98 <p class="toc_element"> 99 <code><a href="#removePeople">removePeople(circleId, userId=None, email=None)</a></code></p> 100 <p class="firstline">Remove a person from a circle.</p> 101 <p class="toc_element"> 102 <code><a href="#update">update(circleId, body)</a></code></p> 103 <p class="firstline">Update a circle's description.</p> 104 <h3>Method Details</h3> 105 <div class="method"> 106 <code class="details" id="addPeople">addPeople(circleId, userId=None, email=None)</code> 107 <pre>Add a person to a circle. Google+ limits certain circle operations, including the number of circle adds. Learn More. 108 109 Args: 110 circleId: string, The ID of the circle to add the person to. (required) 111 userId: string, IDs of the people to add to the circle. Optional, can be repeated. (repeated) 112 email: string, Email of the people to add to the circle. Optional, can be repeated. (repeated) 113 114 Returns: 115 An object of the form: 116 117 { 118 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 119 "displayName": "A String", # The circle name. 120 "description": "A String", # The description of this circle. 121 "people": { # The people in this circle. 122 "totalItems": 42, # The total number of people in this circle. 123 }, 124 "etag": "A String", # ETag of this response for caching purposes. 125 "id": "A String", # The ID of the circle. 126 "selfLink": "A String", # Link to this circle resource 127 }</pre> 128 </div> 129 130 <div class="method"> 131 <code class="details" id="get">get(circleId)</code> 132 <pre>Get a circle. 133 134 Args: 135 circleId: string, The ID of the circle to get. (required) 136 137 Returns: 138 An object of the form: 139 140 { 141 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 142 "displayName": "A String", # The circle name. 143 "description": "A String", # The description of this circle. 144 "people": { # The people in this circle. 145 "totalItems": 42, # The total number of people in this circle. 146 }, 147 "etag": "A String", # ETag of this response for caching purposes. 148 "id": "A String", # The ID of the circle. 149 "selfLink": "A String", # Link to this circle resource 150 }</pre> 151 </div> 152 153 <div class="method"> 154 <code class="details" id="insert">insert(userId, body)</code> 155 <pre>Create a new circle for the authenticated user. 156 157 Args: 158 userId: string, The ID of the user to create the circle on behalf of. The value "me" can be used to indicate the authenticated user. (required) 159 body: object, The request body. (required) 160 The object takes the form of: 161 162 { 163 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 164 "displayName": "A String", # The circle name. 165 "description": "A String", # The description of this circle. 166 "people": { # The people in this circle. 167 "totalItems": 42, # The total number of people in this circle. 168 }, 169 "etag": "A String", # ETag of this response for caching purposes. 170 "id": "A String", # The ID of the circle. 171 "selfLink": "A String", # Link to this circle resource 172 } 173 174 175 Returns: 176 An object of the form: 177 178 { 179 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 180 "displayName": "A String", # The circle name. 181 "description": "A String", # The description of this circle. 182 "people": { # The people in this circle. 183 "totalItems": 42, # The total number of people in this circle. 184 }, 185 "etag": "A String", # ETag of this response for caching purposes. 186 "id": "A String", # The ID of the circle. 187 "selfLink": "A String", # Link to this circle resource 188 }</pre> 189 </div> 190 191 <div class="method"> 192 <code class="details" id="list">list(userId, pageToken=None, maxResults=None)</code> 193 <pre>List all of the circles for a user. 194 195 Args: 196 userId: string, The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user. (required) 197 pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. 198 maxResults: integer, The maximum number of circles to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. 199 200 Returns: 201 An object of the form: 202 203 { 204 "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. 205 "kind": "plus#circleFeed", # Identifies this resource as a collection of circles. Value: "plus#circleFeed". 206 "title": "A String", # The title of this list of resources. 207 "items": [ # The circles in this page of results. 208 { 209 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 210 "displayName": "A String", # The circle name. 211 "description": "A String", # The description of this circle. 212 "people": { # The people in this circle. 213 "totalItems": 42, # The total number of people in this circle. 214 }, 215 "etag": "A String", # ETag of this response for caching purposes. 216 "id": "A String", # The ID of the circle. 217 "selfLink": "A String", # Link to this circle resource 218 }, 219 ], 220 "nextLink": "A String", # Link to the next page of circles. 221 "etag": "A String", # ETag of this response for caching purposes. 222 "totalItems": 42, # The total number of circles. The number of circles in this response may be smaller due to paging. 223 "selfLink": "A String", # Link to this page of circles. 224 }</pre> 225 </div> 226 227 <div class="method"> 228 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 229 <pre>Retrieves the next page of results. 230 231 Args: 232 previous_request: The request for the previous page. (required) 233 previous_response: The response from the request for the previous page. (required) 234 235 Returns: 236 A request object that you can call 'execute()' on to request the next 237 page. Returns None if there are no more items in the collection. 238 </pre> 239 </div> 240 241 <div class="method"> 242 <code class="details" id="patch">patch(circleId, body)</code> 243 <pre>Update a circle's description. This method supports patch semantics. 244 245 Args: 246 circleId: string, The ID of the circle to update. (required) 247 body: object, The request body. (required) 248 The object takes the form of: 249 250 { 251 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 252 "displayName": "A String", # The circle name. 253 "description": "A String", # The description of this circle. 254 "people": { # The people in this circle. 255 "totalItems": 42, # The total number of people in this circle. 256 }, 257 "etag": "A String", # ETag of this response for caching purposes. 258 "id": "A String", # The ID of the circle. 259 "selfLink": "A String", # Link to this circle resource 260 } 261 262 263 Returns: 264 An object of the form: 265 266 { 267 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 268 "displayName": "A String", # The circle name. 269 "description": "A String", # The description of this circle. 270 "people": { # The people in this circle. 271 "totalItems": 42, # The total number of people in this circle. 272 }, 273 "etag": "A String", # ETag of this response for caching purposes. 274 "id": "A String", # The ID of the circle. 275 "selfLink": "A String", # Link to this circle resource 276 }</pre> 277 </div> 278 279 <div class="method"> 280 <code class="details" id="remove">remove(circleId)</code> 281 <pre>Delete a circle. 282 283 Args: 284 circleId: string, The ID of the circle to delete. (required) 285 </pre> 286 </div> 287 288 <div class="method"> 289 <code class="details" id="removePeople">removePeople(circleId, userId=None, email=None)</code> 290 <pre>Remove a person from a circle. 291 292 Args: 293 circleId: string, The ID of the circle to remove the person from. (required) 294 userId: string, IDs of the people to remove from the circle. Optional, can be repeated. (repeated) 295 email: string, Email of the people to add to the circle. Optional, can be repeated. (repeated) 296 </pre> 297 </div> 298 299 <div class="method"> 300 <code class="details" id="update">update(circleId, body)</code> 301 <pre>Update a circle's description. 302 303 Args: 304 circleId: string, The ID of the circle to update. (required) 305 body: object, The request body. (required) 306 The object takes the form of: 307 308 { 309 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 310 "displayName": "A String", # The circle name. 311 "description": "A String", # The description of this circle. 312 "people": { # The people in this circle. 313 "totalItems": 42, # The total number of people in this circle. 314 }, 315 "etag": "A String", # ETag of this response for caching purposes. 316 "id": "A String", # The ID of the circle. 317 "selfLink": "A String", # Link to this circle resource 318 } 319 320 321 Returns: 322 An object of the form: 323 324 { 325 "kind": "plus#circle", # Identifies this resource as a circle. Value: "plus#circle". 326 "displayName": "A String", # The circle name. 327 "description": "A String", # The description of this circle. 328 "people": { # The people in this circle. 329 "totalItems": 42, # The total number of people in this circle. 330 }, 331 "etag": "A String", # ETag of this response for caching purposes. 332 "id": "A String", # The ID of the circle. 333 "selfLink": "A String", # Link to this circle resource 334 }</pre> 335 </div> 336 337 </body></html>
