Requires authorization
Creates a user's account & container permissions. Try it now or see an example.
Request
HTTP request
POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/permissions
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
accountId |
string |
The GTM Account ID. |
Authorization
This request requires authorization with the following scope (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/tagmanager.manage.users |
Request body
In the request body, supply a Permissions resource with the following properties:
Property name | Value | Description | Notes |
---|---|---|---|
Required Properties | |||
accountAccess |
nested object |
GTM Account access permissions. | writable |
accountAccess.permission[] |
list |
List of Account permissions. Valid account permissions are read and manage . |
writable |
emailAddress |
string |
User's email address. | writable |
Optional Properties | |||
containerAccess[] |
list |
GTM Container access permissions. | writable |
containerAccess[].containerId |
string |
GTM Container ID. | writable |
containerAccess[].permission[] |
list |
List of Container permissions. Valid container permissions are: read, edit, delete, publish . |
writable |
Response
If successful, this method returns a Permissions resource in the response body.
Examples
Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).
Java
Uses the Java client library.
/* * Note: This code assumes you have an authorized tagmanager service object. */ /* * This request authorizes a new user to access a GTM account. */ // Construct the container access object. ContainerAccess container = new ContainerAccess(); container.setContainerId("54321"); container.setPermission(Arrays.asList("read")); // Construct the account access object. AccountAccess account = new AccountAccess(); account.setPermission(Arrays.asList("read")); // Construct the user access object. UserAccess userAccess = new UserAccess(); userAccess.setEmailAddress("username@example.com"); userAccess.setAccountAccess(account); userAccess.setContainerAccess(Arrays.asList(container)); try { UserAccess response = tagmanager.accounts(). permissions().create("12345", userAccess).execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); } /* * The results of the create method are stored in the response object. * The following code shows how to access the created id. */ System.out.println("Permissions Id = " + response.getPermissionId());
Python
Uses the Python client library.
# Note: This code assumes you have an authorized tagmanager service object. # This request authorizes a new user to access a GTM account. try: permissions = tagmanager.accounts().permissions().create( accountId='123456', body={ 'emailAddress': 'username@example.com', 'accountAccess': { 'permission': [ 'read' ] }, 'containerAccess': { 'containerId': '54321', 'permission': [ 'read' ] } } ).execute() except TypeError, error: # Handle errors in constructing a query. print 'There was an error in constructing your query : %s' % error except HttpError, error: # Handle API errors. print ('There was an API error : %s : %s' % (error.resp.status, error.resp.reason))
Try it!
Use the APIs Explorer below to call this method on live data and see the response.