class LocationsAdmins extends Resource (View source)

The "admins" collection of methods.

Typical usage is:

 $mybusinessaccountmanagementService = new Google\Service\MyBusinessAccountManagement(...);
 $admins = $mybusinessaccountmanagementService->locations_admins;

Methods

create(string $parent, Admin $postBody, array $optParams = [])

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. (admins.create)

delete(string $name, array $optParams = [])

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

listLocationsAdmins(string $parent, array $optParams = [])

Lists all of the admins for the specified location.

patch(string $name, Admin $postBody, array $optParams = [])

Updates the Admin for the specified location. Only the AdminRole of the Admin can be updated. (admins.patch)

Details

Admin create(string $parent, Admin $postBody, array $optParams = [])

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. (admins.create)

Parameters

string $parent

Required. The resource name of the location this admin is created for. locations/{location_id}/admins.

Admin $postBody
array $optParams

Optional parameters.

Return Value

Admin

Exceptions

Exception

MybusinessaccountmanagementEmpty delete(string $name, array $optParams = [])

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

(admins.delete)

Parameters

string $name

Required. The resource name of the admin to remove from the location.

array $optParams

Optional parameters.

Return Value

MybusinessaccountmanagementEmpty

Exceptions

Exception

ListLocationAdminsResponse listLocationsAdmins(string $parent, array $optParams = [])

Lists all of the admins for the specified location.

(admins.listLocationsAdmins)

Parameters

string $parent

Required. The name of the location to list admins of. locations/{location_id}/admins.

array $optParams

Optional parameters.

Return Value

ListLocationAdminsResponse

Exceptions

Exception

Admin patch(string $name, Admin $postBody, array $optParams = [])

Updates the Admin for the specified location. Only the AdminRole of the Admin can be updated. (admins.patch)

Parameters

string $name

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.

Admin $postBody
array $optParams

Optional parameters.

Return Value

Admin

Exceptions

Exception