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

Class Field
コレクションでコンテンツを整理必要に応じて、コンテンツの保存と分類を行います。

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

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

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

メソッド

メソッド	戻り値の型	概要
`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 - このフィールドの aggregationType。

`getDescription()`

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

戻る

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

`getFormula()`

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

戻る

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

`getGroup()`

この Field のグループを返します。グループに収集されたフィールドは、データポータルの 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 のグループを設定します。グループに収集されたフィールドは、データポータルの 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 - チェーン用のこのビルダー。

Class Field コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

詳細なドキュメント

getAggregation()

戻る

getDescription()

戻る

getFormula()

戻る

getGroup()

戻る

getId()

戻る

getIsReaggregatable()

戻る

getName()

戻る

getType()

戻る

isDefault()

戻る

isDimension()

戻る

isHidden()

戻る

isMetric()

戻る

setAggregation(aggregation)

パラメータ

戻る

setDescription(description)

パラメータ

戻る

setFormula(formula)

パラメータ

戻る

setGroup(group)

パラメータ

戻る

setId(id)

パラメータ

戻る

setIsHidden(isHidden)

パラメータ

戻る

setIsReaggregatable(isReaggregatable)

パラメータ

戻る

setName(name)

パラメータ

戻る

setType(type)

パラメータ

戻る

Class Field
コレクションでコンテンツを整理必要に応じて、コンテンツの保存と分類を行います。

`getAggregation()`

`getDescription()`

`getFormula()`

`getGroup()`

`getId()`

`getIsReaggregatable()`

`getName()`

`getType()`

`isDefault()`

`isDimension()`

`isHidden()`

`isMetric()`

`setAggregation(aggregation)`

`setDescription(description)`

`setFormula(formula)`

`setGroup(group)`

`setId(id)`

`setIsHidden(isHidden)`

`setIsReaggregatable(isReaggregatable)`

`setName(name)`

`setType(type)`