Tags: create

ต้องมีการให้สิทธิ์

สร้างแท็ก GTM ลองใช้เลยหรือดูตัวอย่าง

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/tags

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
accountId string รหัสบัญชี GTM
containerId string รหัสคอนเทนเนอร์ GTM

การให้สิทธิ์

คำขอนี้ต้องได้รับสิทธิ์ด้วยขอบเขตต่อไปนี้ (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)

ขอบเขต
https://www.googleapis.com/auth/tagmanager.edit.containers

เนื้อหาของคำขอ

ในเนื้อหาคำขอ ให้ระบุทรัพยากรแท็กพร้อมด้วยพร็อพเพอร์ตี้ต่อไปนี้

ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย Notes
พร็อพเพอร์ตี้ที่จำเป็น
name string ชื่อที่แสดงของแท็ก เขียนได้
parameter[].type string ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
  • boolean: ค่านี้แทนค่าบูลีน ซึ่งแสดงเป็น "true" หรือ "false"
  • integer: ค่านี้แสดงค่าจำนวนเต็มแบบมีเครื่องหมาย 64 บิตในฐาน 10
  • list: ควรระบุรายการพารามิเตอร์
  • map: ควรระบุแมปของพารามิเตอร์
  • template: ค่าแสดงถึงข้อความทุกอย่าง ซึ่งอาจรวมถึงการอ้างอิงตัวแปร (แม้แต่การอ้างอิงตัวแปรที่อาจแสดงประเภทที่ไม่ใช่สตริง)
  • trigger_reference: ค่านี้แทนทริกเกอร์ ซึ่งแสดงเป็นรหัสทริกเกอร์


ค่าที่ยอมรับมีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
เขียนได้
priority.type string ประเภทพารามิเตอร์ ค่าที่ถูกต้องคือ:
  • boolean: ค่านี้แทนค่าบูลีน ซึ่งแสดงเป็น "true" หรือ "false"
  • integer: ค่านี้แสดงค่าจำนวนเต็มแบบมีเครื่องหมาย 64 บิตในฐาน 10
  • list: ควรระบุรายการพารามิเตอร์
  • map: ควรระบุแมปของพารามิเตอร์
  • template: ค่าแสดงถึงข้อความทุกอย่าง ซึ่งอาจรวมถึงการอ้างอิงตัวแปร (แม้แต่การอ้างอิงตัวแปรที่อาจแสดงประเภทที่ไม่ใช่สตริง)
  • trigger_reference: ค่านี้แทนทริกเกอร์ ซึ่งแสดงเป็นรหัสทริกเกอร์


ค่าที่ยอมรับมีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
เขียนได้
type string ประเภทแท็ก GTM เขียนได้
พร็อพเพอร์ตี้ที่ไม่บังคับ
blockingRuleId[] list รหัสกฎการบล็อก หากกฎใดๆ ที่ระบุไว้ประเมินได้ว่าเป็น "จริง" แท็กจะไม่เริ่มทํางาน เขียนได้
blockingTriggerId[] list รหัสทริกเกอร์การบล็อก หากทริกเกอร์ใดๆ ในรายการประเมินค่าเป็น "จริง" แท็กจะไม่เริ่มทํางาน เขียนได้
firingRuleId[] list รหัสกฎการเริ่มทำงาน แท็กจะเริ่มทำงานเมื่อกฎใดๆ ที่ระบุไว้เป็นจริง และ blockingRuleIds ทั้งหมด (หากระบุไว้) เป็นเท็จ เขียนได้
firingTriggerId[] list รหัสทริกเกอร์การเริ่มทำงาน แท็กจะเริ่มทำงานเมื่อทริกเกอร์ใดๆ ที่ระบุไว้เป็นจริง และ blockingTriggerIds ทั้งหมด (หากระบุไว้) เป็นเท็จ เขียนได้
liveOnly boolean หากตั้งค่าเป็น "จริง" แท็กนี้จะเริ่มทำงานในสภาพแวดล้อมจริงเท่านั้น (เช่น ไม่อยู่ในโหมดแสดงตัวอย่างหรือแก้ไขข้อบกพร่อง) เขียนได้
notes string ผู้ใช้ระบุวิธีใช้แท็กนี้ในคอนเทนเนอร์ เขียนได้
parameter[] list พารามิเตอร์ของแท็ก เขียนได้
parameter[].key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
parameter[].list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
parameter[].map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
parameter[].value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
paused boolean เป็นจริงหากแท็กหยุดชั่วคราว เขียนได้
priority nested object ตัวเลขลำดับความสำคัญของแท็กที่ผู้ใช้กำหนด แท็กจะเริ่มทำงานแบบอะซิงโครนัสตามลำดับความสำคัญ แท็กที่มีค่าตัวเลขสูงกว่าจะเริ่มทำงานก่อน ลำดับความสำคัญของแท็กอาจเป็นค่าบวกหรือค่าลบก็ได้ ค่าเริ่มต้นคือ 0 เขียนได้
priority.key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
priority.list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
priority.map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
priority.value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
scheduleEndMs long การประทับเวลาสิ้นสุดเป็นมิลลิวินาทีเพื่อตั้งเวลาแท็ก เขียนได้
scheduleStartMs long การประทับเวลาเริ่มต้นเป็นมิลลิวินาทีเพื่อตั้งเวลาแท็ก เขียนได้

คำตอบ

หากสำเร็จ เมธอดนี้จะแสดงทรัพยากรแท็กในเนื้อหาของการตอบสนอง

ตัวอย่าง

หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)

Java

ใช้ไลบรารีของไคลเอ็นต์ Java

/*
 * Note: This code assumes you have an authorized tagmanager service object.
 */

/*
 * This request creates a new tag.
 */

// Construct the parameters.
Parameter arg0 = new Parameter();
arg0.setType("template");
arg0.setKey("trackingId");
arg0.setValue("UA-123456-1");

Parameter arg1 = new Parameter();
arg1.setType("template");
arg1.setKey("type");
arg1.setValue("TRACK_TRANSACTION");

// Construct the tag object.
Tag tag = new Tag();
tag.setName("Sample Universal Analytics Tag");
tag.setType("ua");
tag.setLiveOnly(false);
tag.setParameter(Arrays.asList(arg0, arg1));

try {
  Tag response = tagmanager.accounts().containers().
      tags().create("123456", "54321", tag).execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/*
 * The results of the create method are stored in response object.
 * The following code shows how to access the created id and fingerprint.
 */
System.out.println("Tag id = " + response.getTagId());
System.out.println("Tag Fingerprint = " + response.getFingerprint());

Python

ใช้ไลบรารีของไคลเอ็นต์ Python

# Note: This code assumes you have an authorized tagmanager service object.

# This request creates a new container tag.
try:
  response = tagmanager.accounts().containers().tags().create(
      accountId='123456',
      containerId='54321',
      body={
          'name': 'Universal Analytics Tag',
          'type': 'ua',
          'liveOnly': False,
          'parameter': [
              {
                  'type': 'template',
                  'key': 'trackingId',
                  'value': 'UA-123456-1'
              },
              {
                  'type': 'template',
                  'key': 'type',
                  'value': 'TRACK_TRANSACTION'
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# The results of the create method are stored in the response object.
# The following code shows how to access the created id and fingerprint.
print response.get('tagId')
print response.get('fingerprint')

ลองใช้เลย

ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบเรียลไทม์และดูการตอบสนอง