googleapis
Version:
Google APIs Client Library for Node.js
1,323 lines • 256 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace tagmanager_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Tag Manager API
*
* This API allows clients to access and modify container and tag configuration.
*
* @example
* ```js
* const {google} = require('googleapis');
* const tagmanager = google.tagmanager('v2');
* ```
*/
export class Tagmanager {
context: APIRequestContext;
accounts: Resource$Accounts;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Represents a Google Tag Manager Account.
*/
export interface Schema$Account {
/**
* The Account ID uniquely identifies the GTM Account.
*/
accountId?: string | null;
/**
* Read-only Account feature set
*/
features?: Schema$AccountFeatures;
/**
* The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
*/
fingerprint?: string | null;
/**
* Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
*/
name?: string | null;
/**
* GTM Account's API relative path.
*/
path?: string | null;
/**
* Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
*/
shareData?: boolean | null;
/**
* Auto generated link to the tag manager UI
*/
tagManagerUrl?: string | null;
}
/**
* Defines the Google Tag Manager Account access permissions.
*/
export interface Schema$AccountAccess {
/**
* Whether the user has no access, user access, or admin access to an account. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
*/
permission?: string | null;
}
export interface Schema$AccountFeatures {
/**
* Whether this Account supports multiple Containers.
*/
supportMultipleContainers?: boolean | null;
/**
* Whether this Account supports user permissions managed by GTM.
*/
supportUserPermissions?: boolean | null;
}
/**
* Built-in variables are a special category of variables that are pre-created and non-customizable. They provide common functionality like accessing properties of the gtm data layer, monitoring clicks, or accessing elements of a page URL.
*/
export interface Schema$BuiltInVariable {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* Name of the built-in variable to be used to refer to the built-in variable.
*/
name?: string | null;
/**
* GTM BuiltInVariable's API relative path.
*/
path?: string | null;
/**
* Type of built-in variable. @required.tagmanager.accounts.containers.workspaces.built_in_variable.update @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update
*/
type?: string | null;
/**
* GTM Workspace ID.
*/
workspaceId?: string | null;
}
export interface Schema$Client {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* The Client ID uniquely identifies the GTM client.
*/
clientId?: string | null;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* The fingerprint of the GTM Client as computed at storage time. This value is recomputed whenever the client is modified.
*/
fingerprint?: string | null;
/**
* Client display name. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update
*/
name?: string | null;
/**
* User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
notes?: string | null;
/**
* The client's parameters. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update
*/
parameter?: Schema$Parameter[];
/**
* Parent folder id.
*/
parentFolderId?: string | null;
/**
* GTM client's API relative path.
*/
path?: string | null;
/**
* Priority determines relative firing order. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update
*/
priority?: number | null;
/**
* Auto generated link to the tag manager UI
*/
tagManagerUrl?: string | null;
/**
* Client type. @mutable tagmanager.accounts.containers.workspaces.clients.create @mutable tagmanager.accounts.containers.workspaces.clients.update
*/
type?: string | null;
/**
* GTM Workspace ID.
*/
workspaceId?: string | null;
}
/**
* Represents a predicate.
*/
export interface Schema$Condition {
/**
* 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
*/
parameter?: Schema$Parameter[];
/**
* The type of operator for this condition. @mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers.update
*/
type?: string | null;
}
/**
* Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
*/
export interface Schema$Container {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* The Container ID uniquely identifies the GTM Container.
*/
containerId?: string | null;
/**
* List of domain names associated with the Container. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update
*/
domainName?: string[] | null;
/**
* Read-only Container feature set.
*/
features?: Schema$ContainerFeatures;
/**
* The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
*/
fingerprint?: string | null;
/**
* Container display name. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update
*/
name?: string | null;
/**
* Container Notes. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update
*/
notes?: string | null;
/**
* GTM Container's API relative path.
*/
path?: string | null;
/**
* Container Public ID.
*/
publicId?: string | null;
/**
* List of server-side container URLs for the Container. If multiple URLs are provided, all URL paths must match. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update
*/
taggingServerUrls?: string[] | null;
/**
* All Tag IDs that refer to this Container.
*/
tagIds?: string[] | null;
/**
* Auto generated link to the tag manager UI
*/
tagManagerUrl?: string | null;
/**
* List of Usage Contexts for the Container. Valid values include: web, android, or ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers.update
*/
usageContext?: string[] | null;
}
/**
* Defines the Google Tag Manager Container access permissions.
*/
export interface Schema$ContainerAccess {
/**
* GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
*/
containerId?: string | null;
/**
* List of Container permissions. @mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts.permissions.update
*/
permission?: string | null;
}
export interface Schema$ContainerFeatures {
/**
* Whether this Container supports built-in variables
*/
supportBuiltInVariables?: boolean | null;
/**
* Whether this Container supports clients.
*/
supportClients?: boolean | null;
/**
* Whether this Container supports environments.
*/
supportEnvironments?: boolean | null;
/**
* Whether this Container supports folders.
*/
supportFolders?: boolean | null;
/**
* Whether this Container supports Google tag config.
*/
supportGtagConfigs?: boolean | null;
/**
* Whether this Container supports tags.
*/
supportTags?: boolean | null;
/**
* Whether this Container supports templates.
*/
supportTemplates?: boolean | null;
/**
* Whether this Container supports transformations.
*/
supportTransformations?: boolean | null;
/**
* Whether this Container supports triggers.
*/
supportTriggers?: boolean | null;
/**
* Whether this Container supports user permissions managed by GTM.
*/
supportUserPermissions?: boolean | null;
/**
* Whether this Container supports variables.
*/
supportVariables?: boolean | null;
/**
* Whether this Container supports Container versions.
*/
supportVersions?: boolean | null;
/**
* Whether this Container supports workspaces.
*/
supportWorkspaces?: boolean | null;
/**
* Whether this Container supports zones.
*/
supportZones?: boolean | null;
}
/**
* Represents a Google Tag Manager Container Version.
*/
export interface Schema$ContainerVersion {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* The built-in variables in the container that this version was taken from.
*/
builtInVariable?: Schema$BuiltInVariable[];
/**
* The clients in the container that this version was taken from.
*/
client?: Schema$Client[];
/**
* The container that this version was taken from.
*/
container?: Schema$Container;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* The Container Version ID uniquely identifies the GTM Container Version.
*/
containerVersionId?: string | null;
/**
* The custom templates in the container that this version was taken from.
*/
customTemplate?: Schema$CustomTemplate[];
/**
* A value of true indicates this container version has been deleted.
*/
deleted?: boolean | null;
/**
* Container version description. @mutable tagmanager.accounts.containers.versions.update
*/
description?: string | null;
/**
* The fingerprint of the GTM Container Version as computed at storage time. This value is recomputed whenever the container version is modified.
*/
fingerprint?: string | null;
/**
* The folders in the container that this version was taken from.
*/
folder?: Schema$Folder[];
/**
* The Google tag configs in the container that this version was taken from.
*/
gtagConfig?: Schema$GtagConfig[];
/**
* Container version display name. @mutable tagmanager.accounts.containers.versions.update
*/
name?: string | null;
/**
* GTM Container Version's API relative path.
*/
path?: string | null;
/**
* The tags in the container that this version was taken from.
*/
tag?: Schema$Tag[];
/**
* Auto generated link to the tag manager UI
*/
tagManagerUrl?: string | null;
/**
* The transformations in the container that this version was taken from.
*/
transformation?: Schema$Transformation[];
/**
* The triggers in the container that this version was taken from.
*/
trigger?: Schema$Trigger[];
/**
* The variables in the container that this version was taken from.
*/
variable?: Schema$Variable[];
/**
* The zones in the container that this version was taken from.
*/
zone?: Schema$Zone[];
}
/**
* Represents a Google Tag Manager Container Version Header.
*/
export interface Schema$ContainerVersionHeader {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* The Container Version ID uniquely identifies the GTM Container Version.
*/
containerVersionId?: string | null;
/**
* A value of true indicates this container version has been deleted.
*/
deleted?: boolean | null;
/**
* Container version display name.
*/
name?: string | null;
/**
* Number of clients in the container version.
*/
numClients?: string | null;
/**
* Number of custom templates in the container version.
*/
numCustomTemplates?: string | null;
/**
* Number of Google tag configs in the container version.
*/
numGtagConfigs?: string | null;
/**
* Number of macros in the container version.
*/
numMacros?: string | null;
/**
* Number of rules in the container version.
*/
numRules?: string | null;
/**
* Number of tags in the container version.
*/
numTags?: string | null;
/**
* Number of transformations in the container version.
*/
numTransformations?: string | null;
/**
* Number of triggers in the container version.
*/
numTriggers?: string | null;
/**
* Number of variables in the container version.
*/
numVariables?: string | null;
/**
* Number of zones in the container version.
*/
numZones?: string | null;
/**
* GTM Container Version's API relative path.
*/
path?: string | null;
}
export interface Schema$CreateBuiltInVariableResponse {
/**
* List of created built-in variables.
*/
builtInVariable?: Schema$BuiltInVariable[];
}
/**
* Options for new container versions.
*/
export interface Schema$CreateContainerVersionRequestVersionOptions {
/**
* The name of the container version to be created.
*/
name?: string | null;
/**
* The notes of the container version to be created.
*/
notes?: string | null;
}
/**
* Create container versions response.
*/
export interface Schema$CreateContainerVersionResponse {
/**
* Compiler errors or not.
*/
compilerError?: boolean | null;
/**
* The container version created.
*/
containerVersion?: Schema$ContainerVersion;
/**
* Auto generated workspace path created as a result of version creation. This field should only be populated if the created version was not a quick preview.
*/
newWorkspacePath?: string | null;
/**
* Whether version creation failed when syncing the workspace to the latest container version.
*/
syncStatus?: Schema$SyncStatus;
}
/**
* Represents a Google Tag Manager Custom Template's contents.
*/
export interface Schema$CustomTemplate {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
*/
fingerprint?: string | null;
/**
* A reference to the Community Template Gallery entry.
*/
galleryReference?: Schema$GalleryReference;
/**
* Custom Template display name.
*/
name?: string | null;
/**
* GTM Custom Template's API relative path.
*/
path?: string | null;
/**
* Auto generated link to the tag manager UI
*/
tagManagerUrl?: string | null;
/**
* The custom template in text format.
*/
templateData?: string | null;
/**
* The Custom Template ID uniquely identifies the GTM custom template.
*/
templateId?: string | null;
/**
* GTM Workspace ID.
*/
workspaceId?: string | null;
}
/**
* Represents a Google Tag Destination.
*/
export interface Schema$Destination {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* Destination ID.
*/
destinationId?: string | null;
/**
* The Destination link ID uniquely identifies the Destination.
*/
destinationLinkId?: string | null;
/**
* The fingerprint of the Google Tag Destination as computed at storage time. This value is recomputed whenever the destination is modified.
*/
fingerprint?: string | null;
/**
* Destination display name.
*/
name?: string | null;
/**
* Destination's API relative path.
*/
path?: string | null;
/**
* Auto generated link to the tag manager UI.
*/
tagManagerUrl?: string | null;
}
/**
* A workspace entity that may represent a tag, trigger, variable, or folder in addition to its status in the workspace.
*/
export interface Schema$Entity {
/**
* Represents how the entity has been changed in the workspace.
*/
changeStatus?: string | null;
/**
* The client being represented by the entity.
*/
client?: Schema$Client;
/**
* The folder being represented by the entity.
*/
folder?: Schema$Folder;
/**
* The tag being represented by the entity.
*/
tag?: Schema$Tag;
/**
* The transformation being represented by the entity.
*/
transformation?: Schema$Transformation;
/**
* The trigger being represented by the entity.
*/
trigger?: Schema$Trigger;
/**
* The variable being represented by the entity.
*/
variable?: Schema$Variable;
}
/**
* Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types.
*/
export interface Schema$Environment {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* The environment authorization code.
*/
authorizationCode?: string | null;
/**
* The last update time-stamp for the authorization code.
*/
authorizationTimestamp?: string | null;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* Represents a link to a container version.
*/
containerVersionId?: string | null;
/**
* The environment description. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update
*/
description?: string | null;
/**
* Whether or not to enable debug by default for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update
*/
enableDebug?: boolean | null;
/**
* GTM Environment ID uniquely identifies the GTM Environment.
*/
environmentId?: string | null;
/**
* The fingerprint of the GTM environment as computed at storage time. This value is recomputed whenever the environment is modified.
*/
fingerprint?: string | null;
/**
* The environment display name. Can be set or changed only on USER type environments. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update
*/
name?: string | null;
/**
* GTM Environment's API relative path.
*/
path?: string | null;
/**
* Auto generated link to the tag manager UI
*/
tagManagerUrl?: string | null;
/**
* The type of this environment.
*/
type?: string | null;
/**
* Default preview page url for the environment. @mutable tagmanager.accounts.containers.environments.create @mutable tagmanager.accounts.containers.environments.update
*/
url?: string | null;
/**
* Represents a link to a quick preview of a workspace.
*/
workspaceId?: string | null;
}
/**
* Represents a Google Tag Manager Folder.
*/
export interface Schema$Folder {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
*/
fingerprint?: string | null;
/**
* The Folder ID uniquely identifies the GTM Folder.
*/
folderId?: string | null;
/**
* Folder display name. @mutable tagmanager.accounts.containers.workspaces.folders.create @mutable tagmanager.accounts.containers.workspaces.folders.update
*/
name?: string | null;
/**
* User notes on how to apply this folder in the container. @mutable tagmanager.accounts.containers.workspaces.folders.create @mutable tagmanager.accounts.containers.workspaces.folders.update
*/
notes?: string | null;
/**
* GTM Folder's API relative path.
*/
path?: string | null;
/**
* Auto generated link to the tag manager UI
*/
tagManagerUrl?: string | null;
/**
* GTM Workspace ID.
*/
workspaceId?: string | null;
}
/**
* Represents a Google Tag Manager Folder's contents.
*/
export interface Schema$FolderEntities {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* The list of tags inside the folder.
*/
tag?: Schema$Tag[];
/**
* The list of triggers inside the folder.
*/
trigger?: Schema$Trigger[];
/**
* The list of variables inside the folder.
*/
variable?: Schema$Variable[];
}
/**
* Represents the link between a custom template and an entry on the Community Template Gallery site.
*/
export interface Schema$GalleryReference {
/**
* The name of the host for the community gallery template.
*/
host?: string | null;
/**
* If a user has manually edited the community gallery template.
*/
isModified?: boolean | null;
/**
* The name of the owner for the community gallery template.
*/
owner?: string | null;
/**
* The name of the repository for the community gallery template.
*/
repository?: string | null;
/**
* The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
*/
signature?: string | null;
/**
* The version of the community gallery template.
*/
version?: string | null;
}
export interface Schema$GetContainerSnippetResponse {
/**
* Tagging snippet for a Container.
*/
snippet?: string | null;
}
/**
* The changes that have occurred in the workspace since the base container version.
*/
export interface Schema$GetWorkspaceStatusResponse {
/**
* The merge conflict after sync.
*/
mergeConflict?: Schema$MergeConflict[];
/**
* Entities that have been changed in the workspace.
*/
workspaceChange?: Schema$Entity[];
}
/**
* Represents a Google tag configuration.
*/
export interface Schema$GtagConfig {
/**
* Google tag account ID.
*/
accountId?: string | null;
/**
* Google tag container ID.
*/
containerId?: string | null;
/**
* The fingerprint of the Google tag config as computed at storage time. This value is recomputed whenever the config is modified.
*/
fingerprint?: string | null;
/**
* The ID uniquely identifies the Google tag config.
*/
gtagConfigId?: string | null;
/**
* The Google tag config's parameters. @mutable tagmanager.accounts.containers.workspaces.gtag_config.create @mutable tagmanager.accounts.containers.workspaces.gtag_config.update
*/
parameter?: Schema$Parameter[];
/**
* Google tag config's API relative path.
*/
path?: string | null;
/**
* Auto generated link to the tag manager UI
*/
tagManagerUrl?: string | null;
/**
* Google tag config type. @required tagmanager.accounts.containers.workspaces.gtag_config.create @required tagmanager.accounts.containers.workspaces.gtag_config.update @mutable tagmanager.accounts.containers.workspaces.gtag_config.create @mutable tagmanager.accounts.containers.workspaces.gtag_config.update
*/
type?: string | null;
/**
* Google tag workspace ID. Only used by GTM containers. Set to 0 otherwise.
*/
workspaceId?: string | null;
}
/**
* List Accounts Response.
*/
export interface Schema$ListAccountsResponse {
/**
* List of GTM Accounts that a user has access to.
*/
account?: Schema$Account[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$ListClientsResponse {
/**
* All GTM Clients of a GTM Container.
*/
client?: Schema$Client[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* List Containers Response.
*/
export interface Schema$ListContainersResponse {
/**
* All Containers of a GTM Account.
*/
container?: Schema$Container[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* List container versions response.
*/
export interface Schema$ListContainerVersionsResponse {
/**
* All container version headers of a GTM Container.
*/
containerVersionHeader?: Schema$ContainerVersionHeader[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$ListDestinationsResponse {
/**
* All Destinations linked to a GTM Container.
*/
destination?: Schema$Destination[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* A list of enabled built-in variables.
*/
export interface Schema$ListEnabledBuiltInVariablesResponse {
/**
* All GTM BuiltInVariables of a GTM container.
*/
builtInVariable?: Schema$BuiltInVariable[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* List Environments Response.
*/
export interface Schema$ListEnvironmentsResponse {
/**
* All Environments of a GTM Container.
*/
environment?: Schema$Environment[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* List Folders Response.
*/
export interface Schema$ListFoldersResponse {
/**
* All GTM Folders of a GTM Container.
*/
folder?: Schema$Folder[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$ListGtagConfigResponse {
/**
* All Google tag configs in a Container.
*/
gtagConfig?: Schema$GtagConfig[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
}
/**
* List Tags Response.
*/
export interface Schema$ListTagsResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* All GTM Tags of a GTM Container.
*/
tag?: Schema$Tag[];
}
export interface Schema$ListTemplatesResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* All GTM Custom Templates of a GTM Container.
*/
template?: Schema$CustomTemplate[];
}
export interface Schema$ListTransformationsResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* All GTM Transformations of a GTM Container.
*/
transformation?: Schema$Transformation[];
}
/**
* List triggers response.
*/
export interface Schema$ListTriggersResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* All GTM Triggers of a GTM Container.
*/
trigger?: Schema$Trigger[];
}
/**
* List user permissions response.
*/
export interface Schema$ListUserPermissionsResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* All GTM UserPermissions of a GTM Account.
*/
userPermission?: Schema$UserPermission[];
}
/**
* List Variables Response.
*/
export interface Schema$ListVariablesResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* All GTM Variables of a GTM Container.
*/
variable?: Schema$Variable[];
}
/**
* A list of workspaces in a container.
*/
export interface Schema$ListWorkspacesResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* All Workspaces of a GTM Container.
*/
workspace?: Schema$Workspace[];
}
export interface Schema$ListZonesResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string | null;
/**
* All GTM Zones of a GTM Container.
*/
zone?: Schema$Zone[];
}
/**
* Represents a merge conflict.
*/
export interface Schema$MergeConflict {
/**
* The base version entity (since the latest sync operation) that has conflicting changes compared to the workspace. If this field is missing, it means the workspace entity is deleted from the base version.
*/
entityInBaseVersion?: Schema$Entity;
/**
* The workspace entity that has conflicting changes compared to the base version. If an entity is deleted in a workspace, it will still appear with a deleted change status.
*/
entityInWorkspace?: Schema$Entity;
}
/**
* Represents a Google Tag Manager Parameter.
*/
export interface Schema$Parameter {
/**
* Whether or not a reference type parameter is strongly or weakly referenced. @mutable tagmanager.accounts.containers.workspaces.transformations.create @mutable tagmanager.accounts.containers.workspaces.transformations.update
*/
isWeakReference?: boolean | null;
/**
* 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
*/
key?: string | null;
/**
* 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
*/
list?: Schema$Parameter[];
/**
* 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
*/
map?: Schema$Parameter[];
/**
* 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
*/
type?: string | null;
/**
* 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
*/
value?: string | null;
}
/**
* Publish container version response.
*/
export interface Schema$PublishContainerVersionResponse {
/**
* Compiler errors or not.
*/
compilerError?: boolean | null;
/**
* The container version created.
*/
containerVersion?: Schema$ContainerVersion;
}
/**
* Response to quick previewing a workspace.
*/
export interface Schema$QuickPreviewResponse {
/**
* Were there compiler errors or not.
*/
compilerError?: boolean | null;
/**
* The quick previewed container version.
*/
containerVersion?: Schema$ContainerVersion;
/**
* Whether quick previewing failed when syncing the workspace to the latest container version.
*/
syncStatus?: Schema$SyncStatus;
}
/**
* The result of reverting a built-in variable in a workspace.
*/
export interface Schema$RevertBuiltInVariableResponse {
/**
* Whether the built-in variable is enabled after reversion.
*/
enabled?: boolean | null;
}
/**
* The result of reverting a client in a workspace.
*/
export interface Schema$RevertClientResponse {
/**
* 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.
*/
client?: Schema$Client;
}
/**
* The result of reverting folder changes in a workspace.
*/
export interface Schema$RevertFolderResponse {
/**
* Folder as it appears in the latest container version since the last workspace synchronization operation. If no folder is present, that means the folder was deleted in the latest container version.
*/
folder?: Schema$Folder;
}
/**
* The result of reverting a tag in a workspace.
*/
export interface Schema$RevertTagResponse {
/**
* Tag as it appears in the latest container version since the last workspace synchronization operation. If no tag is present, that means the tag was deleted in the latest container version.
*/
tag?: Schema$Tag;
}
/**
* The result of reverting a template in a workspace.
*/
export interface Schema$RevertTemplateResponse {
/**
* Template as it appears in the latest container version since the last workspace synchronization operation. If no template is present, that means the template was deleted in the latest container version.
*/
template?: Schema$CustomTemplate;
}
/**
* The result of reverting a transformation in a workspace.
*/
export interface Schema$RevertTransformationResponse {
/**
* Transformation as it appears in the latest container version since the last workspace synchronization operation. If no transformation is present, that means the transformation was deleted in the latest container version.
*/
transformation?: Schema$Transformation;
}
/**
* The result of reverting a trigger in a workspace.
*/
export interface Schema$RevertTriggerResponse {
/**
* Trigger as it appears in the latest container version since the last workspace synchronization operation. If no trigger is present, that means the trigger was deleted in the latest container version.
*/
trigger?: Schema$Trigger;
}
/**
* The result of reverting a variable in a workspace.
*/
export interface Schema$RevertVariableResponse {
/**
* Variable as it appears in the latest container version since the last workspace synchronization operation. If no variable is present, that means the variable was deleted in the latest container version.
*/
variable?: Schema$Variable;
}
/**
* The result of reverting a zone in a workspace.
*/
export interface Schema$RevertZoneResponse {
/**
* 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.
*/
zone?: Schema$Zone;
}
/**
* Represents a reference to atag that fires before another tag in order to set up dependencies.
*/
export interface Schema$SetupTag {
/**
* If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
*/
stopOnSetupFailure?: boolean | null;
/**
* The name of the setup tag.
*/
tagName?: string | null;
}
/**
* The status of a workspace after synchronization.
*/
export interface Schema$SyncStatus {
/**
* Synchornization operation detected a merge conflict.
*/
mergeConflict?: boolean | null;
/**
* An error occurred during the synchronization operation.
*/
syncError?: boolean | null;
}
/**
* A response after synchronizing the workspace to the latest container version.
*/
export interface Schema$SyncWorkspaceResponse {
/**
* 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.
*/
mergeConflict?: Schema$MergeConflict[];
/**
* Indicates whether synchronization caused a merge conflict or sync error.
*/
syncStatus?: Schema$SyncStatus;
}
/**
* Represents a Google Tag Manager Tag.
*/
export interface Schema$Tag {
/**
* GTM Account ID.
*/
accountId?: string | null;
/**
* Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
blockingRuleId?: string[] | null;
/**
* Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
blockingTriggerId?: string[] | null;
/**
* Consent settings of a tag. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
consentSettings?: Schema$TagConsentSetting;
/**
* GTM Container ID.
*/
containerId?: string | null;
/**
* The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
*/
fingerprint?: string | null;
/**
* Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
firingRuleId?: string[] | null;
/**
* Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
firingTriggerId?: string[] | null;
/**
* If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
liveOnly?: boolean | null;
/**
* A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes: - This parameter must be type MAP. - Each parameter in the map are type TEMPLATE, however cannot contain variable references. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
monitoringMetadata?: Schema$Parameter;
/**
* If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
monitoringMetadataTagNameKey?: string | null;
/**
* Tag display name. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update
*/
name?: string | null;
/**
* User notes on how to apply this tag in the container. @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager.accounts.conta