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 のフィールドを返します。この Fields オブジェクトにその ID のフィールドがない場合、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 のフィールドを返します。この Fields オブジェクトにその ID のフィールドがない場合、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 は、フィールドのセットに存在する必要があります。