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

Data Studio Service

このサービスを使用すると、スクリプトからデータポータルのコミュニティコネクタにアクセスして変更できます。

クラス

名前	概要
`AggregationType`	`Field` に設定できる集計タイプを定義する列挙型。
`AuthType`	コネクタに設定できる認証タイプを定義する列挙型。
`BigQueryConfig`	ネイティブ BigQuery コネクタの構成オブジェクト。
`BigQueryParameterType`	設定可能な BigQuery パラメータのタイプを定義する列挙型。
`Checkbox`	構成のチェックボックス情報。
`CommunityConnector`	コミュニティコネクタを使用すると、スクリプトでビルダーとユーティリティにアクセスして、データポータル向けのコミュニティコネクタの開発を支援できます。
`Config`	コネクタの構成エントリが含まれます。
`DataStudioApp`	DataStudio App を使用すると、スクリプトでデータポータルのデベロッパー向け機能を操作できます。
`DebugError`	コネクタの管理者にのみ表示されるエラー。
`Field`	フィールドに関連するデータが含まれています。
`FieldType`	`Field` に設定できるタイプを定義する列挙型。
`Fields`	コミュニティコネクタの `Field` のセットを含む。
`GetAuthTypeResponse`	スクリプトプロジェクトの `getAuthType()` レスポンスを作成するためのビルダー。
`GetDataResponse`	スクリプトプロジェクトの `getData()` レスポンスを作成するためのビルダー。
`GetSchemaResponse`	スクリプトプロジェクトの `getSchema()` レスポンスを作成するためのビルダー。
`Info`	構成に関する情報データが含まれています。
`OptionBuilder`	`SelectSingle` と `SelectMultiple` のオプションを作成するビルダー。
`SelectMultiple`	構成の複数の情報を指定します。
`SelectSingle`	構成の単一の選択情報を含みます。
`SetCredentialsResponse`	スクリプトプロジェクトの `setCredentials()` レスポンスを作成するためのビルダー。
`TextArea`	構成のテキスト領域の情報が含まれます。
`TextInput`	構成のテキスト入力情報が含まれます。
`UserError`	コネクタのユーザーに表示されるエラー。

`AggregationType`

プロパティ

プロパティ	タイプ	説明
`AVG`	`Enum`	平均的。
`COUNT`	`Enum`	カウント。
`COUNT_DISTINCT`	`Enum`	Count Distinct。
`MAX`	`Enum`	最大期間
`MIN`	`Enum`	最小
`SUM`	`Enum`	合計。
`AUTO`	`Enum`	Auto、

`AuthType`

プロパティ

プロパティ	タイプ	説明
`NONE`	`Enum`	認可は必要ありません。
`OAUTH2`	`Enum`	OAuth2 認証が必要。
`USER_PASS`	`Enum`	ユーザー名とパスワードの認証情報が必要です。
`PATH_USER_PASS`	`Enum`	ユーザー名、パス、パスワードが必要です。
`PATH_KEY`	`Enum`	パスとキーが必要です。
`KEY`	`Enum`	API キーまたはトークンが必要です。
`USER_TOKEN`	`Enum`	ユーザー名とトークンが必要です。

`BigQueryConfig`

メソッド

メソッド	戻り値の型	概要
`addQueryParameter(name, type, value)`	`BigQueryConfig`	この `BigQueryConfig` にクエリパラメータを追加します。
`build()`	`Object`	このオブジェクトを検証し、データポータルで必要な形式で返します。
`printJson()`	`String`	このオブジェクトの JSON 表現を出力します。
`setAccessToken(accessToken)`	`BigQueryConfig`	この `BigQueryConfig` のアクセストークンを設定します。
`setBillingProjectId(billingProjectId)`	`BigQueryConfig`	この `BigQueryConfig` の課金プロジェクト ID を設定します。
`setQuery(query)`	`BigQueryConfig`	この `BigQueryConfig` の SQL クエリを設定します。
`setUseStandardSql(useStandardSql)`	`BigQueryConfig`	クエリが標準 SQL またはレガシー SQL として解釈されるかどうかを決定します。

`BigQueryParameterType`

プロパティ

プロパティ	タイプ	説明
`STRING`	`Enum`	文字列。
`INT64`	`Enum`	64 ビットの整数。
`BOOL`	`Enum`	Boolean 型。
`FLOAT64`	`Enum`	64 ビット浮動小数点数。

`Checkbox`

メソッド

メソッド	戻り値の型	概要
`setAllowOverride(allowOverride)`	`Checkbox`	この構成エントリのオーバーライドを有効にします。
`setHelpText(helpText)`	`Checkbox`	この構成エントリのヘルプテキストを設定します。
`setId(id)`	`Checkbox`	この構成エントリの一意の ID を設定します。
`setIsDynamic(isDynamic)`	`Checkbox`	この構成エントリの動的ステータスを設定します。
`setName(name)`	`Checkbox`	この構成エントリの表示名を設定します。

`CommunityConnector`

プロパティ

プロパティ	タイプ	説明
`AggregationType`	`AggregationType`	`AggregationType` 列挙型。
`AuthType`	`AuthType`	`AuthType` 列挙型。
`BigQueryParameterType`	`BigQueryParameterType`	`BigQueryParameterType` 列挙型。
`FieldType`	`FieldType`	`FieldType` 列挙型。

メソッド

メソッド	戻り値の型	概要
`getConfig()`	`Config`	`Config` オブジェクトを返します。
`getFields()`	`Fields`	`Fields` オブジェクトを返します。
`newAuthTypeResponse()`	`GetAuthTypeResponse`	新しい `GetAuthTypeResponse` オブジェクトを返します。
`newBigQueryConfig()`	`BigQueryConfig`	新しい `BigQueryConfig` オブジェクトを返します。
`newDebugError()`	`DebugError`	新しい `DebugError` オブジェクトを返します。
`newGetDataResponse()`	`GetDataResponse`	新しい `GetDataResponse` オブジェクトを返します。
`newGetSchemaResponse()`	`GetSchemaResponse`	新しい `GetSchemaResponse` オブジェクトを返します。
`newSetCredentialsResponse()`	`SetCredentialsResponse`	新しい `SetCredentialsResponse` オブジェクトを返します。
`newUserError()`	`UserError`	新しい `UserError` オブジェクトを返します。

`Config`

メソッド

メソッド	戻り値の型	概要
`build()`	`Object`	このオブジェクトを検証し、データポータルで必要な形式で返します。
`newCheckbox()`	`Checkbox`	新しいチェックボックスの設定エントリを返します。
`newInfo()`	`Info`	新しい情報構成エントリを返します。
`newOptionBuilder()`	`OptionBuilder`	新しいオプションビルダーを返します。
`newSelectMultiple()`	`SelectMultiple`	新しい複数選択の構成エントリを返します。
`newSelectSingle()`	`SelectSingle`	新しい選択した単一の構成エントリを返します。
`newTextArea()`	`TextArea`	新しいテキスト領域の構成エントリを返します。
`newTextInput()`	`TextInput`	新しいテキスト入力構成エントリを返します。
`printJson()`	`String`	このオブジェクトの JSON 表現を出力します。
`setDateRangeRequired(dateRangeRequired)`	`Config`	`true` の場合、getData() リクエストの期間が指定されます。
`setIsSteppedConfig(isSteppedConfig)`	`Config`	`true` の場合、現在のユーザー構成で `getConfig()` が再度呼び出されます。

`DataStudioApp`

メソッド

メソッド	戻り値の型	概要
`createCommunityConnector()`	`CommunityConnector`	新しいコミュニティコネクタを作成します。

`DebugError`

メソッド

メソッド	戻り値の型	概要
`printJson()`	`String`	このオブジェクトの JSON 表現を出力します。
`setText(text)`	`DebugError`	デバッグエラーのテキストを設定します。このテキストは管理者にのみ表示されます。
`throwException()`	`void`	この例外がスローされるようにトリガーします。

`Field`

メソッド

メソッド	戻り値の型	概要
`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` を設定します。

`FieldType`

プロパティ

プロパティ	タイプ	説明
`YEAR`	`Enum`	年（YYYY 形式）。例: 2017
`YEAR_QUARTER`	`Enum`	年と四半期（YYYYQ 形式、例: 20171）。
`YEAR_MONTH`	`Enum`	年と月を YYYYMM の形式で指定します（例: 201703）。
`YEAR_WEEK`	`Enum`	年と週を YYYYww の形式で指定します（例: 201707）。
`YEAR_MONTH_DAY`	`Enum`	年、月、日を YYYYMMDD 形式で指定します（例: 20170317）。
`YEAR_MONTH_DAY_HOUR`	`Enum`	年、月、日、時刻（YYYYMMDDHH 形式）。例: 2017031703
`YEAR_MONTH_DAY_MINUTE`	`Enum`	年、月、日、時、分（YYYYMMDDHHmm 形式）（例: 201703170230）。
`YEAR_MONTH_DAY_SECOND`	`Enum`	年、月、日、時、分、秒（YYYYMMDDHHmmss 形式）。例: 20170317023017。
`QUARTER`	`Enum`	四半期（1、2、3、4 の形式）。
`MONTH`	`Enum`	月（MM 形式）。03 など。
`WEEK`	`Enum`	週（ww 形式、例: 07）。
`MONTH_DAY`	`Enum`	月と日（MMDD 形式）。例: 0317。
`DAY_OF_WEEK`	`Enum`	[0,6] の範囲の数値。0 は日曜日を表します。
`DAY`	`Enum`	日付（DD 形式、例: 17）。
`HOUR`	`Enum`	HH 形式の時刻（13 など）。
`MINUTE`	`Enum`	分（mm の形式、12 など）。
`DURATION`	`Enum`	経過時間（秒単位）。
`COUNTRY`	`Enum`	国（米国など）。
`COUNTRY_CODE`	`Enum`	国コード（US など）。
`CONTINENT`	`Enum`	南北アメリカなどの大陸。
`CONTINENT_CODE`	`Enum`	大陸コード（019 など）。
`SUB_CONTINENT`	`Enum`	北米などのサブコンチネント。
`SUB_CONTINENT_CODE`	`Enum`	亜大陸コード（003 など）。
`REGION`	`Enum`	カリフォルニア州などのリージョン。
`REGION_CODE`	`Enum`	地域コード（CA など）。
`CITY`	`Enum`	マウンテンビューなどの都市。
`CITY_CODE`	`Enum`	市外局番（1014044 など）。
`METRO`	`Enum`	サンフランシスコ - オークランド - サンノゼ（カリフォルニア州）などのメトロ。
`METRO_CODE`	`Enum`	大都市圏コード（200807 など）。
`LATITUDE_LONGITUDE`	`Enum`	緯度と経度のペア（例: 51.5074, -0.1278）。
`NUMBER`	`Enum`	小数数値。
`PERCENT`	`Enum`	小数表記での割合（1.0 を超えてもよい）。
`TEXT`	`Enum`	自由形式のテキスト。
`BOOLEAN`	`Enum`	`true` または `false` のブール値。
`URL`	`Enum`	テキスト形式の URL（https://google.com など）。
`HYPERLINK`	`Enum`	ハイパーリンク。
`IMAGE`	`Enum`	画像。
`IMAGE_LINK`	`Enum`	画像リンク。
`CURRENCY_AED`	`Enum`	通貨は AED です。
`CURRENCY_ALL`	`Enum`	通貨は ALL です。
`CURRENCY_ARS`	`Enum`	通貨が ARS から変更されます。
`CURRENCY_AUD`	`Enum`	通貨はオーストラリアドルです。
`CURRENCY_BDT`	`Enum`	通貨は BDT です。
`CURRENCY_BGN`	`Enum`	通貨は BGN です。
`CURRENCY_BOB`	`Enum`	BOB の通貨。
`CURRENCY_BRL`	`Enum`	通貨が BRL である。
`CURRENCY_CAD`	`Enum`	CAD の通貨。
`CURRENCY_CDF`	`Enum`	CDF の通貨。
`CURRENCY_CHF`	`Enum`	通貨が CHF から変更されます。
`CURRENCY_CLP`	`Enum`	通貨が CLP から変更されました。
`CURRENCY_CNY`	`Enum`	通貨が CNY から変更されました。
`CURRENCY_COP`	`Enum`	通貨は COP です。
`CURRENCY_CRC`	`Enum`	CRC の通貨。
`CURRENCY_CZK`	`Enum`	通貨は CZK です。
`CURRENCY_DKK`	`Enum`	通貨は DKK です。
`CURRENCY_DOP`	`Enum`	DOP の通貨。
`CURRENCY_EGP`	`Enum`	通貨は EGP です。
`CURRENCY_ETB`	`Enum`	通貨は ETB です。
`CURRENCY_EUR`	`Enum`	通貨はユーロです。
`CURRENCY_GBP`	`Enum`	通貨は GBP です。
`CURRENCY_HKD`	`Enum`	通貨は HKD です。
`CURRENCY_HRK`	`Enum`	通貨は HRK です。
`CURRENCY_HUF`	`Enum`	通貨は HUF です。
`CURRENCY_IDR`	`Enum`	インドネシアルピア。
`CURRENCY_ILS`	`Enum`	ILS の通貨。
`CURRENCY_INR`	`Enum`	通貨は INR です。
`CURRENCY_IRR`	`Enum`	IRR の通貨。
`CURRENCY_ISK`	`Enum`	通貨は ISK です。
`CURRENCY_JMD`	`Enum`	通貨は JMD です。
`CURRENCY_JPY`	`Enum`	通貨は JPY です。
`CURRENCY_KRW`	`Enum`	通貨が KRW から変更されました。
`CURRENCY_LKR`	`Enum`	通貨は LKR です。
`CURRENCY_LTL`	`Enum`	通貨は LTL です。
`CURRENCY_MNT`	`Enum`	MNT の通貨。
`CURRENCY_MVR`	`Enum`	MVR の通貨。
`CURRENCY_MXN`	`Enum`	通貨は MXN です。
`CURRENCY_MYR`	`Enum`	通貨は MYR です。
`CURRENCY_NGN`	`Enum`	通貨は NGN です。
`CURRENCY_NOK`	`Enum`	通貨は NOK です。
`CURRENCY_NZD`	`Enum`	通貨は NZD です。
`CURRENCY_PAB`	`Enum`	PAB の通貨。
`CURRENCY_PEN`	`Enum`	通貨はペソです。
`CURRENCY_PHP`	`Enum`	通貨は PHP です。
`CURRENCY_PKR`	`Enum`	通貨は PKR です。
`CURRENCY_PLN`	`Enum`	通貨は PLN です。
`CURRENCY_RON`	`Enum`	通貨は RON です。
`CURRENCY_RSD`	`Enum`	通貨は RSD です。
`CURRENCY_RUB`	`Enum`	通貨は RUB です。
`CURRENCY_SAR`	`Enum`	通貨が SAR から変更されました。
`CURRENCY_SEK`	`Enum`	通貨は SEK です。
`CURRENCY_SGD`	`Enum`	通貨は SGD。
`CURRENCY_THB`	`Enum`	通貨は THB です。
`CURRENCY_TRY`	`Enum`	TRY の通貨。
`CURRENCY_TWD`	`Enum`	通貨は TWD です。
`CURRENCY_TZS`	`Enum`	通貨は TZS です。
`CURRENCY_UAH`	`Enum`	通貨は UAH です。
`CURRENCY_USD`	`Enum`	米ドルの通貨。
`CURRENCY_UYU`	`Enum`	UYU の通貨。
`CURRENCY_VEF`	`Enum`	通貨は VEF です。
`CURRENCY_VND`	`Enum`	通貨は VND です。
`CURRENCY_YER`	`Enum`	通貨が YER の場合。
`CURRENCY_ZAR`	`Enum`	通貨が ZAR から変更されました。

`Fields`

メソッド

メソッド	戻り値の型	概要
`asArray()`	`Field[]`	このオブジェクトのビューを配列として返します。
`build()`	`Object[]`	このオブジェクトを検証し、データポータルで必要な形式で返します。
`forIds(ids)`	`Fields`	`ids` の 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`	フィールドセットに使用するデフォルトの指標を設定します。

`GetAuthTypeResponse`

メソッド

メソッド	戻り値の型	概要
`build()`	`Object`	このオブジェクトを検証し、データポータルで必要な形式で返します。
`printJson()`	`String`	このオブジェクトの JSON 表現を出力します。
`setAuthType(authType)`	`GetAuthTypeResponse`	ビルダーの `AuthType` を設定します。
`setHelpUrl(helpUrl)`	`GetAuthTypeResponse`	ビルダーのヘルプ URL を設定します。

`GetDataResponse`

メソッド

メソッド	戻り値の型	概要
`addAllRows(rows)`	`GetDataResponse`	この `GetDataResponse` に複数のデータ行を追加します。
`addRow(row)`	`GetDataResponse`	この `GetDataResponse` にデータ行を追加します。
`build()`	`Object`	このオブジェクトを検証し、データポータルで必要な形式で返します。
`setFields(fields)`	`GetDataResponse`	ビルダーの `Fields` を設定します。
`setFiltersApplied(filtersApplied)`	`GetDataResponse`	このビルダーに適用されているフィルタのステータスを設定します。

`GetSchemaResponse`

メソッド

メソッド	戻り値の型	概要
`build()`	`Object`	このオブジェクトを検証し、データポータルで必要な形式で返します。
`printJson()`	`String`	このオブジェクトの JSON 表現を出力します。
`setFields(fields)`	`GetSchemaResponse`	ビルダーの `Fields` を設定します。

`Info`

メソッド

メソッド	戻り値の型	概要
`setId(id)`	`Info`	この構成エントリの一意の ID を設定します。
`setText(text)`	`Info`	この構成エントリのテキストを設定します。

`OptionBuilder`

メソッド

メソッド	戻り値の型	概要
`setLabel(label)`	`OptionBuilder`	このオプションビルダーのラベルを設定します。
`setValue(value)`	`OptionBuilder`	このオプションビルダーの値を設定します。

`SelectMultiple`

メソッド

メソッド	戻り値の型	概要
`addOption(optionBuilder)`	`SelectMultiple`	新しい選択オプションを追加しました。
`setAllowOverride(allowOverride)`	`SelectMultiple`	この構成エントリのオーバーライドを有効にします。
`setHelpText(helpText)`	`SelectMultiple`	この構成エントリのヘルプテキストを設定します。
`setId(id)`	`SelectMultiple`	この構成エントリの一意の ID を設定します。
`setIsDynamic(isDynamic)`	`SelectMultiple`	この構成エントリの動的ステータスを設定します。
`setName(name)`	`SelectMultiple`	この構成エントリの表示名を設定します。

`SelectSingle`

メソッド

メソッド	戻り値の型	概要
`addOption(optionBuilder)`	`SelectSingle`	新しい選択オプションを追加しました。
`setAllowOverride(allowOverride)`	`SelectSingle`	この構成エントリのオーバーライドを有効にします。
`setHelpText(helpText)`	`SelectSingle`	この構成エントリのヘルプテキストを設定します。
`setId(id)`	`SelectSingle`	この構成エントリの一意の ID を設定します。
`setIsDynamic(isDynamic)`	`SelectSingle`	この構成エントリの動的ステータスを設定します。
`setName(name)`	`SelectSingle`	この構成エントリの表示名を設定します。

`SetCredentialsResponse`

メソッド

メソッド	戻り値の型	概要
`build()`	`Object`	このオブジェクトを検証し、データポータルで必要な形式で返します。
`printJson()`	`String`	このオブジェクトの JSON 表現を出力します。
`setIsValid(isValid)`	`SetCredentialsResponse`	この `SetCredentialsResponse` の有効なステータスを設定します。

`TextArea`

メソッド

メソッド	戻り値の型	概要
`setAllowOverride(allowOverride)`	`TextArea`	この構成エントリのオーバーライドを有効にします。
`setHelpText(helpText)`	`TextArea`	この構成エントリのヘルプテキストを設定します。
`setId(id)`	`TextArea`	この構成エントリの一意の ID を設定します。
`setIsDynamic(isDynamic)`	`TextArea`	この構成エントリの動的ステータスを設定します。
`setName(name)`	`TextArea`	この構成エントリの表示名を設定します。
`setPlaceholder(placeholder)`	`TextArea`	この構成エントリのプレースホルダテキストを設定します。

`TextInput`

メソッド

メソッド	戻り値の型	概要
`setAllowOverride(allowOverride)`	`TextInput`	この構成エントリのオーバーライドを有効にします。
`setHelpText(helpText)`	`TextInput`	この構成エントリのヘルプテキストを設定します。
`setId(id)`	`TextInput`	この構成エントリの一意の ID を設定します。
`setIsDynamic(isDynamic)`	`TextInput`	この構成エントリの動的ステータスを設定します。
`setName(name)`	`TextInput`	この構成エントリの表示名を設定します。
`setPlaceholder(placeholder)`	`TextInput`	この構成エントリのプレースホルダテキストを設定します。

`UserError`

メソッド

メソッド	戻り値の型	概要
`printJson()`	`String`	このオブジェクトの JSON 表現を出力します。
`setDebugText(text)`	`UserError`	デバッグエラーのテキストを設定します。このテキストは管理者にのみ表示されます。
`setText(text)`	`UserError`	ユーザーエラーのテキストを設定します。
`throwException()`	`void`	この例外がスローされるようにトリガーします。

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

クラス

プロパティ

プロパティ

メソッド

プロパティ

メソッド

プロパティ

メソッド

メソッド

メソッド

メソッド

メソッド

プロパティ

メソッド

メソッド

メソッド

メソッド

メソッド

メソッド

メソッド

メソッド

メソッド

メソッド

メソッド

メソッド

Data Studio Service