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

メソッド

メソッド戻り値の型概要
asArray()Field[]このオブジェクトのビューを配列として返します。
build()Object[]このオブジェクトを検証し、データポータルが必要とする形式で返します。
forIds(ids)Fieldsids の ID を持つ 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)

ids の ID を持つ 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。または、そのようなフィールドが含まれていない場合は null。 この Fields オブジェクト内に作成します。

newDimension()

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

戻る

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

newMetric()

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

戻る

Field - 新しい指標 Field。

setDefaultDimension(fieldId)

一連のフィールドに使用されるデフォルトのディメンションを設定します。デフォルトのディメンションが選択されている 新しい可視化が行われると自動的に適用されます。

パラメータ

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

setDefaultMetric(fieldId)

一連のフィールドに使用するデフォルトの指標を設定します。デフォルトの指標が選択されています 新しい可視化が行われると自動的に適用されます。

パラメータ

名前型説明
fieldIdStringデフォルトの指標として使用するフィールドの ID。この ID は 定義できます。