REST Resource: accounts.containers.workspaces.tags

Kaynak: Etiket

Bir Google Etiket Yöneticisi etiketini temsil eder.

JSON gösterimi
{
  "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)
  }
}
Alanlar
path

string

GTM etiketinin API'ye göreli yolu.

accountId

string

GTM hesap kimliği.

containerId

string

GTM kapsayıcı kimliği.

workspaceId

string

GTM Workspace kimliği.

tagId

string

Etiket kimliği, GTM etiketini benzersiz şekilde tanımlar.

name

string

Etiketin görünen adı.

type

string

GTM etiket türü.

liveOnly

boolean

Doğru olarak ayarlanırsa bu etiket yalnızca canlı ortamda tetiklenir (ör. önizleme veya hata ayıklama modunda değil).

priority

object (Parameter)

Etiketin kullanıcı tanımlı sayısal önceliği. Etiketler, öncelik sırasına göre eşzamansız olarak tetiklenir. Daha yüksek sayısal değere sahip etiketler önce tetiklenir. Etiketin önceliği pozitif veya negatif bir değer olabilir. Varsayılan değer 0'dır.

notes

string

Bu etiketin kapsayıcıya nasıl uygulanacağına dair kullanıcı notları.

scheduleStartMs

string (int64 format)

Etiket planlamak için milisaniye cinsinden başlangıç zaman damgası.

scheduleEndMs

string (int64 format)

Etiketin planlanacağı bitiş zaman damgası (milisaniye).

parameter[]

object (Parameter)

Etiketin parametreleri.

fingerprint

string

Depolama sırasında hesaplanan GTM etiketinin parmak izi. Bu değer, etiket değiştirildiğinde yeniden hesaplanır.

firingTriggerId[]

string

Tetikleyici kimlikleri etkinleştirme. Bir etiket, listelenen tetikleyicilerden herhangi biri doğru olduğunda ve

blockingTriggerIds

(varsa) yanlıştır.

blockingTriggerId[]

string

Engelleme tetikleyici kimlikleri. Listelenen tetikleyicilerden herhangi biri doğru olarak değerlendirilirse etiket etkinleşmez.

setupTag[]

object (SetupTag)

Kurulum etiketlerinin listesi. Şu anda yalnızca bir tanesine izin verilmektedir.

teardownTag[]

object (TeardownTag)

Ayrıntılı inceleme etiketlerinin listesi. Şu anda yalnızca bir tanesine izin verilmektedir.

parentFolderId

string

Üst klasör kimliği.

tagFiringOption

enum (TagFiringOption)

Bu etiketi etkinleştirme seçeneği.

tagManagerUrl

string

Etiket Yöneticisi kullanıcı arayüzüne otomatik olarak oluşturulan bağlantı

paused

boolean

Etiketin duraklatılıp duraklatılmadığını belirtir. Bu durum, etiketin tetiklenmesini engeller.

monitoringMetadata

object (Parameter)

Etiket izleme için etkinlik verilerine eklenecek etiket meta verilerinin anahtar/değer çiftlerinin haritası. Notlar:

  • Bu parametre türü olmalıdır

    MAP

    .

  • Haritadaki her parametre türü

    TEMPLATE

    Ancak değişken referansları içeremez.

monitoringMetadataTagNameKey

string

Boş değilse etiket görünen adı, belirtilen anahtar kullanılarak izleme meta veri haritasına dahil edilir.

consentSettings

object (ConsentSetting)

Bir etiketin izin ayarları.

SetupTag

Bağımlılıkları ayarlamak için başka bir etiketten önce tetiklenen bir etikete referans verir.

JSON gösterimi
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
Alanlar
tagName

string

Kurulum etiketinin adı.

stopOnSetupFailure

boolean

Doğru ise ana etiketi yalnızca kurulum etiketi başarılı bir şekilde tetiklenirse tetikleyin. Yanlış ise kurulum etiketinin tetiklenme durumundan bağımsız olarak ana etiketi tetikleyin.

TeardownTag

Bağımlılıkları kaldırmak için başka bir etiketten sonra tetiklenen bir etiketi temsil eder.

JSON gösterimi
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
Alanlar
tagName

string

Ayrıntılı inceleme etiketinin adı.

stopTeardownOnFailure

boolean

Doğru ise teardown etiketini yalnızca ana etiket başarıyla tetiklenirse tetikleyin. Yanlış ise ana etiketin tetiklenme durumundan bağımsız olarak teardown etiketini tetikleyin.

TagFiringOption

Sıralamalar
tagFiringOptionUnspecified
unlimited Etiket, etkinlik başına birden çok kez tetiklenebilir.
oncePerEvent Etiket yalnızca etkinlik başına tetiklenebilir ancak yükleme başına birden çok kez tetiklenebilir (ör. uygulama yükleme veya sayfa yükleme).
oncePerLoad Etiket yalnızca yükleme başına (ör. uygulama yükleme veya sayfa yükleme) tetiklenebilir.

ConsentSetting

JSON gösterimi
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
Alanlar
consentStatus

enum (ManualConsentOption)

Etiketin izin durumu. NEEDED olarak ayarlanırsa çalışma zamanı,

consentType

alanına erişim izni verildi.

consentType

object (Parameter)

İzin NEEDED durumundaysa etiket etkinleştirilirken kontrol edilecek izin türleri. Bu parametre

LIST

Her liste öğesinin türü

STRING

.

ManualConsentOption

Sıralamalar
notSet Kullanıcının herhangi bir ayar belirtmediği varsayılan değer.
notNeeded Etiket için ek izin ayarları gerekmez.
needed Etiket için ek izin ayarları gerekir.

Yöntemler

create

GTM etiketi oluşturur.

delete

Bir GTM etiketini siler.

get

GTM etiketi alır.

list

Bir kapsayıcının tüm GTM etiketlerini listeler.

revert

GTM Workspace'teki bir GTM etiketindeki değişiklikleri geri alır.

update

GTM etiketini günceller.