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)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
フィールド
spreadsheetId

string

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

object (SpreadsheetProperties)

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

object (Sheet)

スプレッドシートの一部であるシート。
namedRanges[]

object (NamedRange)

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

string

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

object (DeveloperMetadata)

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

object (DataSource)

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

object (DataSourceRefreshSchedule)

出力専用。データソースの更新スケジュールのリスト。
comments[]

object (CommentThread)

スプレッドシートに関連付けられているコメント スレッド。
commentsViewMode

enum (CommentsViewMode)

出力専用。スプレッドシートに適用されたコメント ビューモード。

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

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

  • en などの ISO 639-1 言語コード

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

  • 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 に設定できます。管理者が許可リスト機能を有効にしている場合、この値はバイパスされ、常に true が返されます。

RecalculationInterval

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

列挙型
RECALCULATION_INTERVAL_UNSPECIFIED デフォルト値。この値は使用しないでください。
ON_CHANGE 揮発性関数は、変更のたびに更新されます。
MINUTE 揮発性関数は、変更のたびと毎分更新されます。
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)
    }
  ],

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
フィールド
parameters[]

object (DataSourceParameter)

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

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec。
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][]。

BigQueryDataSourceSpec

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

JSON 表現 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
フィールド
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。

LookerDataSourceSpec

Looker データソースの仕様。

JSON 表現 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
フィールド
instanceUri

string

Looker インスタンスの URL。
model

string

Looker モデルの名前。
explore

string

Looker モデル エクスプローラの名前。

DataSourceParameter

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

JSON 表現 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
フィールド
共用体フィールド identifier。パラメータ ID。identifier は次のいずれかになります。
name

string

名前付きパラメータ。DataSource をサポートする正当な識別子である必要があります。たとえば、BigQuery 識別子。
共用体フィールド 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)
  },

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
フィールド
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

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

integer

1 時間の分。0 以上 59 以下にする必要があります。
seconds

integer

1 分の秒数。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 Wednesday
THURSDAY 木曜日
FRIDAY 金曜日
SATURDAY 土曜日
SUNDAY 日曜日

DataSourceRefreshMonthlySchedule

特定の時間間隔で、月の特定日にデータを更新する月次スケジュール。

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

object (TimeOfDay)

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

integer

更新する日付。1 ～ 28 のみがサポートされており、1 日から 28 日にマッピングされます。少なくとも 1 日を指定する必要があります。

間隔

時間間隔を表します。開始日時を示す Timestamp（この日時を含む）と終了日時を示す Timestamp（この日時を含まない）としてエンコードされます。

開始日時は終了日時以前にする必要があります。開始日時と終了日時が同じ場合、時間間隔は空になります（どの時間とも一致しません）。開始日時と終了日時が両方とも指定されていない場合、その時間間隔はすべての日時と一致します。

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

string (Timestamp format)

省略可。時間間隔の開始日時（この日時を含む）。

指定した場合、開始日時と同じかそれ以降の Timestamp がこの時間間隔に一致します。
endTime

string (Timestamp format)

省略可。時間間隔の終了日時（この日時を含まない）。

指定した場合、終了時刻より前の Timestamp がこの時間間隔に一致します。

CommentThread

スプレッドシート内の単一のコメント スレッドを表します。

JSON 表現 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
フィールド
commentId

string

コメント スレッドの一意の ID。
anchorId

string

このスレッドが関連付けられているシート内の CommentAnchor の ID。
headPost

object (Post)

スレッドの最初の投稿。
replies[]

object (Post)

ヘッド投稿への返信。
status

enum (Status)

スレッドがオープンか解決済みか。
共用体フィールド quote。コメントが作成されたときのドキュメントからの引用テキスト。quote は次のいずれかになります。
plainTextQuote

string

コメントが作成されたときにスプレッドシートから引用されたテキスト。書式なしテキストとしてフォーマットされます。

投稿

コメント スレッド内の単一の投稿を表します。

JSON 表現 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
フィールド
postId

string

出力専用。投稿の一意の ID。
content

string

投稿の内容。

commentAction が RESOLVE または REOPEN でない場合は、空でないことが必要です。

このテキスト コンテンツは、スプレッドシート エディタで作成されたコメントと同様に処理されます。書式設定や通知などについても同様の動作になります。

2,048 UTF-8 コード単位を超えてはなりません。
contentHtml

string

出力専用。投稿のコンテンツ（HTML 形式）。
author

object (PostAuthor)

出力専用。投稿を作成したユーザー。
createTime

string (Timestamp format)

出力専用。投稿が作成された時刻。
updateTime

string (Timestamp format)

出力専用。投稿が最後に更新された時刻。
deleted

boolean

出力専用。投稿が削除されているかどうか。true、content、author の各フィールドは空になります。
fromImportedSpreadsheet

boolean

出力専用。投稿がインポートされたスプレッドシートからのものかどうか。このフィールドは発信者が直接設定することはできません。
fromCopiedSpreadsheet

boolean

出力専用。投稿がコピーされたスプレッドシートからのものかどうか。このフィールドは発信者が直接設定することはできません。
assigneeEmail

string

省略可。この投稿の一部としてスレッドに新たに割り当てられるユーザーのメール。

次の場合は 400 Bad Request エラーを返します。

  • 親スレッドは、headPost に割り当てがない CommentThread です。

  • commentAction が RESOLVE または REOPEN として指定されている。

  • assigneeEmail が 2,048 UTF-8 コード単位を超えています。
commentAction

enum (CommentActionType)

投稿の作成の一環として行われたアクション。

PostAuthor

コメント投稿を作成したユーザーを表します。

JSON 表現 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
フィールド
displayName

string

ユーザーの表示名です。著者が匿名の場合は存在しない可能性があります。
me

boolean

リクエストを行っているユーザーが認証済みユーザーかどうか。
anonymous

boolean

ユーザーが匿名かどうか。
user

string

投稿者のユーザーのリソース名。Google People API でユーザーを識別するためにも使用できます。形式: users/{user}。匿名フィールドが true の場合、または投稿がインポートされたスプレッドシートからのものである場合は、入力されません。

CommentActionType

コメント スレッドに対するこの返信で行われたアクション。

列挙型
COMMENT_ACTION_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
NO_COMMENT_ACTION_CHANGE この記事ではアクションの変更はありません。
RESOLVE この投稿でスレッドは解決します。
REOPEN この投稿により、スレッドが再開されます。

ステータス

コメント スレッドのステータス オプション。

列挙型
STATUS_UNSPECIFIED デフォルト値。この値は使用されません。
OPEN コメント スレッドが開きます。
RESOLVED コメント スレッドが解決されます。

CommentsViewMode

スプレッドシートに適用されるコメント表示モード。コメントが含まれているかどうかを示します。コメントとコメント アンカーの有無にかかわらず、スプレッドシートを読み取るためのオプションが用意されています。

列挙型
COMMENTS_VIEW_MODE_UNSPECIFIED CommentsViewMode が指定されていません。COMMENTS_VIEW_MODE_OMITTED が適用されます。
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS 返されるスプレッドシートに適用される CommentsViewMode は、ユーザーの現在のアクセスレベルによって異なります。ユーザーが閲覧権限のみを持っている場合は、COMMENTS_VIEW_MODE_OMITTED が適用されます。それ以外の場合は、COMMENTS_VIEW_MODE_INCLUDED が適用されます。
COMMENTS_VIEW_MODE_OMITTED 返されたスプレッドシートにはコメントが含まれていません。
COMMENTS_VIEW_MODE_INCLUDED

返されたスプレッドシートにはコメントが含まれています。

このモードでスプレッドシートを取得するリクエストは、ユーザーにコメントを表示する権限がない場合、403 エラーを返します。

メソッド

batchUpdate

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

create

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

get

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

getByDataFilter

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