Tag Manager API . accounts . containers . workspaces . clients

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a GTM Client.

Args:
  parent: string, GTM Workspace's API relative path. (required)
  body: object, The request body.
    The object takes the form of:

{
  "accountId": "A String", # GTM Account ID.
  "clientId": "A String", # The Client ID uniquely identifies the GTM client.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
  "name": "A String", # Client display name.
  "notes": "A String", # User notes on how to apply this tag in the container.
  "parameter": [ # The client's parameters.
    { # Represents a Google Tag Manager Parameter.
      "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "type": "A 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
      "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
    },
  ],
  "parentFolderId": "A String", # Parent folder id.
  "path": "A String", # GTM client's API relative path.
  "priority": 42, # Priority determines relative firing order.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "type": "A String", # Client type.
  "workspaceId": "A String", # GTM Workspace ID.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "accountId": "A String", # GTM Account ID.
  "clientId": "A String", # The Client ID uniquely identifies the GTM client.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
  "name": "A String", # Client display name.
  "notes": "A String", # User notes on how to apply this tag in the container.
  "parameter": [ # The client's parameters.
    { # Represents a Google Tag Manager Parameter.
      "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "type": "A 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
      "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
    },
  ],
  "parentFolderId": "A String", # Parent folder id.
  "path": "A String", # GTM client's API relative path.
  "priority": 42, # Priority determines relative firing order.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "type": "A String", # Client type.
  "workspaceId": "A String", # GTM Workspace ID.
}

delete(path, x__xgafv=None)

Deletes a GTM Client.

Args:
  path: string, GTM Client's API relative path. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

get(path, x__xgafv=None)

Gets a GTM Client.

Args:
  path: string, GTM Client's API relative path. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "accountId": "A String", # GTM Account ID.
  "clientId": "A String", # The Client ID uniquely identifies the GTM client.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
  "name": "A String", # Client display name.
  "notes": "A String", # User notes on how to apply this tag in the container.
  "parameter": [ # The client's parameters.
    { # Represents a Google Tag Manager Parameter.
      "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "type": "A 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
      "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
    },
  ],
  "parentFolderId": "A String", # Parent folder id.
  "path": "A String", # GTM client's API relative path.
  "priority": 42, # Priority determines relative firing order.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "type": "A String", # Client type.
  "workspaceId": "A String", # GTM Workspace ID.
}

list(parent, pageToken=None, x__xgafv=None)

Lists all GTM Clients of a GTM container workspace.

Args:
  parent: string, GTM Workspace's API relative path. (required)
  pageToken: string, Continuation token for fetching the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "client": [ # All GTM Clients of a GTM Container.
    {
      "accountId": "A String", # GTM Account ID.
      "clientId": "A String", # The Client ID uniquely identifies the GTM client.
      "containerId": "A String", # GTM Container ID.
      "fingerprint": "A String", # The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
      "name": "A String", # Client display name.
      "notes": "A String", # User notes on how to apply this tag in the container.
      "parameter": [ # The client's parameters.
        { # Represents a Google Tag Manager Parameter.
          "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
          "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
          "list": [ # This list parameter's parameters (keys will be ignored).
            # Object with schema name: Parameter
          ],
          "map": [ # This map parameter's parameters (must have keys; keys must be unique).
            # Object with schema name: Parameter
          ],
          "type": "A 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
          "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
        },
      ],
      "parentFolderId": "A String", # Parent folder id.
      "path": "A String", # GTM client's API relative path.
      "priority": 42, # Priority determines relative firing order.
      "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
      "type": "A String", # Client type.
      "workspaceId": "A String", # GTM Workspace ID.
    },
  ],
  "nextPageToken": "A String", # Continuation token for fetching the next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

revert(path, fingerprint=None, x__xgafv=None)

Reverts changes to a GTM Client in a GTM Workspace.

Args:
  path: string, GTM Client's API relative path. (required)
  fingerprint: string, When provided, this fingerprint must match the fingerprint of the client in storage.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The result of reverting a client in a workspace.
  "client": { # Client as it appears in the latest container version since the last workspace synchronization operation. If no client is present, that means the client was deleted in the latest container version.
    "accountId": "A String", # GTM Account ID.
    "clientId": "A String", # The Client ID uniquely identifies the GTM client.
    "containerId": "A String", # GTM Container ID.
    "fingerprint": "A String", # The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
    "name": "A String", # Client display name.
    "notes": "A String", # User notes on how to apply this tag in the container.
    "parameter": [ # The client's parameters.
      { # Represents a Google Tag Manager Parameter.
        "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
        "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
        "list": [ # This list parameter's parameters (keys will be ignored).
          # Object with schema name: Parameter
        ],
        "map": [ # This map parameter's parameters (must have keys; keys must be unique).
          # Object with schema name: Parameter
        ],
        "type": "A 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
        "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
      },
    ],
    "parentFolderId": "A String", # Parent folder id.
    "path": "A String", # GTM client's API relative path.
    "priority": 42, # Priority determines relative firing order.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "type": "A String", # Client type.
    "workspaceId": "A String", # GTM Workspace ID.
  },
}

update(path, body=None, fingerprint=None, x__xgafv=None)

Updates a GTM Client.

Args:
  path: string, GTM Client's API relative path. (required)
  body: object, The request body.
    The object takes the form of:

{
  "accountId": "A String", # GTM Account ID.
  "clientId": "A String", # The Client ID uniquely identifies the GTM client.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
  "name": "A String", # Client display name.
  "notes": "A String", # User notes on how to apply this tag in the container.
  "parameter": [ # The client's parameters.
    { # Represents a Google Tag Manager Parameter.
      "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "type": "A 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
      "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
    },
  ],
  "parentFolderId": "A String", # Parent folder id.
  "path": "A String", # GTM client's API relative path.
  "priority": 42, # Priority determines relative firing order.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "type": "A String", # Client type.
  "workspaceId": "A String", # GTM Workspace ID.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the client in storage.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "accountId": "A String", # GTM Account ID.
  "clientId": "A String", # The Client ID uniquely identifies the GTM client.
  "containerId": "A String", # GTM Container ID.
  "fingerprint": "A String", # The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
  "name": "A String", # Client display name.
  "notes": "A String", # User notes on how to apply this tag in the container.
  "parameter": [ # The client's parameters.
    { # Represents a Google Tag Manager Parameter.
      "isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
      "key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
      "list": [ # This list parameter's parameters (keys will be ignored).
        # Object with schema name: Parameter
      ],
      "map": [ # This map parameter's parameters (must have keys; keys must be unique).
        # Object with schema name: Parameter
      ],
      "type": "A 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
      "value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
    },
  ],
  "parentFolderId": "A String", # Parent folder id.
  "path": "A String", # GTM client's API relative path.
  "priority": 42, # Priority determines relative firing order.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "type": "A String", # Client type.
  "workspaceId": "A String", # GTM Workspace ID.
}