REST Resource: accounts.containers.workspaces.tags

Zasób: tag

Reprezentuje tag Menedżera tagów Google.

Zapis JSON
{
  "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)
  }
}
Pola
path

string

Ścieżka względna tagu Menedżera tagów do interfejsu API.

accountId

string

Identyfikator konta Menedżera tagów Google.

containerId

string

Identyfikator kontenera GTM.

workspaceId

string

Identyfikator obszaru roboczego Menedżera tagów Google.

tagId

string

Identyfikator tagu jednoznacznie identyfikuje tag Google Tag Manager.

name

string

Wyświetlana nazwa tagu.

type

string

Typ tagu GTM.

liveOnly

boolean

Jeśli ta opcja ma wartość Prawda, tag będzie uruchamiany tylko w środowisku produkcyjnym (np. nie w podglądzie ani w trybie debugowania).

priority

object (Parameter)

Liczba określająca priorytet tagu zdefiniowany przez użytkownika. Tagi są uruchamiane asynchronicznie według priorytetu. Tagi o wyższej wartości liczbowej są uruchamiane jako pierwsze. Priorytet tagu może być wartością dodatnią lub ujemną. Wartością domyślną jest 0.

notes

string

Użytkownik może przeczytać, jak zastosować ten tag w kontenerze.

scheduleStartMs

string (int64 format)

Czas rozpoczęcia w milisekundach do zaplanowania tagu.

scheduleEndMs

string (int64 format)

Sygnatura czasowa zakończenia w milisekundach do zaplanowania tagu.

parameter[]

object (Parameter)

Parametry tagu.

fingerprint

string

Odcisk palca tagu GTM obliczony w momencie zapisu. Ta wartość jest ponownie obliczana po każdej modyfikacji tagu.

firingTriggerId[]

string

Identyfikatory uruchamiające reguły. Tag jest uruchamiany, gdy spełniona jest dowolna z wymienionych reguł i wszystkie

blockingTriggerIds

(jeśli są określone) są fałszywe.

blockingTriggerId[]

string

Identyfikatory reguł blokujących. Jeśli którykolwiek z wymienionych reguł zwróci wartość „prawda”, tag się nie uruchomi.

setupTag[]

object (SetupTag)

Lista tagów konfiguracji. Obecnie zezwalamy tylko na 1 konto.

teardownTag[]

object (TeardownTag)

Lista tagów demontażu. Obecnie zezwalamy tylko na 1 konto.

parentFolderId

string

Identyfikator folderu nadrzędnego.

tagFiringOption

enum (TagFiringOption)

Opcja uruchomienia tego tagu.

tagManagerUrl

string

Automatycznie wygenerowany link do interfejsu Menedżera tagów

paused

boolean

Wskazuje, czy tag jest wstrzymany, co uniemożliwia jego uruchomienie.

monitoringMetadata

object (Parameter)

Mapa par klucz-wartość metadanych tagu, które mają być uwzględnione w danych zdarzenia służących do monitorowania tagu. Uwagi:

  • Ten parametr musi być typu

    MAP

    .

  • Każdy parametr na mapie jest typu

    TEMPLATE

    nie może jednak zawierać odniesień do zmiennych.

monitoringMetadataTagNameKey

string

Jeśli nie jest pusty, wyświetlana nazwa tagu zostanie uwzględniona w mapie metadanych monitorowania za pomocą podanego klucza.

consentSettings

object (ConsentSetting)

Ustawienia zgody tagu.

SetupTag

Reprezentuje odwołanie do tagu, który uruchamia się przed innym tagiem w celu konfigurowania zależności.

Zapis JSON
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
Pola
tagName

string

Nazwa tagu konfiguracji.

stopOnSetupFailure

boolean

Jeśli ma wartość Prawda, tag główny uruchamia się tylko wtedy, gdy tag konfiguracji został uruchomiony. Jeśli wartość to „False”, tag główny zostanie uruchomiony niezależnie od stanu tagu konfiguracji.

TeardownTag

Reprezentuje tag, który uruchamia się po innym tagu, aby usunąć zależności.

Zapis JSON
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
Pola
tagName

string

Nazwa tagu demontażu.

stopTeardownOnFailure

boolean

Jeśli ma wartość true, tag demontażu jest uruchamiany tylko wtedy, gdy tag główny został uruchomiony. Jeśli wartość to fałsz, tag demontażu uruchamia się niezależnie od stanu uruchamiania głównego tagu.

TagFiringOption

Wartości w polu enum
tagFiringOptionUnspecified
unlimited Tag może być uruchamiany wielokrotnie na zdarzenie.
oncePerEvent Tag może być uruchamiany tylko raz na zdarzenie, ale może być uruchamiany wielokrotnie podczas wczytywania (np. wczytywania aplikacji lub strony).
oncePerLoad Tag może być wywoływany tylko podczas wczytywania (np. wczytywania aplikacji lub strony).

ConsentSetting

Zapis JSON
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
Pola
consentStatus

enum (ManualConsentOption)

Stan zgody na wykorzystanie tagu. Jeśli ustawisz wartość NEEDED, środowisko uruchomieniowe sprawdzi, czy typy zgody określone przez

consentType

zostało przyznane.

consentType

object (Parameter)

Rodzaj zgody do sprawdzenia podczas uruchamiania tagu, jeśli stan zgody to ZGODA UZALEŻNIONA. Ten parametr musi być typu

LIST

gdzie każdy element listy jest typu

STRING

.

ManualConsentOption

Wartości w polu enum
notSet Wartość domyślna, gdy użytkownik nie określił żadnych ustawień.
notNeeded Tag nie wymaga żadnych dodatkowych ustawień zgody.
needed Tag wymaga dodatkowych ustawień zgody.

Metody

create

Tworzy tag GTM.

delete

Usuwa tag GTM.

get

Pobiera tag GTM.

list

Wyświetla wszystkie tagi GTM w kontenerze.

revert

Cofnij zmiany w tagu GTM w obszarze roboczym GTM.

update

Aktualizuje tag GTM.