Class Fields

Trường

Chứa một tập hợp các Field dành cho trình kết nối cộng đồng. Tập hợp các trường này xác định thứ nguyên và chỉ số có thể được sử dụng trong Data Studio.

var cc = DataStudioApp.createCommunityConnector();
var fields = cc.getFields();
var types = cc.FieldType;

var field1 = fields.newDimension()
  // Set other properties as needed.
  .setId('field1_id');

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
asArray()Field[]Trả về khung hiển thị của đối tượng này dưới dạng một mảng.
build()Object[]Xác thực và trả về đối tượng này ở định dạng mà Data Studio yêu cầu.
forIds(ids)FieldsTrả về một đối tượng Fields mới đã lọc cho các Field có mã nhận dạng trong ids.
getDefaultDimension()FieldTrả về phương diện mặc định được sử dụng cho tập hợp trường.
getDefaultMetric()FieldTrả về chỉ số mặc định được sử dụng cho tập hợp trường.
getFieldById(fieldId)FieldTrả về một trường có mã nhận dạng đã cho hoặc null nếu không có trường nào có mã đó nằm trong đối tượng Fields này.
newDimension()FieldTrả về một phương diện mới Field.
newMetric()FieldTrả về chỉ số mới Field.
setDefaultDimension(fieldId)voidĐặt phương diện mặc định được sử dụng cho tập hợp trường.
setDefaultMetric(fieldId)voidĐặt chỉ số mặc định được sử dụng cho tập hợp trường.

Tài liệu chi tiết

asArray()

Trả về khung hiển thị của đối tượng này dưới dạng một mảng.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// Logging the ID of each field:
fields
  .asArray()
  .map(function(field) {
     Logger.log(field.getId());
  });

Cầu thủ trả bóng

Field[] – Một mảng gồm các đối tượng Field.


build()

Xác thực và trả về đối tượng này ở định dạng mà Data Studio yêu cầu.

Cầu thủ trả bóng

Object[] – Dữ liệu trường đã xác thực, được trình bày dưới dạng danh sách các đối tượng.

Gửi

Error – nếu không thể tạo một đối tượng hợp lệ.


forIds(ids)

Trả về một đối tượng Fields mới đã lọc cho các Field có mã nhận dạng trong ids.

var fields = //reference to fields object.
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

// subsetFields is a Fields object that only contains field1 and field2.
var subsetFields = fields.forIds(['field1_id', 'field3_id']);

Tham số

TênLoạiMô tả
idsString[]Mã của các trường cần được giữ lại.

Cầu thủ trả bóng

Fields – Một đối tượng Fields mới.


getDefaultDimension()

Trả về phương diện mặc định được sử dụng cho tập hợp trường. Phương diện mặc định là được chọn tự động khi tạo một hình ảnh trực quan mới.

Cầu thủ trả bóng

Field – Phương diện được đặt làm phương diện mặc định hoặc null nếu không có phương diện mặc định thứ nguyên đã được đặt.


getDefaultMetric()

Trả về chỉ số mặc định được sử dụng cho tập hợp trường. Hệ thống đã chọn chỉ số mặc định tự động khi tạo hình ảnh trực quan mới.

Cầu thủ trả bóng

Field – Chỉ số được đặt làm chỉ số mặc định hoặc null nếu không có chỉ số mặc định nào là thiết lập.


getFieldById(fieldId)

Trả về một trường có mã nhận dạng đã cho hoặc null nếu không có trường nào có mã đó nằm trong đối tượng Fields này.

var fields = //reference to fields object.
var field1 = fields.newDimension().setId('field1_id');

// byId is the same as field1.
var byId = fields.getFieldById('field1_id');

// byId2 is null.
var byId2 = fields.getFieldById('not present id');

Tham số

TênLoạiMô tả
fieldIdStringMã của trường cần tải.

Cầu thủ trả bóng

FieldField với mã nhận dạng đã cho hoặc null nếu không có trường nào như vậy trong đối tượng Fields này.


newDimension()

Trả về một phương diện mới Field.

Cầu thủ trả bóng

Field — Một phương diện mới Field.


newMetric()

Trả về chỉ số mới Field.

Cầu thủ trả bóng

Field — Chỉ số mới Field.


setDefaultDimension(fieldId)

Đặt phương diện mặc định được sử dụng cho tập hợp trường. Phương diện mặc định được chọn tự động khi tạo hình ảnh trực quan mới.

Tham số

TênLoạiMô tả
fieldIdStringMã của trường để sử dụng làm phương diện mặc định. Mã này phải có trong tập hợp trường.

setDefaultMetric(fieldId)

Đặt chỉ số mặc định được sử dụng cho tập hợp trường. Hệ thống đã chọn chỉ số mặc định tự động khi tạo hình ảnh trực quan mới.

Tham số

TênLoạiMô tả
fieldIdStringMã của trường để sử dụng làm chỉ số mặc định. Mã nhận dạng này phải xuất hiện trong tập hợp trường.