このページは Cloud Translation API によって翻訳されました。

Class Field

フィールド関連のデータが含まれます。このプロパティによって、データポータルでフィールドがどのように使用されるかが決まります。

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

var field1 = fields.newDimension()
  .setId('field1_id')
  .setName('Field 1 ID')
  .setDescription('The first field.')
  .setType(types.YEAR_MONTH)
  .setGroup('DATETIME');

Methods

メソッド	戻り値の型	概要
`getAggregation()`	`AggregationType`	この `Field` の `AggregationType` を返します。
`getDescription()`	`String`	この `Field` の説明を返します。
`getFormula()`	`String`	この `Field` の式を返します。
`getGroup()`	`String`	この `Field` のグループを返します。
`getId()`	`String`	この `Field` の ID を返します。
`getIsReaggregatable()`	`Boolean`	このフィールドを再集計できる場合は `true` を返し、それ以外の場合は `false` を返します。
`getName()`	`String`	この `Field` の名前を返します。
`getType()`	`FieldType`	この `Field` の `FieldType` を返します。
`isDefault()`	`Boolean`	この `Field` がデフォルトの指標またはディメンションである場合、`true` を返します。
`isDimension()`	`Boolean`	このフィールドがディメンションの場合、`true` を返します。
`isHidden()`	`Boolean`	この `Field` が非表示の場合は、`true` を返します。
`isMetric()`	`Boolean`	このフィールドが指標の場合、`true` を返します。
`setAggregation(aggregation)`	`Field`	この `Field` の集約型を設定します。
`setDescription(description)`	`Field`	この `Field` の説明を設定します。
`setFormula(formula)`	`Field`	この `Field` の式を設定します。
`setGroup(group)`	`Field`	この `Field` のグループを設定します。
`setId(id)`	`Field`	この `Field` の ID を設定します。
`setIsHidden(isHidden)`	`Field`	この `Field` の非表示ステータスを設定します。
`setIsReaggregatable(isReaggregatable)`	`Field`	`Field` の再集計の許可ステータスを設定します。
`setName(name)`	`Field`	この `Field` の名前を設定します。
`setType(type)`	`Field`	この `Field` の `FieldType` を設定します。

詳細なドキュメント

`getAggregation()`

この Field の AggregationType を返します。AggregationType は、データポータルで類似のデータをディメンションにまとめる方法を決定します。

リターン

AggregationType - このフィールドの AggregateType。

`getDescription()`

この Field の説明を返します。説明は、フィールドの目的についての簡単な説明です。

リターン

String - このフィールドの説明。

`getFormula()`

この Field の式を返します。数式は、データポータルがクエリ時に実行されるデータ変換を定義します。

リターン

String - このフィールドの数式。

`getGroup()`

この Field のグループを返します。1 つのグループに収集されたフィールドは、データポータルの UI にまとめて表示されます。

リターン

String - このフィールドのグループ。

`getId()`

この Field の ID を返します。ID はフィールドのセットごとに一意であり、フィールドを参照するための式で使用されます。

リターン

String - このフィールドの ID。

`getIsReaggregatable()`

このフィールドを再集計できる場合は true を返し、それ以外の場合は false を返します。

リターン

Boolean - このフィールドを再集計できる場合は true、それ以外の場合は false。

`getName()`

この Field の名前を返します。フィールドを区別するために、名前が表示されます。

リターン

String - このフィールドの名前。

`getType()`

この Field の FieldType を返します。

リターン

FieldType - このフィールドの型。

`isDefault()`

この Field がデフォルトの指標またはディメンションである場合、true を返します。

リターン

Boolean - この Field がデフォルトの指標またはディメンションである場合は true、それ以外の場合は false。

`isDimension()`

このフィールドがディメンションの場合、true を返します。

リターン

Boolean - このフィールドがディメンションの場合は true、それ以外の場合は false を返します。

`isHidden()`

この Field が非表示の場合は、true を返します。非表示のフィールドは数式で使用できますが、グラフでは使用できません。数式を含むフィールドを非表示にすることはできません。

リターン

Boolean - この Field が非表示の場合は true、それ以外の場合は false。

`isMetric()`

このフィールドが指標の場合、true を返します。

リターン

Boolean - このフィールドが指標の場合は true、それ以外の場合は false を返します。

`setAggregation(aggregation)`

この Field の集約型を設定します。AggregationType は、類似データをディメンションにまとめる方法を決定します。指標に対して呼び出されるとエラーがスローされます。

パラメータ

名前	型	説明
`aggregation`	`AggregationType`	設定する集計方法を指定します。

リターン

Field - チェーン用のこのビルダー。

`setDescription(description)`

この Field の説明を設定します。説明は、フィールドの目的についての簡単な説明です。

パラメータ

名前	型	説明
`description`	`String`	設定する説明。

リターン

Field - チェーン用のこのビルダー。

`setFormula(formula)`

この Field の式を設定します。数式は、データポータルがクエリ時に実行するデータ変換を定義します。

パラメータ

名前	型	説明
`formula`	`String`	設定する数式です。

リターン

Field - チェーン用のこのビルダー。

`setGroup(group)`

この Field のグループを設定します。1 つのグループに収集されたフィールドは、データポータルの UI に一緒に表示されます。

パラメータ

名前	型	説明
`group`	`String`	設定するグループ。

リターン

Field - チェーン用のこのビルダー。

`setId(id)`

この Field の ID を設定します。ID はフィールドのセットごとに一意で、フィールドを参照する式で使用されます。

パラメータ

名前	型	説明
`id`	`String`	設定する ID。

リターン

Field - チェーン用のこのビルダー。

`setIsHidden(isHidden)`

この Field の非表示ステータスを設定します。非表示のフィールドは数式で使用できますが、グラフでは使用できません。数式を含むフィールドを非表示にすることはできません。

パラメータ

名前	型	説明
`isHidden`	`Boolean`	設定する非表示のステータス。

リターン

Field - チェーン用のこのビルダー。

`setIsReaggregatable(isReaggregatable)`

Field の再集計の許可ステータスを設定します。再集計できないフィールドに集計タイプを設定しようとすると、エラーになります。

パラメータ

名前	型	説明
`isReaggregatable`	`Boolean`	設定する再集計の許可ステータス。

リターン

Field - チェーン用のこのビルダー。

`setName(name)`

この Field の名前を設定します。フィールドを区別するために、名前が表示されます。

パラメータ

名前	型	説明
`name`	`String`	設定する名前。

リターン

Field - チェーン用のこのビルダー。

`setType(type)`

この Field の FieldType を設定します。

パラメータ

名前	型	説明
`type`	`FieldType`	設定するタイプ。

リターン

Field - チェーン用のこのビルダー。