Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
REST Resource: accounts.admins
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Admin
An administrator of an Account or a location.
| JSON representation |
{
"name": string,
"admin": string,
"account": string,
"role": enum (AdminRole),
"pendingInvitation": boolean
} |
| Fields |
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/{locationId}/admins/{admin_id} This field will be ignored if set during admin creation.
|
admin |
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.
|
account |
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}.
|
role |
enum (AdminRole)
Required. Specifies the role that this admin uses with the specified Account or Location.
|
pendingInvitation |
boolean
Output only. Indicates whether this admin has a pending invitation for the specified resource.
|
AdminRole
Indicates the access level that an admin has. For more information, see the help center article
| Enums |
ADMIN_ROLE_UNSPECIFIED |
Not specified. |
PRIMARY_OWNER |
The admin has owner-level access and is the primary owner. (Displays as 'Primary Owner' in UI). |
OWNER |
The admin has owner-level access. (Displays as 'Owner' in UI). |
MANAGER |
The admin has managerial access. |
SITE_MANAGER |
The admin can manage social (Google+) pages. (Displays as 'Site Manager' in UI). This API doesn't allow creating an account admin with a SITE_MANAGER role. |
Methods |
|
|
Invites the specified user to become an administrator for the specified account. |
|
|
Removes the specified admin from the specified account. |
|
|
Lists the admins for the specified account. |
|
|
Updates the Admin for the specified Account Admin. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eAn Admin is an administrator of an Account or a location with different access levels defined by \u003ccode\u003eAdminRole\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAdmins can have roles like Primary Owner, Owner, Manager, and Site Manager, each with varying permissions.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage Admins by inviting, removing, listing, and updating them using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eAdmin details include name, role, account association, and pending invitation status, represented in JSON format.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAdminRole\u003c/code\u003e enum defines the access level of an admin, impacting their capabilities within the account or location.\u003c/p\u003e\n"]]],["Account and location administrators, identified by a resource name, have roles like `PRIMARY_OWNER`, `OWNER`, `MANAGER`, or `SITE_MANAGER`. Admins can be created by inviting a user via email, and roles are set during creation. The `pendingInvitation` field shows if an invite is pending. Available actions include: creating, deleting, listing, and updating admin access. `Admin` field contains the invitee's email address initially or user details after accepting.\n"],null,["# REST Resource: accounts.admins\n\n- [Resource: Admin](#Admin)\n - [JSON representation](#Admin.SCHEMA_REPRESENTATION)\n - [AdminRole](#Admin.AdminRole)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Admin\n---------------\n\nAn administrator of an Account or a location.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"admin\": string, \"account\": string, \"role\": enum (/my-business/reference/accountmanagement/rest/v1/accounts.admins#Admin.AdminRole), \"pendingInvitation\": boolean } ``` |\n\n| Fields ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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/{locationId}/admins/{admin_id}` This field will be ignored if set during admin creation. |\n| `admin` | `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. |\n| `account` | `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}`. |\n| `role` | `enum (`[AdminRole](/my-business/reference/accountmanagement/rest/v1/accounts.admins#Admin.AdminRole)`)` Required. Specifies the role that this admin uses with the specified Account or Location. |\n| `pendingInvitation` | `boolean` Output only. Indicates whether this admin has a pending invitation for the specified resource. |\n\n### AdminRole\n\nIndicates the access level that an admin has. For more information, see the [help center article](https://support.google.com/business/answer/3403100)\n\n| Enums ||\n|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ADMIN_ROLE_UNSPECIFIED` | Not specified. |\n| `PRIMARY_OWNER` | The admin has owner-level access and is the primary owner. (Displays as 'Primary Owner' in UI). |\n| `OWNER` | The admin has owner-level access. (Displays as 'Owner' in UI). |\n| `MANAGER` | The admin has managerial access. |\n| `SITE_MANAGER` | The admin can manage social (Google+) pages. (Displays as 'Site Manager' in UI). This API doesn't allow creating an account admin with a SITE_MANAGER role. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|\n| ### [create](/my-business/reference/accountmanagement/rest/v1/accounts.admins/create) | Invites the specified user to become an administrator for the specified account. |\n| ### [delete](/my-business/reference/accountmanagement/rest/v1/accounts.admins/delete) | Removes the specified admin from the specified account. |\n| ### [list](/my-business/reference/accountmanagement/rest/v1/accounts.admins/list) | Lists the admins for the specified account. |\n| ### [patch](/my-business/reference/accountmanagement/rest/v1/accounts.admins/patch) | Updates the Admin for the specified Account Admin. |"]]