REST Resource: accounts.containers.workspaces.tags

แหล่งข้อมูล: แท็ก

แสดงแท็ก Google Tag Manager

การแสดง 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)
  }
}
ช่อง
path

string

เส้นทางที่เกี่ยวข้องของ API ของแท็ก GTM
accountId

string

รหัสบัญชี GTM
containerId

string

รหัสคอนเทนเนอร์ GTM
workspaceId

string

รหัสพื้นที่ทํางาน GTM
tagId

string

รหัสแท็กจะระบุแท็ก GTM ได้อย่างไม่ซ้ำกัน
name

string

ชื่อที่แสดงของแท็ก
type

string

ประเภทแท็ก GTM
liveOnly

boolean

หากตั้งค่าเป็น "จริง" แท็กนี้จะทํางานในสภาพแวดล้อมจริงเท่านั้น (เช่น ไม่ได้อยู่ในโหมดแสดงตัวอย่างหรือแก้ไขข้อบกพร่อง)
priority

object (Parameter)

ลําดับความสําคัญที่เป็นตัวเลขที่ผู้ใช้กําหนดของแท็ก แท็กจะทํางานแบบไม่พร้อมกันตามลําดับความสําคัญ แท็กที่มีค่าตัวเลขสูงกว่าจะทํางานก่อน ลําดับความสําคัญของแท็กอาจเป็นค่าบวกหรือค่าลบก็ได้ ค่าเริ่มต้นคือ 0
notes

string

หมายเหตุของผู้ใช้เกี่ยวกับวิธีใช้แท็กนี้ในคอนเทนเนอร์
scheduleStartMs

string (int64 format)

การประทับเวลาเริ่มต้นเป็นมิลลิวินาทีเพื่อกําหนดเวลาแท็ก
scheduleEndMs

string (int64 format)

การประทับเวลาสิ้นสุดเป็นมิลลิวินาทีเพื่อกําหนดเวลาแท็ก
parameter[]

object (Parameter)

พารามิเตอร์ของแท็ก
fingerprint

string

ลายนิ้วมือของแท็ก GTM ที่คำนวณ ณ เวลาจัดเก็บ ระบบจะคํานวณค่านี้ใหม่ทุกครั้งที่มีการแก้ไขแท็ก
firingTriggerId[]

string

รหัสทริกเกอร์ที่เริ่มทํางาน แท็กจะทํางานเมื่อทริกเกอร์ที่ระบุเป็นจริง และเงื่อนไขทั้งหมดของ

blockingTriggerIds

(หากระบุไว้) เป็นเท็จ
blockingTriggerId[]

string

รหัสทริกเกอร์การบล็อก หากทริกเกอร์ที่ระบุไว้ประเมินเป็น "จริง" แท็กจะไม่เริ่มทํางาน
setupTag[]

object (SetupTag)

รายการแท็กการตั้งค่า ปัจจุบันเราอนุญาตเพียงรายการเดียว
teardownTag[]

object (TeardownTag)

รายการแท็กการแยกวิเคราะห์ ปัจจุบันเราอนุญาตเพียงรายการเดียว
parentFolderId

string

รหัสโฟลเดอร์หลัก
tagFiringOption

enum (TagFiringOption)

ตัวเลือกในการเริ่มทํางานของแท็กนี้
tagManagerUrl

string

ลิงก์ที่สร้างขึ้นโดยอัตโนมัติไปยัง UI ของเครื่องมือจัดการแท็ก
paused

boolean

ระบุว่าแท็กหยุดชั่วคราวหรือไม่ ซึ่งจะทําให้แท็กไม่ทํางาน
monitoringMetadata

object (Parameter)

การแมปคู่คีย์-ค่าของข้อมูลเมตาแท็กที่จะรวมไว้ในข้อมูลเหตุการณ์สําหรับการตรวจสอบแท็ก หมายเหตุ:

  • พารามิเตอร์นี้ต้องเป็นประเภท

    MAP

    .

  • พารามิเตอร์แต่ละรายการในแผนที่เป็นประเภท

    TEMPLATE

    แต่ต้องไม่มีการอ้างอิงตัวแปร
monitoringMetadataTagNameKey

string

หากไม่ว่างเปล่า ชื่อที่แสดงของแท็กจะรวมอยู่ในแผนที่ข้อมูลเมตาการตรวจสอบโดยใช้คีย์ที่ระบุ
consentSettings

object (ConsentSetting)

การตั้งค่าความยินยอมของแท็ก

SetupTag

แสดงการอ้างอิงถึงแท็กที่เริ่มทํางานก่อนแท็กอื่นเพื่อตั้งค่าการพึ่งพา

การแสดง JSON 
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
ช่อง
tagName

string

ชื่อแท็กการตั้งค่า
stopOnSetupFailure

boolean

หากเป็น "จริง" ระบบจะเรียกใช้แท็กหลักก็ต่อเมื่อแท็กตั้งค่าเริ่มทํางานสําเร็จเท่านั้น หากเป็นเท็จ ระบบจะเรียกใช้แท็กหลักโดยไม่คำนึงถึงสถานะการเริ่มทํางานของแท็กตั้งค่า

TeardownTag

แสดงแท็กที่เริ่มทํางานหลังจากแท็กอื่นเพื่อยกเลิกการอ้างอิง

การแสดง JSON 
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
ช่อง
tagName

string

ชื่อแท็กการเลิกใช้งาน
stopTeardownOnFailure

boolean

หากเป็น "จริง" ระบบจะเรียกใช้แท็กการเลิกใช้งานก็ต่อเมื่อแท็กหลักเริ่มทํางานสําเร็จเท่านั้น หากเป็นเท็จ ระบบจะเรียกใช้แท็กการเลิกใช้งานโดยไม่คำนึงถึงสถานะการเริ่มทํางานของแท็กหลัก

TagFiringOption

Enum
tagFiringOptionUnspecified
unlimited แท็กสามารถเริ่มทํางานหลายครั้งต่อเหตุการณ์
oncePerEvent แท็กจะทํางานได้เพียงครั้งเดียวต่อเหตุการณ์ แต่ทํางานได้หลายครั้งต่อการโหลดแต่ละครั้ง (เช่น การโหลดแอปหรือการโหลดหน้าเว็บ)
oncePerLoad แท็กจะทํางานได้ต่อการโหลด 1 ครั้งเท่านั้น (เช่น การโหลดแอปหรือการโหลดหน้าเว็บ)

ConsentSetting

การแสดง JSON 
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
ช่อง
consentStatus

enum (ManualConsentOption)

สถานะความยินยอมของแท็ก หากตั้งค่าเป็น "จำเป็น" รันไทม์จะตรวจสอบว่าประเภทความยินยอมที่ระบุโดย

consentType

ฟิลด์แล้ว
consentType

object (Parameter)

ประเภทความยินยอมที่จะตรวจสอบระหว่างการเริ่มทํางานของแท็กหากอยู่ในสถานะ "จําเป็นต้องได้รับความยินยอม" พารามิเตอร์นี้ต้องเป็นประเภท

LIST

โดยที่รายการแต่ละรายการในลิสต์เป็นประเภท

STRING

.

ManualConsentOption

Enum
notSet ค่าเริ่มต้นที่ผู้ใช้ไม่ได้ระบุการตั้งค่าใดๆ
notNeeded แท็กไม่จําเป็นต้องมีการตั้งค่าความยินยอมเพิ่มเติม
needed แท็กต้องมีการตั้งค่าความยินยอมเพิ่มเติม

เมธอด

create

 สร้างแท็ก GTM

delete

 ลบแท็ก GTM

get

 รับแท็ก GTM

list

 แสดงรายการแท็ก GTM ทั้งหมดของคอนเทนเนอร์

revert

 เปลี่ยนการเปลี่ยนแปลงในแท็ก GTM ในเวิร์กสเปซ GTM กลับ

update

 อัปเดตแท็ก GTM