Variables: create

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

สร้างตัวแปร GTM ลองเลยหรือดูตัวอย่าง

ส่งคำขอ

คำขอ HTTP

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

พารามิเตอร์

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

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

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

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

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

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

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


ค่าที่ยอมรับได้ มีดังนี้
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
เขียนได้
type string ประเภทตัวแปร GTM เขียนได้
พร็อพเพอร์ตี้ที่ไม่บังคับ
disablingTriggerId[] list สําหรับคอนเทนเนอร์อุปกรณ์เคลื่อนที่เท่านั้น: รายการรหัสทริกเกอร์สําหรับปิดใช้ตัวแปรแบบมีเงื่อนไข ตัวแปรจะเปิดใช้หากทริกเกอร์เปิดใช้ตัวใดตัวหนึ่งเป็นจริง ขณะที่ทริกเกอร์ปิดใช้ทั้งหมดเป็นเท็จ ถือเป็นชุดที่ไม่ได้เรียงลำดับ เขียนได้
enablingTriggerId[] list สําหรับคอนเทนเนอร์อุปกรณ์เคลื่อนที่เท่านั้น: รายการรหัสทริกเกอร์สําหรับเปิดใช้ตัวแปรแบบมีเงื่อนไข ตัวแปรจะเปิดใช้หากทริกเกอร์เปิดใช้ตัวใดตัวหนึ่งเป็นจริง ขณะที่ทริกเกอร์ปิดใช้ทั้งหมดเป็นเท็จ ถือเป็นชุดที่ไม่ได้เรียงลำดับ เขียนได้
notes string หมายเหตุผู้ใช้เกี่ยวกับวิธีใช้ตัวแปรนี้ในคอนเทนเนอร์ เขียนได้
parameter[] list พารามิเตอร์ของตัวแปร เขียนได้
parameter[].key string คีย์ที่มีชื่อซึ่งระบุพารามิเตอร์ได้โดยไม่ซ้ำกัน ต้องระบุสำหรับพารามิเตอร์ระดับบนสุดและค่าแมป ละเว้นสำหรับค่ารายการ เขียนได้
parameter[].list[] list พารามิเตอร์ของพารามิเตอร์รายการนี้ (ระบบจะไม่สนใจคีย์) เขียนได้
parameter[].map[] list พารามิเตอร์ของพารามิเตอร์แมปนี้ (ต้องมีคีย์ คีย์ต้องไม่ซ้ำกัน) เขียนได้
parameter[].value string ค่าของพารามิเตอร์ (อาจมีการอ้างอิงตัวแปร เช่น "") ตามความเหมาะสมกับประเภทที่ระบุ เขียนได้
scheduleEndMs long การประทับเวลาสิ้นสุดในหน่วยมิลลิวินาทีเพื่อตั้งเวลาตัวแปร เขียนได้
scheduleStartMs long การประทับเวลาเริ่มต้นเป็นมิลลิวินาทีเพื่อตั้งเวลาตัวแปร เขียนได้

คำตอบ

หากสำเร็จ เมธอดนี้จะแสดงแหล่งข้อมูลตัวแปรในเนื้อหาการตอบกลับ

ตัวอย่าง

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

Java

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

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

/*
 * This request creates a new variable for the authorized user.
 */

// Create the variable object.
Variable variable = new Variable();
variable.setName("randomNumber");
variable.setType("r"); // The random number type.

try {
  Variable response = tagmanager.accounts().containers().
      variables().create("123456", "54321", variable).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 the response object.
 * The following code shows how to access the created Id and Fingerprint.
 */
System.out.println("Variable Id = " + response.getVariableId());
System.out.println("Variable Fingerprint = " + response.getFingerprint());

Python

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

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

# This request creates a new variable.
try:
  response = tagmanager.accounts().containers().variables().create(
      accountId='23732470',
      containerId='801231',
      body={
          'name': 'random_number',
          'type': 'r'
      }
  ).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 response object.
# The following code shows how to access the created id and fingerprint.
print 'Variable Id = %s' % response.get('variableId')
print 'Variable Fingerprint = %s' % response.get('fingerprint')

ลองใช้งาน

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