| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="tagmanager_v2.html">Tag Manager API</a> . <a href="tagmanager_v2.accounts.html">accounts</a> . <a href="tagmanager_v2.accounts.containers.html">containers</a> . <a href="tagmanager_v2.accounts.containers.workspaces.html">workspaces</a> . <a href="tagmanager_v2.accounts.containers.workspaces.zones.html">zones</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a GTM Zone.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(path, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a GTM Zone.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(path, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a GTM Zone.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all GTM Zones of a GTM container workspace.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#revert">revert(path, fingerprint=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Reverts changes to a GTM Zone in a GTM Workspace.</p> |
| <p class="toc_element"> |
| <code><a href="#update">update(path, body=None, fingerprint=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a GTM Zone.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates a GTM Zone. |
| |
| Args: |
| parent: string, GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Google Tag Manager Zone's contents. |
| "accountId": "A String", # GTM Account ID. |
| "boundary": { # Represents a Zone's boundaries. # This Zone's boundary. |
| "condition": [ # The conditions that, when conjoined, make up the boundary. |
| { # Represents a predicate. |
| "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| { # Represents a Google Tag Manager Parameter. |
| "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. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "list": [ # This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # Object with schema name: Parameter |
| ], |
| "map": [ # This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # 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 @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| }, |
| ], |
| "type": "A String", # The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| }, |
| ], |
| "customEvaluationTriggerId": [ # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. |
| "A String", |
| ], |
| }, |
| "childContainer": [ # Containers that are children of this Zone. |
| { # Represents a child container of a Zone. |
| "nickname": "A String", # The zone's nickname for the child container. |
| "publicId": "A String", # The child container's public id. |
| }, |
| ], |
| "containerId": "A String", # GTM Container ID. |
| "fingerprint": "A String", # The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. |
| "name": "A String", # Zone display name. |
| "notes": "A String", # User notes on how to apply this zone in the container. |
| "path": "A String", # GTM Zone's API relative path. |
| "tagManagerUrl": "A String", # Auto generated link to the tag manager UI |
| "typeRestriction": { # Represents a Zone's type restrictions. # This Zone's type restrictions. |
| "enable": True or False, # True if type restrictions have been enabled for this Zone. |
| "whitelistedTypeId": [ # List of type public ids that have been whitelisted for use in this Zone. |
| "A String", |
| ], |
| }, |
| "workspaceId": "A String", # GTM Workspace ID. |
| "zoneId": "A String", # The Zone ID uniquely identifies the GTM Zone. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a Google Tag Manager Zone's contents. |
| "accountId": "A String", # GTM Account ID. |
| "boundary": { # Represents a Zone's boundaries. # This Zone's boundary. |
| "condition": [ # The conditions that, when conjoined, make up the boundary. |
| { # Represents a predicate. |
| "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| { # Represents a Google Tag Manager Parameter. |
| "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. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "list": [ # This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # Object with schema name: Parameter |
| ], |
| "map": [ # This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # 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 @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| }, |
| ], |
| "type": "A String", # The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| }, |
| ], |
| "customEvaluationTriggerId": [ # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. |
| "A String", |
| ], |
| }, |
| "childContainer": [ # Containers that are children of this Zone. |
| { # Represents a child container of a Zone. |
| "nickname": "A String", # The zone's nickname for the child container. |
| "publicId": "A String", # The child container's public id. |
| }, |
| ], |
| "containerId": "A String", # GTM Container ID. |
| "fingerprint": "A String", # The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. |
| "name": "A String", # Zone display name. |
| "notes": "A String", # User notes on how to apply this zone in the container. |
| "path": "A String", # GTM Zone's API relative path. |
| "tagManagerUrl": "A String", # Auto generated link to the tag manager UI |
| "typeRestriction": { # Represents a Zone's type restrictions. # This Zone's type restrictions. |
| "enable": True or False, # True if type restrictions have been enabled for this Zone. |
| "whitelistedTypeId": [ # List of type public ids that have been whitelisted for use in this Zone. |
| "A String", |
| ], |
| }, |
| "workspaceId": "A String", # GTM Workspace ID. |
| "zoneId": "A String", # The Zone ID uniquely identifies the GTM Zone. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(path, x__xgafv=None)</code> |
| <pre>Deletes a GTM Zone. |
| |
| Args: |
| path: string, GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(path, x__xgafv=None)</code> |
| <pre>Gets a GTM Zone. |
| |
| Args: |
| path: string, GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a Google Tag Manager Zone's contents. |
| "accountId": "A String", # GTM Account ID. |
| "boundary": { # Represents a Zone's boundaries. # This Zone's boundary. |
| "condition": [ # The conditions that, when conjoined, make up the boundary. |
| { # Represents a predicate. |
| "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| { # Represents a Google Tag Manager Parameter. |
| "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. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "list": [ # This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # Object with schema name: Parameter |
| ], |
| "map": [ # This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # 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 @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| }, |
| ], |
| "type": "A String", # The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| }, |
| ], |
| "customEvaluationTriggerId": [ # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. |
| "A String", |
| ], |
| }, |
| "childContainer": [ # Containers that are children of this Zone. |
| { # Represents a child container of a Zone. |
| "nickname": "A String", # The zone's nickname for the child container. |
| "publicId": "A String", # The child container's public id. |
| }, |
| ], |
| "containerId": "A String", # GTM Container ID. |
| "fingerprint": "A String", # The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. |
| "name": "A String", # Zone display name. |
| "notes": "A String", # User notes on how to apply this zone in the container. |
| "path": "A String", # GTM Zone's API relative path. |
| "tagManagerUrl": "A String", # Auto generated link to the tag manager UI |
| "typeRestriction": { # Represents a Zone's type restrictions. # This Zone's type restrictions. |
| "enable": True or False, # True if type restrictions have been enabled for this Zone. |
| "whitelistedTypeId": [ # List of type public ids that have been whitelisted for use in this Zone. |
| "A String", |
| ], |
| }, |
| "workspaceId": "A String", # GTM Workspace ID. |
| "zoneId": "A String", # The Zone ID uniquely identifies the GTM Zone. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists all GTM Zones of a GTM container workspace. |
| |
| Args: |
| parent: string, GTM Workspace's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id} (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: |
| |
| { |
| "nextPageToken": "A String", # Continuation token for fetching the next page of results. |
| "zone": [ # All GTM Zones of a GTM Container. |
| { # Represents a Google Tag Manager Zone's contents. |
| "accountId": "A String", # GTM Account ID. |
| "boundary": { # Represents a Zone's boundaries. # This Zone's boundary. |
| "condition": [ # The conditions that, when conjoined, make up the boundary. |
| { # Represents a predicate. |
| "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| { # Represents a Google Tag Manager Parameter. |
| "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. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "list": [ # This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # Object with schema name: Parameter |
| ], |
| "map": [ # This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # 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 @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| }, |
| ], |
| "type": "A String", # The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| }, |
| ], |
| "customEvaluationTriggerId": [ # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. |
| "A String", |
| ], |
| }, |
| "childContainer": [ # Containers that are children of this Zone. |
| { # Represents a child container of a Zone. |
| "nickname": "A String", # The zone's nickname for the child container. |
| "publicId": "A String", # The child container's public id. |
| }, |
| ], |
| "containerId": "A String", # GTM Container ID. |
| "fingerprint": "A String", # The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. |
| "name": "A String", # Zone display name. |
| "notes": "A String", # User notes on how to apply this zone in the container. |
| "path": "A String", # GTM Zone's API relative path. |
| "tagManagerUrl": "A String", # Auto generated link to the tag manager UI |
| "typeRestriction": { # Represents a Zone's type restrictions. # This Zone's type restrictions. |
| "enable": True or False, # True if type restrictions have been enabled for this Zone. |
| "whitelistedTypeId": [ # List of type public ids that have been whitelisted for use in this Zone. |
| "A String", |
| ], |
| }, |
| "workspaceId": "A String", # GTM Workspace ID. |
| "zoneId": "A String", # The Zone ID uniquely identifies the GTM Zone. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="revert">revert(path, fingerprint=None, x__xgafv=None)</code> |
| <pre>Reverts changes to a GTM Zone in a GTM Workspace. |
| |
| Args: |
| path: string, GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} (required) |
| fingerprint: string, When provided, this fingerprint must match the fingerprint of the zone 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 zone in a workspace. |
| "zone": { # Represents a Google Tag Manager Zone's contents. # Zone as it appears in the latest container version since the last workspace synchronization operation. If no zone is present, that means the zone was deleted in the latest container version. |
| "accountId": "A String", # GTM Account ID. |
| "boundary": { # Represents a Zone's boundaries. # This Zone's boundary. |
| "condition": [ # The conditions that, when conjoined, make up the boundary. |
| { # Represents a predicate. |
| "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| { # Represents a Google Tag Manager Parameter. |
| "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. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "list": [ # This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # Object with schema name: Parameter |
| ], |
| "map": [ # This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # 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 @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| }, |
| ], |
| "type": "A String", # The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| }, |
| ], |
| "customEvaluationTriggerId": [ # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. |
| "A String", |
| ], |
| }, |
| "childContainer": [ # Containers that are children of this Zone. |
| { # Represents a child container of a Zone. |
| "nickname": "A String", # The zone's nickname for the child container. |
| "publicId": "A String", # The child container's public id. |
| }, |
| ], |
| "containerId": "A String", # GTM Container ID. |
| "fingerprint": "A String", # The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. |
| "name": "A String", # Zone display name. |
| "notes": "A String", # User notes on how to apply this zone in the container. |
| "path": "A String", # GTM Zone's API relative path. |
| "tagManagerUrl": "A String", # Auto generated link to the tag manager UI |
| "typeRestriction": { # Represents a Zone's type restrictions. # This Zone's type restrictions. |
| "enable": True or False, # True if type restrictions have been enabled for this Zone. |
| "whitelistedTypeId": [ # List of type public ids that have been whitelisted for use in this Zone. |
| "A String", |
| ], |
| }, |
| "workspaceId": "A String", # GTM Workspace ID. |
| "zoneId": "A String", # The Zone ID uniquely identifies the GTM Zone. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="update">update(path, body=None, fingerprint=None, x__xgafv=None)</code> |
| <pre>Updates a GTM Zone. |
| |
| Args: |
| path: string, GTM Zone's API relative path. Example: accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}/zones/{zone_id} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Represents a Google Tag Manager Zone's contents. |
| "accountId": "A String", # GTM Account ID. |
| "boundary": { # Represents a Zone's boundaries. # This Zone's boundary. |
| "condition": [ # The conditions that, when conjoined, make up the boundary. |
| { # Represents a predicate. |
| "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| { # Represents a Google Tag Manager Parameter. |
| "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. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "list": [ # This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # Object with schema name: Parameter |
| ], |
| "map": [ # This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # 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 @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| }, |
| ], |
| "type": "A String", # The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| }, |
| ], |
| "customEvaluationTriggerId": [ # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. |
| "A String", |
| ], |
| }, |
| "childContainer": [ # Containers that are children of this Zone. |
| { # Represents a child container of a Zone. |
| "nickname": "A String", # The zone's nickname for the child container. |
| "publicId": "A String", # The child container's public id. |
| }, |
| ], |
| "containerId": "A String", # GTM Container ID. |
| "fingerprint": "A String", # The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. |
| "name": "A String", # Zone display name. |
| "notes": "A String", # User notes on how to apply this zone in the container. |
| "path": "A String", # GTM Zone's API relative path. |
| "tagManagerUrl": "A String", # Auto generated link to the tag manager UI |
| "typeRestriction": { # Represents a Zone's type restrictions. # This Zone's type restrictions. |
| "enable": True or False, # True if type restrictions have been enabled for this Zone. |
| "whitelistedTypeId": [ # List of type public ids that have been whitelisted for use in this Zone. |
| "A String", |
| ], |
| }, |
| "workspaceId": "A String", # GTM Workspace ID. |
| "zoneId": "A String", # The Zone ID uniquely identifies the GTM Zone. |
| } |
| |
| fingerprint: string, When provided, this fingerprint must match the fingerprint of the zone in storage. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Represents a Google Tag Manager Zone's contents. |
| "accountId": "A String", # GTM Account ID. |
| "boundary": { # Represents a Zone's boundaries. # This Zone's boundary. |
| "condition": [ # The conditions that, when conjoined, make up the boundary. |
| { # Represents a predicate. |
| "parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| { # Represents a Google Tag Manager Parameter. |
| "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. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "list": [ # This list parameter's parameters (keys will be ignored). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # Object with schema name: Parameter |
| ], |
| "map": [ # This map parameter's parameters (must have keys; keys must be unique). @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| # 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 @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| "value": "A String", # A parameter's value (may contain variable references such as "{{myVariable}}") as appropriate to the specified type. @mutable tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update |
| }, |
| ], |
| "type": "A String", # The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update |
| }, |
| ], |
| "customEvaluationTriggerId": [ # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions when any of the listed triggers are true. |
| "A String", |
| ], |
| }, |
| "childContainer": [ # Containers that are children of this Zone. |
| { # Represents a child container of a Zone. |
| "nickname": "A String", # The zone's nickname for the child container. |
| "publicId": "A String", # The child container's public id. |
| }, |
| ], |
| "containerId": "A String", # GTM Container ID. |
| "fingerprint": "A String", # The fingerprint of the GTM Zone as computed at storage time. This value is recomputed whenever the zone is modified. |
| "name": "A String", # Zone display name. |
| "notes": "A String", # User notes on how to apply this zone in the container. |
| "path": "A String", # GTM Zone's API relative path. |
| "tagManagerUrl": "A String", # Auto generated link to the tag manager UI |
| "typeRestriction": { # Represents a Zone's type restrictions. # This Zone's type restrictions. |
| "enable": True or False, # True if type restrictions have been enabled for this Zone. |
| "whitelistedTypeId": [ # List of type public ids that have been whitelisted for use in this Zone. |
| "A String", |
| ], |
| }, |
| "workspaceId": "A String", # GTM Workspace ID. |
| "zoneId": "A String", # The Zone ID uniquely identifies the GTM Zone. |
| }</pre> |
| </div> |
| |
| </body></html> |