My Business Account Management API . locations . admins

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Invites the specified user to become an administrator for the specified location. The invitee must accept the invitation in order to be granted access to the location. See AcceptInvitation to programmatically accept an invitation.

Args:
  parent: string, Required. The resource name of the location this admin is created for. `locations/{location_id}/admins`. (required)
  body: object, The request body.
    The object takes the form of:

{ # An administrator of an Account or a location.
  "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling locations.admins.create to invite a LocationGroup as an admin. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`.
  "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.
  "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.
  "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource.
  "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An administrator of an Account or a location.
  "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling locations.admins.create to invite a LocationGroup as an admin. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`.
  "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.
  "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.
  "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource.
  "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location.
}

delete(name, x__xgafv=None)

Removes the specified admin as a manager of the specified location.

Args:
  name: string, Required. The resource name of the admin to remove from the location. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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); }
}

list(parent, x__xgafv=None)

Lists all of the admins for the specified location.

Args:
  parent: string, Required. The name of the location to list admins of. `locations/{location_id}/admins`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for AccessControl.ListLocationAdmins.
  "admins": [ # A collection of Admins.
    { # An administrator of an Account or a location.
      "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling locations.admins.create to invite a LocationGroup as an admin. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`.
      "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.
      "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.
      "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource.
      "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location.
    },
  ],
}

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the Admin for the specified location. Only the AdminRole of the Admin can be updated.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # An administrator of an Account or a location.
  "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling locations.admins.create to invite a LocationGroup as an admin. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`.
  "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.
  "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.
  "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource.
  "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location.
}

  updateMask: string, Required. The specific fields that should be updated. The only editable field is role.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An administrator of an Account or a location.
  "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling locations.admins.create to invite a LocationGroup as an admin. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`.
  "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.
  "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.
  "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource.
  "role": "A String", # Required. Specifies the role that this admin uses with the specified Account or Location.
}