Method: workspaces.quick_preview

Full name: accounts.containers.workspaces.quick_preview

Quick previews a workspace by creating a fake container version from all entities in the provided workspace.

HTTP request

POST https://tagmanager.googleapis.com/tagmanager/v2/{path}:quick_preview

Path parameters

Parameters
path

string

GTM Workspace's API relative path. It takes the form accounts/{account}/containers/{container}/workspaces/{workspace}.

Request body

The request body must be empty.

Response body

Response to quick previewing a workspace.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "containerVersion": {
    object (ContainerVersion)
  },
  "syncStatus": {
    object (SyncStatus)
  },
  "compilerError": boolean
}
Fields
containerVersion

object (ContainerVersion)

The quick previewed container version.
syncStatus

object (SyncStatus)

Whether quick previewing failed when syncing the workspace to the latest container version.
compilerError

boolean

Were there compiler errors or not.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/tagmanager.edit.containerversions

For more information, see the OAuth 2.0 Overview.