Variables: create

Cần phải uỷ quyền

Tạo biến GTM. Thử ngay hoặc xem ví dụ.

Yêu cầu

Yêu cầu HTTP

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

Tham số

Tên thông số Giá trị Mô tả
Tham số đường dẫn
accountId string Mã tài khoản GTM.
containerId string Mã vùng chứa Trình quản lý thẻ của Google (GTM).

Ủy quyền

Yêu cầu này cần có sự cho phép có phạm vi sau (đọc thêm về quy trình xác thực và uỷ quyền).

Phạm vi
https://www.googleapis.com/auth/tagmanager.edit.containers

Nội dung yêu cầu

Trong nội dung yêu cầu, hãy cung cấp tài nguyên Biến với các thuộc tính sau:

Tên tài sản Giá trị Mô tả Ghi chú
Thuộc tính bắt buộc
name string Tên hiển thị của biến. có thể ghi
parameter[].type string Loại thông số. Các giá trị hợp lệ là:
  • boolean: Giá trị đại diện cho một boolean, được biểu thị dưới dạng "true" hoặc "false"
  • integer: Giá trị đại diện cho giá trị số nguyên 64 bit đã ký, trong cơ số 10
  • list: Bạn cần chỉ định danh sách các tham số
  • map: Cần chỉ định sơ đồ liên kết các tham số
  • template: Giá trị đại diện cho văn bản bất kỳ; điều này có thể bao gồm các tham chiếu biến (thậm chí cả các tham chiếu biến có thể trả về các loại không phải chuỗi)
  • trigger_reference: Giá trị đại diện cho một điều kiện kích hoạt, được biểu thị dưới dạng mã điều kiện kích hoạt


Các giá trị được chấp nhận là:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
có thể ghi
type string Loại biến Trình quản lý thẻ của Google (GTM). có thể ghi
Thuộc tính không bắt buộc
disablingTriggerId[] list Chỉ đối với vùng chứa thiết bị di động: Danh sách mã kích hoạt để tắt biến có điều kiện; biến được bật nếu một trong các trình kích hoạt bật là true trong khi tất cả trình kích hoạt vô hiệu hóa là false. Được coi là một tập hợp không theo thứ tự. có thể ghi
enablingTriggerId[] list Chỉ đối với vùng chứa thiết bị di động: Danh sách mã điều kiện kích hoạt để bật biến có điều kiện; biến được bật nếu một trong các trình kích hoạt bật là true trong khi tất cả các trình kích hoạt tắt là false. Được coi là một tập hợp không theo thứ tự. có thể ghi
notes string Ghi chú của người dùng về cách áp dụng biến này trong vùng chứa. có thể ghi
parameter[] list Các tham số của biến. có thể ghi
parameter[].key string Khoá được đặt tên giúp nhận dạng duy nhất một thông số. Bắt buộc đối với các thông số cấp cao nhất, cũng như các giá trị bản đồ. Bỏ qua đối với các giá trị danh sách. có thể ghi
parameter[].list[] list Các tham số của tham số danh sách này (các khoá sẽ bị bỏ qua). có thể ghi
parameter[].map[] list Các thông số của thông số ánh xạ này (phải có khoá; khoá phải là duy nhất). có thể ghi
parameter[].value string Giá trị của thông số (có thể chứa các biến tham chiếu như "") phù hợp với loại đã chỉ định. có thể ghi
scheduleEndMs long Dấu thời gian kết thúc tính bằng mili giây để lên lịch cho một biến. có thể ghi
scheduleStartMs long Dấu thời gian bắt đầu tính bằng mili giây để lên lịch cho một biến. có thể ghi

Phản hồi

Nếu thành công, phương thức này sẽ trả về một Tài nguyên biến trong nội dung phản hồi.

Ví dụ

Lưu ý: Các đoạn mã mẫu của phương thức này không phải là ví dụ cho mọi ngôn ngữ lập trình được hỗ trợ (xem trang thông tin về các thư viện dùng cho ứng dụng để biết danh sách các ngôn ngữ được hỗ trợ).

Java

Dùng thư viện ứng dụng 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

Dùng thư viện ứng dụng 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')

Hãy dùng thử!

Hãy sử dụng APIs Explorer (Trình khám phá API) bên dưới để gọi phương thức này trên dữ liệu trực tiếp và xem phản hồi.