1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="mybusinessaccountmanagement_v1.html">My Business Account Management API</a> . <a href="mybusinessaccountmanagement_v1.accounts.html">accounts</a> . <a href="mybusinessaccountmanagement_v1.accounts.admins.html">admins</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Invites the specified user to become an administrator for the specified account. The invitee must accept the invitation in order to be granted access to the account. See AcceptInvitation to programmatically accept an invitation.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Removes the specified admin from the specified account.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists the admins for the specified account.</p> 89<p class="toc_element"> 90 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Updates the Admin for the specified Account Admin.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 100 <pre>Invites the specified user to become an administrator for the specified account. The invitee must accept the invitation in order to be granted access to the account. See AcceptInvitation to programmatically accept an invitation. 101 102Args: 103 parent: string, Required. The resource name of the account this admin is created for. `accounts/{account_id}`. (required) 104 body: object, The request body. 105 The object takes the form of: 106 107{ # An administrator of an Account or a location. 108 "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. 109 "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. 110 "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. 111 "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location. 112} 113 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # An administrator of an Account or a location. 123 "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. 124 "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. 125 "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. 126 "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location. 127}</pre> 128</div> 129 130<div class="method"> 131 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 132 <pre>Removes the specified admin from the specified account. 133 134Args: 135 name: string, Required. The resource name of the admin to remove from the account. `accounts/{account_id}/admins/{admin_id}`. (required) 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 145}</pre> 146</div> 147 148<div class="method"> 149 <code class="details" id="list">list(parent, x__xgafv=None)</code> 150 <pre>Lists the admins for the specified account. 151 152Args: 153 parent: string, Required. The name of the account from which to retrieve a list of admins. `accounts/{account_id}/admins`. (required) 154 x__xgafv: string, V1 error format. 155 Allowed values 156 1 - v1 error format 157 2 - v2 error format 158 159Returns: 160 An object of the form: 161 162 { # Response message for AccessControl.ListAccountAdmins. 163 "accountAdmins": [ # A collection of Admin instances. 164 { # An administrator of an Account or a location. 165 "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. 166 "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. 167 "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. 168 "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location. 169 }, 170 ], 171}</pre> 172</div> 173 174<div class="method"> 175 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 176 <pre>Updates the Admin for the specified Account Admin. 177 178Args: 179 name: string, Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. (required) 180 body: object, The request body. 181 The object takes the form of: 182 183{ # An administrator of an Account or a location. 184 "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. 185 "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. 186 "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. 187 "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location. 188} 189 190 updateMask: string, Required. The specific fields that should be updated. The only editable field is role. 191 x__xgafv: string, V1 error format. 192 Allowed values 193 1 - v1 error format 194 2 - v2 error format 195 196Returns: 197 An object of the form: 198 199 { # An administrator of an Account or a location. 200 "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. 201 "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. 202 "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. 203 "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location. 204}</pre> 205</div> 206 207</body></html>