API Trình quản lý thẻ - Tham khảo thông số

Tài liệu này mô tả mục đích và cách trình bày của đối tượng thông số Trình quản lý thẻ.

Giới thiệu

API Trình quản lý thẻ cho phép bạn tạo và quản lý các tài nguyên của Trình quản lý thẻ như Thẻ, Trình kích hoạt và Biến.

Hầu hết các loại Thẻ và Biến đều có các thông số bổ sung dành riêng cho Thẻ hoặc Biến và có thể được đặt khi tạo/cập nhật tài nguyên. Danh sách các thông số (cặp key, type) cho mỗi loại Thẻ và Biến được liệt kê trong Tài liệu tham khảo từ điển về thẻ.

Để định cấu hình các thông số cụ thể của Thẻ hoặc Biến này, một đối tượng thông số được xác định và đặt làm giá trị cho thuộc tính parameter của tài nguyên Thẻ hoặc Biến.

Đối tượng tham số

Đối tượng sau đại diện cho một đối tượng tham số:

[
  {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  }
]

type

Loại thông số của Thẻ hoặc Biến đang được định cấu hình.

Thuộc tính type sẽ xác định xem có cần đưa thuộc tính value, list hay map vào đối tượng tham số hay không, như mô tả trong bảng dưới đây.

Ví dụ: nếu bạn đặt type thành boolean, thì bạn phải đưa thuộc tính value vào đối tượng tham số và đặt thành true hoặc false.

Giá trị	Thuộc tính bổ sung cần bao gồm	Nội dung cần thiết lập thuộc tính bổ sung
template	value	value là chuỗi bất kỳ, bao gồm cả các tham chiếu biến, ví dụ: foo{{bar}}.
boolean	value	value là true hoặc false.
number	value	value là một số nguyên.
list	list	list sẽ không chứa hoặc chứa nhiều tham số, thứ tự có thể/có thể không quan trọng; key của bất kỳ tham số nào trong list sẽ bị bỏ qua.
map	map	map sẽ chứa 0 hoặc nhiều tham số, thứ tự không quan trọng; key trên bất kỳ tham số nào trong map phải là duy nhất.

key

Khoá thông số của Thẻ hoặc Biến đang được định cấu hình.

Trường key dùng để xác định thông số của các Thẻ hoặc Biến cụ thể đang được đặt. Mọi loại tham số đều cần có thuộc tính key (ngoại trừ các tham số list).

Ví dụ

Đối tượng thông số cho một Thẻ HTML tuỳ chỉnh, có 1 thông số loại template và 2 thông số loại boolean:

"parameter": [
  {
    "key": "html",
    "type": "template",
    "value": "<script>alert('hello world')</script>"
  },
  {
    "key": "supportDocumentWrite",
    "type": "boolean",
    "value": "false"
  }
]

Đối tượng tham số cho một Thẻ lệnh gọi hàm, có một tham số loại template và một tham số loại map:

"parameter": [
  {
    "key": "functionName",
    "type": "template",
    "value": "fn"
  },
  {
    "key": "functionArgument",
    "map": [
      {
        "key": "argkey1",
        "type": "template",
        "value": "argval1"
      }
    ],
    "type": "map"
  }
]