Class Fields

フィールド

コミュニティ コネクタの Field のセットが含まれます。このフィールドのセットでは、データポータルで使用できる ディメンションと指標を定義します。 

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

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

Methods

メソッド戻り値の型概要
asArray()Field[]このオブジェクトのビューを配列として返します。
build()Object[]このオブジェクトを検証し、データポータルに必要な形式で返します。
forIds(ids)Fieldsフィルタされ、ID が ids の Field に新しい Fields オブジェクトを返します。
getDefaultDimension()Field一連のフィールドに使用されるデフォルトのディメンションを返します。
getDefaultMetric()Field一連のフィールドに使用されるデフォルトの指標を返します。
getFieldById(fieldId)Field指定された ID のフィールドを返します。この Fields オブジェクトにその ID のフィールドがない場合は null を返します。
newDimension()Field新しいディメンション Field を返します。
newMetric()Field新しい指標 Field を返します。
setDefaultDimension(fieldId)void一連のフィールドに使用されるデフォルトのディメンションを設定します。
setDefaultMetric(fieldId)void一連のフィールドに使用されるデフォルトの指標を設定します。

詳細なドキュメント

asArray()

このオブジェクトのビューを配列として返します。 

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());
  });

リターン

Field[] - Field オブジェクトの配列。

build()

このオブジェクトを検証し、データポータルに必要な形式で返します。

リターン

Object[] - オブジェクトのリストとして表される、検証済みのフィールド データ。

例外

Error - 有効なオブジェクトを構築できない場合

forIds(ids)

フィルタされ、ID が ids の Field に新しい Fields オブジェクトを返します。 

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']);

パラメータ

名前型説明
idsString[]保持する必要があるフィールドの ID。

リターン

Fields - 新しい Fields オブジェクト。

getDefaultDimension()

一連のフィールドに使用されるデフォルトのディメンションを返します。デフォルトのディメンションは、新しいビジュアリゼーションが作成されると自動的に選択されます。

リターン

Field - デフォルトのディメンションとして設定されているディメンション。デフォルトのディメンションが設定されていない場合は null。

getDefaultMetric()

一連のフィールドに使用されるデフォルトの指標を返します。新しいビジュアリゼーションが作成されると、デフォルトの指標が自動的に選択されます。

リターン

Field - デフォルトの指標として設定されている指標。デフォルトの指標が設定されていない場合は null。

getFieldById(fieldId)

指定された ID を持つフィールドを返します。この Fields オブジェクトにその ID を持つフィールドがない場合は null を返します。 

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');

パラメータ

名前型説明
fieldIdString取得するフィールドの ID。

リターン

Field - 指定された ID を持つ Field。または、対象のフィールドがこの Fields オブジェクトに含まれていない場合は null。

newDimension()

新しいディメンション Field を返します。

リターン

Field - 新しいディメンション Field。

newMetric()

新しい指標 Field を返します。

リターン

Field - 新しい指標 Field。

setDefaultDimension(fieldId)

一連のフィールドに使用されるデフォルトのディメンションを設定します。新しいビジュアリゼーションが作成されると、デフォルトのディメンションが自動的に選択されます。

パラメータ

名前型説明
fieldIdStringデフォルトのディメンションとして使用するフィールドの ID。この ID は一連のフィールドに存在する必要があります。

setDefaultMetric(fieldId)

一連のフィールドに使用されるデフォルトの指標を設定します。新しいビジュアリゼーションが作成されると、デフォルトの指標が自動的に選択されます。

パラメータ

名前型説明
fieldIdStringデフォルトの指標として使用するフィールドの ID。この ID は一連のフィールドに存在する必要があります。