Tag Manager API (tagmanager:v2)

▼ ▲ tagmanager.accounts.containers.destinations.list

HTTP Method: GET

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations

Parameter Order: parent

Description: Lists all Destinations linked to a GTM Container.

Path: tagmanager/v2/{+parent}/destinations

Parameters:

parent

Required: Yes

Location: path

Pattern: ^accounts/[^/]+/containers/[^/]+$

Type: string

Description: GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id}

Scopes:

• https://www.googleapis.com/auth/tagmanager.edit.containers
• https://www.googleapis.com/auth/tagmanager.readonly

▼ ▲ tagmanager.accounts.containers.destinations.link

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations:link

Parameter Order: parent

Path: tagmanager/v2/{+parent}/destinations:link

HTTP Method: POST

Parameters:

parent

Description: GTM parent Container's API relative path. Example: accounts/{account_id}/containers/{container_id}

Required: Yes

Location: path

Type: string

Pattern: ^accounts/[^/]+/containers/[^/]+$

destinationId

Location: query

Type: string

Description: Destination ID to be linked to the current container.

allowUserPermissionFeatureUpdate

Location: query

Description: Must be set to true to allow features.user_permissions to change from false to true (i.e. Google product owned to GTM permission). If this operation causes an update but this bit is false, the operation will fail.

Type: boolean

Description: Adds a Destination to this Container and removes it from the Container to which it is currently linked.

Scopes: https://www.googleapis.com/auth/tagmanager.edit.containers

▼ ▲ tagmanager.accounts.containers.destinations.get

Description: Gets a Destination.

Path: tagmanager/v2/{+path}

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}/destinations/{destinationsId}

HTTP Method: GET

Parameter Order: path

Scopes:

• https://www.googleapis.com/auth/tagmanager.edit.containers
• https://www.googleapis.com/auth/tagmanager.readonly

Parameters:

path

Required: Yes

Location: path

Description: Google Tag Destination's API relative path. Example: accounts/{account_id}/containers/{container_id}/destinations/{destination_link_id}

Pattern: ^accounts/[^/]+/containers/[^/]+/destinations/[^/]+$

Type: string

▼ ▲ tagmanager.accounts.containers.workspaces.gtag_config.create

Parameters:

parent

Pattern: ^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$

Type: string

Description: Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

Required: Yes

Location: path

Parameter Order: parent

Scopes: https://www.googleapis.com/auth/tagmanager.edit.containers

Description: Creates a Google tag config.

HTTP Method: POST

Path: tagmanager/v2/{+parent}/gtag_config

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config

▼ ▲ tagmanager.accounts.containers.workspaces.gtag_config.delete

Parameters:

path

Required: Yes

Description: Google tag config's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/gtag_config/{gtag_config_id}

Pattern: ^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$

Type: string

Location: path

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}

Path: tagmanager/v2/{+path}

Parameter Order: path

HTTP Method: DELETE

Description: Deletes a Google tag config.

Scopes: https://www.googleapis.com/auth/tagmanager.edit.containers

▼ ▲ tagmanager.accounts.containers.workspaces.gtag_config.update

Description: Updates a Google tag config.

Path: tagmanager/v2/{+path}

Parameters:

fingerprint

Type: string

Location: query

Description: When provided, this fingerprint must match the fingerprint of the config in storage.

path

Required: Yes

Pattern: ^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$

Type: string

Location: path

Description: Google tag config's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/gtag_config/{gtag_config_id}

Parameter Order: path

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}

Scopes: https://www.googleapis.com/auth/tagmanager.edit.containers

HTTP Method: PUT

▼ ▲ tagmanager.accounts.containers.workspaces.gtag_config.get

Parameter Order: path

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config/{gtag_configId}

Path: tagmanager/v2/{+path}

HTTP Method: GET

Scopes:

• https://www.googleapis.com/auth/tagmanager.edit.containers
• https://www.googleapis.com/auth/tagmanager.readonly

Parameters:

path

Description: Google tag config's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/gtag_config/{gtag_config_id}

Pattern: ^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+/gtag_config/[^/]+$

Location: path

Type: string

Required: Yes

Description: Gets a Google tag config.

▼ ▲ tagmanager.accounts.containers.workspaces.gtag_config.list

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}/workspaces/{workspacesId}/gtag_config

Parameters:

parent

Pattern: ^accounts/[^/]+/containers/[^/]+/workspaces/[^/]+$

Required: Yes

Description: Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}

Location: path

Type: string

pageToken

Type: string

Description: Continuation token for fetching the next page of results.

Location: query

Scopes:

• https://www.googleapis.com/auth/tagmanager.edit.containers
• https://www.googleapis.com/auth/tagmanager.readonly

Path: tagmanager/v2/{+parent}/gtag_config

Description: Lists all Google tag configs in a Container.

HTTP Method: GET

Parameter Order: parent

▼ ▲ tagmanager.accounts.containers.combine

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}:combine

Description: Combines Containers.

HTTP Method: POST

Parameters:

allowUserPermissionFeatureUpdate

Type: boolean

Location: query

Description: Must be set to true to allow features.user_permissions to change from false to true (i.e. Google product owned to GTM permission). If this operation causes an update but this bit is false, the operation will fail.

containerId

Location: query

Description: ID of container that will be merged into the current container.

Type: string

path

Required: Yes

Type: string

Pattern: ^accounts/[^/]+/containers/[^/]+$

Description: GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}

Location: path

settingSource

Enum Descriptions:

• Keep the current container config setting after combine
• Use config setting from the other tag after combine

Type: string

Enum:

• settingSourceUnspecified
• current
• other

Description: Specify the source of config setting after combine

Location: query

Path: tagmanager/v2/{+path}:combine

Scopes: https://www.googleapis.com/auth/tagmanager.edit.containers

Parameter Order: path

▼ ▲ tagmanager.accounts.containers.lookup

Flat Path: tagmanager/v2/accounts/containers:lookup

Description: Looks up a Container by destination ID.

Parameters:

destinationId

Location: query

Description: Measurement ID of destination linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id}.

Type: string

HTTP Method: GET

Path: tagmanager/v2/accounts/containers:lookup

Scopes:

• https://www.googleapis.com/auth/tagmanager.edit.containers
• https://www.googleapis.com/auth/tagmanager.readonly

▼ ▲ tagmanager.accounts.containers.move_tag_id

Scopes: https://www.googleapis.com/auth/tagmanager.edit.containers

Path: tagmanager/v2/{+path}:move_tag_id

HTTP Method: POST

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}:move_tag_id

Parameter Order: path

Description: Move Tag ID out of a Container.

Parameters:

allowUserPermissionFeatureUpdate

Type: boolean

Description: Must be set to true to allow features.user_permissions to change from false to true (i.e. Google product owned to GTM permission). If this operation causes an update but this bit is false, the operation will fail.

Location: query

copyUsers

Description: Whether or not to copy users from this tag to the new tag.

Location: query

Type: boolean

copyTermsOfService

Type: boolean

Description: Must be set to true to accept all terms of service agreements copied from the current tag to the newly created tag. If this bit is false, the operation will fail.

Location: query

copySettings

Location: query

Type: boolean

Description: Whether or not to copy tag settings from this tag to the new tag.

path

Location: path

Type: string

Pattern: ^accounts/[^/]+/containers/[^/]+$

Description: GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id}

Required: Yes

tagName

Type: string

Location: query

Description: The name for the newly created tag.

tagId

Description: Tag ID to be removed from the current Container.

Location: query

Type: string

▼ ▲ tagmanager.accounts.containers.snippet

HTTP Method: GET

Parameters:

path

Location: path

Required: Yes

Description: Container snippet's API relative path. Example: accounts/{account_id}/containers/{container_id}:snippet

Type: string

Pattern: ^accounts/[^/]+/containers/[^/]+$

Description: Gets the snippet of a Container.

Scopes:

• https://www.googleapis.com/auth/tagmanager.edit.containers
• https://www.googleapis.com/auth/tagmanager.readonly

Flat Path: tagmanager/v2/accounts/{accountsId}/containers/{containersId}:snippet

Parameter Order: path

Path: tagmanager/v2/{+path}:snippet

▼ ▲ tagmanager.accounts.list

Parameters:

includeGoogleTags

Location: query

Type: boolean

Description: Also retrieve accounts associated with Google Tag when true.