REST Resource: spreadsheets

リソース: スプレッドシート

スプレッドシートを表すリソース。

JSON 表現 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
フィールド
spreadsheetId

string

スプレッドシートの ID。このフィールドは読み取り専用です。
properties

object (SpreadsheetProperties)

スプレッドシートの全体的なプロパティ。
sheets[]

object (Sheet)

スプレッドシートに含まれるシート。
namedRanges[]

object (NamedRange)

スプレッドシートで定義されている名前付き範囲。
spreadsheetUrl

string

スプレッドシートの URL。このフィールドは読み取り専用です。
developerMetadata[]

object (DeveloperMetadata)

スプレッドシートに関連付けられているデベロッパー メタデータ。
dataSources[]

object (DataSource)

スプレッドシートに接続されている外部データソースのリスト。
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

出力のみ。データソースの更新スケジュールのリスト。

スプレッドシートのプロパティ

スプレッドシートのプロパティ。

JSON 表現 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  }
}
フィールド
title

string

スプレッドシートのタイトル。
locale

string

スプレッドシートのロケール。次のいずれかの形式です。

  • ISO 639-1 言語コード（例: en）

  • ISO 639-2 言語コード（fil など）、639-1 コードが存在しない場合

  • ISO 言語コードと国コードの組み合わせ（例: en_US）

注: このフィールドを更新する際、一部の言語/地域のみがサポートされるわけではありません。
autoRecalc

enum (RecalculationInterval)

揮発性関数が再計算されるまでの待機時間。
timeZone

string

スプレッドシートのタイムゾーン（CLDR 形式、America/New_York など）。タイムゾーンが認識されない場合、GMT-07:00 などのカスタム タイムゾーンである可能性があります。
defaultFormat

object (CellFormat)

スプレッドシートのすべてのセルのデフォルトの形式。CellData.effectiveFormat は、セルの形式がこのデフォルトの形式と同じである場合に設定されません。このフィールドは読み取り専用です。
iterativeCalculationSettings

object (IterativeCalculationSettings)

循環参照を反復計算で解決するかどうか、またどのように解決するかを決定します。このフィールドが存在しない場合、循環参照によって計算エラーが発生します。
spreadsheetTheme

object (SpreadsheetTheme)

スプレッドシートにテーマを適用しました。

再計算の間隔

可能な再計算の間隔オプションの列挙。

列挙型
RECALCULATION_INTERVAL_UNSPECIFIED デフォルト値。この値は使用しないでください。
ON_CHANGE 揮発性関数は変更が発生するたびに更新されます。
MINUTE 揮発性関数は毎分、毎分更新されます。
HOUR 揮発性関数は変更のたびに更新され、1 時間ごとに更新されます。

IterativeCalculationSettings

反復計算で循環依存関係を解決する方法を管理する設定。

JSON 表現 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
フィールド
maxIterations

integer

反復計算が有効になっている場合、実行する計算の最大回数。
convergenceThreshold

number

反復計算が有効で、テスト結果の差がこのしきい値を下回ると、計算は丸められます。

スプレッドシートのテーマ

スプレッドシートのテーマを表す

JSON 表現 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
フィールド
primaryFontFamily

string

メインのフォント ファミリーの名前。
themeColors[]

object (ThemeColorPair)

スプレッドシートのテーマの色のペア。更新するには、すべてのテーマカラーのペアを指定する必要があります。

テーマカラーペア

スプレッドシートのテーマの色タイプを、その色を表す具体的な色にマッピングするペア。

JSON 表現 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
フィールド
colorType

enum (ThemeColorType)

スプレッドシートのテーマの色の種類。
color

object (ColorStyle)

テーマの色タイプに対応するコンクリートの色。

名前付き範囲

名前付き範囲。

JSON 表現 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
フィールド
namedRangeId

string

名前付き範囲の ID。
name

string

名前付き範囲の名前。
range

object (GridRange)

この範囲を表します。

DataSource

スプレッドシート内の外部データソースに関する情報。

JSON 表現 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
フィールド
dataSourceId

string

データソースを識別する、スプレッドシート スコープの一意の ID です。（例: 1080547365）。
spec

object (DataSourceSpec)

このスプレッドシートに接続されているデータソースの DataSourceSpec。
calculatedColumns[]

object (DataSourceColumn)

データソース内のすべての計算列。
sheetId

integer

データソースに接続されている Sheet の ID。このフィールドは一度設定すると変更できません。

データソースを作成すると、関連する DATA_SOURCE シートも作成されます。このフィールドが指定されていない場合、作成されたシートの ID がランダムに生成されます。

データソース仕様

これにより、データソースの詳細を指定します。たとえば BigQuery の場合は、BigQuery ソースに関する情報を指定します。

JSON 表現 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
フィールド
parameters[]

object (DataSourceParameter)

データソースのパラメータ。データソースをクエリする際に使用されます。
共用体フィールド spec。データソース タイプごとの実際の仕様。spec は次のいずれかになります。
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec。

BigQuery の DataSource 仕様

シートに接続されている BigQuery データソースの仕様。

JSON 表現 
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
フィールド
projectId

string

請求先アカウントが関連付けられた BigQuery 対応の Google Cloud プロジェクトの ID。データソースに対して実行されたクエリはすべて、プロジェクトに課金されます。
共用体フィールド spec。実際の仕様。spec は次のいずれかになります。
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec。
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec。

BigQueryQuerySpec

カスタム BigQuery クエリを指定します。

JSON 表現 
{
  "rawQuery": string
}
フィールド
rawQuery

string

生のクエリ文字列。

BigQuery テーブル仕様

BigQuery テーブル定義を指定します。ネイティブ テーブルのみを使用できます。

JSON 表現 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
フィールド
tableProjectId

string

テーブルが属する BigQuery プロジェクトの ID。指定しない場合、projectId であると見なされます。
tableId

string

BigQuery テーブル ID。
datasetId

string

BigQuery データセット ID。

DataSourceParameter

データソースのクエリのパラメータ。このパラメータを使用すると、スプレッドシートからクエリに値を渡すことができます。

JSON 表現 
{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
フィールド
共用体フィールド identifier。パラメータ ID。identifier は次のいずれかになります。
name

string

名前付きパラメータ。DataSource をサポートする正当な識別子である必要があります。（例: BigQuery identifier）。
共用体フィールド value。パラメータ値。value は次のいずれかになります。
namedRangeId

string

NamedRange の ID。サイズは 1x1 にする必要があります。
range

object (GridRange)

パラメータの値を含む範囲。サイズは 1x1 にする必要があります。

DataSourceRefreshSchedule

データソースを更新するようにスケジュールします。

スプレッドシートのデータソースは、一定の時間間隔で更新されます。開始時間は、スプレッドシート エディタの [スケジュールされた更新] ボタンをクリックして指定できますが、間隔は 4 時間に固定されています。たとえば、開始時刻を午前 8 時に指定した場合、更新は毎日午前 8 時から午後 12 時までの間に行われます。

JSON 表現 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
フィールド
enabled

boolean

更新スケジュールが有効になっている場合は true、それ以外の場合は false です。
refreshScope

enum (DataSourceRefreshScope)

更新のスコープ。ALL_DATA_SOURCES を指定します。
nextRun

object (Interval)

出力のみ。次の実行の時間間隔。
共用体フィールド schedule_config。スケジュール構成 schedule_config は次のいずれかになります。
dailySchedule

object (DataSourceRefreshDailySchedule)

毎日の更新スケジュール。
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

1 週間の更新スケジュール。
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

1 か月ごとの更新スケジュール。

DataSourceRefreshScope

データソースの更新スコープ。

列挙型
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED デフォルト値。使用しないでください。
ALL_DATA_SOURCES スプレッドシート内のすべてのデータソースと、関連するデータソース オブジェクトを更新します。

DataSourceRefreshDailySchedule

特定の期間のデータを毎日更新するスケジュール。

JSON 表現 
{
  "startTime": {
    object (TimeOfDay)
  }
}
フィールド
startTime

object (TimeOfDay)

データソースの更新がスケジュールされる開始時間。hours パートのみが使用されます。時間間隔のデフォルトは、スプレッドシート エディタの時間間隔のサイズに設定されます。

TimeOfDay

1 日のうちの時刻を表します。日付とタイムゾーンは意味を持たないか、他の場所で指定されています。API は、うるう秒を許可するようにできます。関連する型は、google.type.Date と google.protobuf.Timestamp です。

JSON 表現 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
フィールド
hours

integer

時間（24 時間形式）。0～23 である必要があります。API ではビジネスの終了時間などのシナリオにおいて、値 "24:00:00" を許可することもできます。
minutes

integer

分。0～59 である必要があります。
seconds

integer

秒。通常、0～59 である必要があります。API がうるう秒を許可する場合、値 60 が許可されます。
nanos

integer

秒の小数部分（ナノ秒単位）。0～999,999,999 である必要があります。

DataSourceRefreshWeeklySchedule

特定の期間内の特定の日付にデータを更新する週単位のスケジュール。

JSON 表現 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
フィールド
startTime

object (TimeOfDay)

データソースの更新がスケジュールされる開始時間。hours パートのみが使用されます。時間間隔のデフォルトは、スプレッドシート エディタの時間間隔のサイズに設定されます。
daysOfWeek[]

enum (DayOfWeek)

更新する曜日。少なくとも 1 日指定してください。

DayOfWeek

曜日を表します。

列挙型
DAY_OF_WEEK_UNSPECIFIED 曜日が指定されていません。
MONDAY 月曜日
TUESDAY 火曜日
WEDNESDAY 水曜日
THURSDAY 木曜日
FRIDAY Friday
SATURDAY Saturday
SUNDAY 日曜日

DataSourceRefreshMonthSchedule

毎月、データの更新頻度。

JSON 表現 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
フィールド
startTime

object (TimeOfDay)

データソースの更新がスケジュールされる開始時間。hours パートのみが使用されます。時間間隔のデフォルトは、スプレッドシート エディタの時間間隔のサイズに設定されます。
daysOfMonth[]

integer

更新する月の日数。1 ～ 28 日のマッピングは、1 ～ 28 のみがサポートされます。少なくとも 1 日指定してください。

間隔

タイムスタンプの開始値（その値を含む）とタイムスタンプの終了値（その値を含まない）でエンコードされた時間を表します。

開始位置は終了位置までにする必要があります。開始位置が終了位置と等しい場合、間隔は空になります（一致なし）。開始と終了の両方が指定されていない場合、間隔は常に一致します。

JSON 表現 
{
  "startTime": string,
  "endTime": string
}
フィールド
startTime

string (Timestamp format)

（省略可）指定期間の開始値。

指定する場合、この時間間隔と一致するタイムスタンプは、開始時刻と同じか、それ以降である必要があります。
endTime

string (Timestamp format)

（省略可）期間の終了時（排他的）です。

指定する場合、この時間間隔と一致するタイムスタンプは、終了時刻よりも前の時刻にする必要があります。

Methods

batchUpdate

 スプレッドシートに 1 つ以上の更新を適用します。

create

 スプレッドシートを作成します。新しく作成したスプレッドシートを返します。

get

 指定された ID のスプレッドシートを返します。

getByDataFilter

 指定された ID のスプレッドシートを返します。