Clients

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "clientId": string,
  "name": string,
  "type": string,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "priority": integer,
  "fingerprint": string,
  "tagManagerUrl": string,
  "parentFolderId": string,
  "notes": string
}

Property name	Value	Description	Notes
`accountId`	`string`	GTM Account ID.
`clientId`	`string`	The Client ID uniquely identifies the GTM client.
`containerId`	`string`	GTM Container ID.
`fingerprint`	`string`	The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
`name`	`string`	Client display name.	writable
`notes`	`string`	User notes on how to apply this tag in the container.	writable
`parameter[]`	`list`	The client's parameters.	writable
`parameter[].isWeakReference`	`boolean`	Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.	writable
`parameter[].key`	`string`	The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.	writable
`parameter[].list[]`	`list`	This list parameter's parameters (keys will be ignored).	writable
`parameter[].map[]`	`list`	This map parameter's parameters (must have keys; keys must be unique).	writable
`parameter[].type`	`string`	The parameter type. Valid values are: `boolean`: The value represents a boolean, represented as 'true' or 'false' `integer`: The value represents a 64-bit signed integer value, in base 10 `list`: A list of parameters should be specified `map`: A map of parameters should be specified `template`: The value represents any text; this can include variable references (even variable references that might return non-string types) `trigger_reference`: The value represents a trigger, represented as the trigger id `tag_reference`: The value represents a tag, represented as the tag name Acceptable values are: "`boolean`" "`integer`" "`list`" "`map`" "`tagReference`" "`template`" "`triggerReference`" "`typeUnspecified`"	writable
`parameter[].value`	`string`	A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type.	writable
`parentFolderId`	`string`	Parent folder id.
`path`	`string`	GTM client's API relative path.
`priority`	`integer`	Priority determines relative firing order.	writable
`tagManagerUrl`	`string`	Auto generated link to the tag manager UI
`type`	`string`	Client type.	writable
`workspaceId`	`string`	GTM Workspace ID.

Methods

create: Creates a GTM Client.
delete: Deletes a GTM Client.
get: Gets a GTM Client.
list: Lists all GTM Clients of a GTM container workspace.
revert: Reverts changes to a GTM Client in a GTM Workspace.
update: Updates a GTM Client.