Class Fields

フィールド

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

const cc = DataStudioApp.createCommunityConnector();
const fields = cc.getFields();

const 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 のフィールドを返します。その ID のフィールドがこの Fields オブジェクトにない場合は null を返します。
newDimension()Field新しいディメンション Field を返します。
newMetric()Field新しい指標 Field を返します。
setDefaultDimension(fieldId)voidフィールドのセットに使用するデフォルトのディメンションを設定します。
setDefaultMetric(fieldId)voidフィールドのセットに使用するデフォルトの指標を設定します。

詳細なドキュメント

asArray()

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

const fields = DataStudioApp.createCommunityConnector().getFields();
fields.newDimension().setId('field1_id');
fields.newDimension().setId('field2_id');
fields.newDimension().setId('field3_id');

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

戻る

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

build()

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

戻る

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

例外

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

forIds(ids)

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

const fields = DataStudioApp.createCommunityConnector().getFields();
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.
const subsetFields = fields.forIds(['field1_id', 'field3_id']);

パラメータ

名前タイプ説明
idsString[]保持するフィールドの ID。

戻る

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

getDefaultDimension()

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

戻る

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

getDefaultMetric()

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

戻る

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

getFieldById(fieldId)

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

const fields = DataStudioApp.createCommunityConnector().getFields();
const field1 = fields.newDimension().setId('field1_id');

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

// byId2 is null.
const 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 は フィールドのセットに存在する必要があります。