Method: workspaces.sync

Full name: accounts.containers.workspaces.sync

Syncs a workspace to the latest container version by updating all unmodified workspace entities and displaying conflicts for modified entities.

HTTP request

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

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

A response after synchronizing the workspace to the latest container version.

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

JSON representation 
{
  "syncStatus": {
    object (SyncStatus)
  },
  "mergeConflict": [
    {
      object (MergeConflict)
    }
  ]
}
Fields
syncStatus

object (SyncStatus)

Indicates whether synchronization caused a merge conflict or sync error.
mergeConflict[]

object (MergeConflict)

The merge conflict after sync. If this field is not empty, the sync is still treated as successful. But a version cannot be created until all conflicts are resolved.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.