REST Resource: accounts.containers.workspaces.tags

Ressource: Tag

Stellt ein Google Tag Manager-Tag dar.

JSON-Darstellung 
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "liveOnly": boolean,
  "priority": {
    object (Parameter)
  },
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      object (SetupTag)
    }
  ],
  "teardownTag": [
    {
      object (TeardownTag)
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": enum (TagFiringOption),
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    object (Parameter)
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    object (ConsentSetting)
  }
}
Felder
path

string

Der relative API-Pfad des GTM-Tags.
accountId

string

GTM-Konto-ID
containerId

string

GTM-Container-ID.
workspaceId

string

GTM-Workspace-ID.
tagId

string

Die Tag-ID identifiziert das GTM-Tag eindeutig.
name

string

Anzeigename des Tags.
type

string

GTM-Tag-Typ
liveOnly

boolean

Wenn dieser Wert auf „true“ gesetzt ist, wird dieses Tag nur in der Live-Umgebung ausgelöst (z.B. nicht im Vorschau- oder Debug-Modus).
priority

object (Parameter)

Benutzerdefinierte numerische Priorität des Tags. Tags werden asynchron in der Reihenfolge ihrer Priorität ausgelöst. Tags mit einem höheren numerischen Wert werden zuerst ausgelöst. Die Priorität eines Tags kann ein positiver oder negativer Wert sein. Der Standardwert ist 0.
notes

string

Nutzerhinweise zur Anwendung dieses Tags im Container.
scheduleStartMs

string (int64 format)

Der Zeitstempel in Millisekunden, zu dem ein Tag geplant werden soll.
scheduleEndMs

string (int64 format)

Der Endzeitstempel in Millisekunden für die Planung eines Tags.
parameter[]

object (Parameter)

Die Parameter des Tags.
fingerprint

string

Der Fingerabdruck des GTM-Tags, wie er zum Zeitpunkt der Speicherung berechnet wurde. Dieser Wert wird jedes Mal neu berechnet, wenn das Tag geändert wird.
firingTriggerId[]

string

Trigger-IDs auslösen Ein Tag wird ausgelöst, wenn einer der aufgeführten Trigger wahr ist und alle

blockingTriggerIds

(falls angegeben) falsch sind.
blockingTriggerId[]

string

Blockierende Trigger-IDs Wenn einer der aufgeführten Trigger als wahr ausgewertet wird, wird das Tag nicht ausgelöst.
setupTag[]

object (SetupTag)

Die Liste der Einrichtungs-Tags. Derzeit ist nur ein Konto zulässig.
teardownTag[]

object (TeardownTag)

Die Liste der Deaktivierungs-Tags. Derzeit ist nur ein Konto zulässig.
parentFolderId

string

ID des übergeordneten Ordners.
tagFiringOption

enum (TagFiringOption)

Option zum Auslösen dieses Tags.
tagManagerUrl

string

Automatisch generierter Link zur Tag Manager-Benutzeroberfläche
paused

boolean

Gibt an, ob das Tag pausiert ist, wodurch das Auslösen des Tags verhindert wird.
monitoringMetadata

object (Parameter)

Eine Zuordnung von Schlüssel/Wert-Paaren von Tag-Metadaten, die in die Ereignisdaten für die Tag-Überwachung einbezogen werden sollen. Hinweise:

  • Dieser Parameter muss vom Typ

    MAP

    .

  • Jeder Parameter in der Zuordnung hat den Typ

    TEMPLATE

    dürfen jedoch keine Variablenreferenzen enthalten.
monitoringMetadataTagNameKey

string

Wenn der Name nicht leer ist, wird er mit dem angegebenen Schlüssel in die Metadatenzuordnung für die Überwachung aufgenommen.
consentSettings

object (ConsentSetting)

Einwilligungseinstellungen eines Tags.

SetupTag

Stellt einen Verweis auf ein Tag dar, das vor einem anderen Tag ausgelöst wird, um Abhängigkeiten einzurichten.

JSON-Darstellung 
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
Felder
tagName

string

Der Name des Einrichtungstags.
stopOnSetupFailure

boolean

Wenn „true“ festgelegt ist, wird das Haupt-Tag nur dann ausgelöst, wenn das Setup-Tag erfolgreich ausgelöst wurde. Wenn „falsch“ festgelegt ist, wird das Haupt-Tag unabhängig vom Status der Auslösung des Setup-Tags ausgelöst.

TeardownTag

Stellt ein Tag dar, das nach einem anderen Tag ausgelöst wird, um Abhängigkeiten aufzuheben.

JSON-Darstellung 
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
Felder
tagName

string

Der Name des Deaktivierungs-Tags.
stopTeardownOnFailure

boolean

Wenn „wahr“ festgelegt ist, wird das Tag zum Rückbau nur dann ausgelöst, wenn das Haupt-Tag erfolgreich ausgelöst wurde. Wenn „false“ festgelegt ist, wird das Tag für den Rückbau unabhängig vom Status der Auslösung des Haupt-Tags ausgelöst.

TagFiringOption

Enums
tagFiringOptionUnspecified
unlimited Das Tag kann pro Ereignis mehrmals ausgelöst werden.
oncePerEvent Das Tag kann nur pro Ereignis ausgelöst werden, aber mehrmals pro Ladevorgang (z.B. App-Laden oder Seitenladevorgang).
oncePerLoad Das Tag kann nur einmal pro Ladevorgang ausgelöst werden (z.B. App- oder Seitenladevorgang).

ConsentSetting

JSON-Darstellung 
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
Felder
consentStatus

enum (ManualConsentOption)

Der Einwilligungsstatus des Tags. Wenn „NEEDED“ festgelegt ist, prüft die Laufzeit, ob die vom

consentType

Feld gewährt wurden.
consentType

object (Parameter)

Die Art der Einwilligungen, die beim Auslösen des Tags geprüft werden sollen, wenn der Einwilligungsstatus „ERFORDERLICH“ ist. Dieser Parameter muss den Typ

LIST

wobei jedes Listenelement vom Typ

STRING

.

ManualConsentOption

Enums
notSet Standardwert, wenn der Nutzer keine Einstellung angegeben hat.
notNeeded Für das Tag sind keine zusätzlichen Einwilligungseinstellungen erforderlich.
needed Für das Tag sind zusätzliche Einwilligungseinstellungen erforderlich.

Methoden

create

 Erstellt ein GTM-Tag.

delete

 Löscht ein GTM-Tag.

get

 Ermittelt ein GTM-Tag.

list

 Hier werden alle GTM-Tags eines Containers aufgelistet.

revert

 Hiermit werden Änderungen an einem GTM-Tag in einem GTM-Arbeitsbereich rückgängig gemacht.

update

 Aktualisiert ein GTM-Tag.