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)

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

SpreadsheetProperties

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

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

string

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

string

スプレッドシートの言語 / 地域。次のいずれかの形式で指定します。

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

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

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

注: このフィールドを更新すると、一部のロケールと言語がサポートされません。
autoRecalc

enum (RecalculationInterval)

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

string

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

object (CellFormat)

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

object (IterativeCalculationSettings)

循環参照を反復計算で解くかどうか、またその方法を決定します。このフィールドがないと、循環参照が計算エラーになります。
spreadsheetTheme

object (SpreadsheetTheme)

スプレッドシートに適用されるテーマ。
importFunctionsExternalUrlAccessAllowed

boolean

画像関数とインポート関数に外部 URL アクセスを許可するかどうか。true の場合のみ読み取り専用。false の場合は、true に設定できます。

RecalculationInterval

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

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

IterativeCalculationSettings

反復計算による循環依存関係の解決方法を制御する設定。

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

integer

反復計算が有効な場合に実行する計算ラウンドの最大数。
convergenceThreshold

number

反復計算が有効で、連続する結果の差がこのしきい値未満の場合、計算は終了します。

SpreadsheetTheme

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

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

string

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

object (ThemeColorPair)

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

ThemeColorPair

スプレッドシートのテーマの色の種類と、それが表す具体的な色のマッピングペア。

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

enum (ThemeColorType)

スプレッドシートのテーマカラーのタイプ。
color

object (ColorStyle)

テーマのカラータイプに対応する具体的な色。

NamedRange

名前付き範囲。

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 がランダムに生成されます。

DataSourceSpec

データソースの詳細を指定します。たとえば 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。

BigQueryDataSourceSpec

シートに接続されている 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

未加工のクエリ文字列。

BigQueryTableSpec

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 識別子。
共用体フィールド value。パラメータ値。value は次のいずれかになります。
namedRangeId

string

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

object (GridRange)

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

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)

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

object (DataSourceRefreshMonthlySchedule)

毎月の更新スケジュール。

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 日曜日

DataSourceRefreshMonthlySchedule

データを一定期間、その月の特定の日に更新する月別のスケジュールです。

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

object (TimeOfDay)

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

integer

1 か月の中で更新する日数。1 ～ 28 日のみ指定でき、1 ～ 28 日目にマッピングされます。少なくとも 1 つの日付を指定する必要があります。

間隔

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

開始は終了以下にする必要があります。開始と終了が等しい場合、間隔は空になります（時間には一致しません）。start と end の両方が指定されていない場合、間隔は任意の時刻と一致します。

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

string (Timestamp format)

省略可。開始値（期間を含む）です。

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

string (Timestamp format)

省略可。期間の終了を含まない値。

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

Methods

batchUpdate

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

create

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

get

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

getByDataFilter

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