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

شناسه صفحه گسترده. این فیلد فقط خواندنی است.

properties

object ( SpreadsheetProperties )

ویژگی های کلی یک صفحه گسترده

sheets[]

object ( Sheet )

برگه هایی که بخشی از یک صفحه گسترده هستند.

namedRanges[]

object ( NamedRange )

محدوده های نامگذاری شده در یک صفحه گسترده تعریف شده است.

spreadsheetUrl

string

آدرس صفحه گسترده. این فیلد فقط خواندنی است.

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)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
زمینه های
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 )

طرح زمینه روی صفحه گسترده اعمال شد.

importFunctionsExternalUrlAccessAllowed

boolean

اجازه دسترسی به URL خارجی برای توابع تصویر و وارد کردن. فقط وقتی درست است بخوانید. وقتی false باشد، می توانید مقدار true را تنظیم کنید.

بازه محاسبه مجدد

شمارشی از گزینه های احتمالی فاصله محاسبه مجدد.

Enums
RECALCULATION_INTERVAL_UNSPECIFIED مقدار پیش فرض. این مقدار نباید استفاده شود.
ON_CHANGE توابع فرار در هر تغییر به روز می شوند.
MINUTE توابع فرار در هر تغییر و هر دقیقه به روز می شوند.
HOUR توابع فرار در هر تغییر و ساعتی به روز می شوند.

IterativeCalculationSettings

تنظیماتی برای کنترل نحوه حل وابستگی های دایره ای با محاسبه تکراری.

نمایندگی JSON
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
زمینه های
maxIterations

integer

وقتی محاسبه تکراری فعال است، حداکثر تعداد دورهای محاسبه برای انجام.

convergenceThreshold

number

وقتی محاسبه تکراری فعال است و نتایج متوالی کمتر از این مقدار آستانه متفاوت است، دورهای محاسبه متوقف می‌شوند.

قالب صفحه گسترده

موضوع صفحه گسترده را نشان می دهد

نمایندگی 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 )

رنگ بتن مربوط به نوع رنگ تم.

Named Range

محدوده ای با نام

نمایندگی JSON
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
زمینه های
namedRangeId

string

شناسه محدوده نامگذاری شده

name

string

نام محدوده نامگذاری شده.

range

object ( GridRange )

محدوده ای که این نشان می دهد.

منبع اطلاعات

اطلاعات مربوط به یک منبع داده خارجی در صفحه گسترده.

نمایندگی JSON
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
زمینه های
dataSourceId

string

شناسه منحصر به فرد با دامنه صفحه گسترده که منبع داده را شناسایی می کند. مثال: 1080547365.

spec

object ( DataSourceSpec )

DataSourceSpec برای منبع داده مرتبط با این صفحه گسترده.

calculatedColumns[]

object ( DataSourceColumn )

تمام ستون های محاسبه شده در منبع داده.

sheetId

integer

شناسه Sheet مرتبط با منبع داده. پس از تنظیم نمی توان فیلد را تغییر داد.

هنگام ایجاد یک منبع داده، یک برگه DATA_SOURCE مرتبط نیز ایجاد می شود، اگر فیلد مشخص نشده باشد، شناسه برگه ایجاد شده به صورت تصادفی ایجاد می شود.

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

شناسه پروژه Google Cloud فعال BigQuery با یک حساب صورت‌حساب پیوست شده است. برای هر درخواستی که علیه منبع داده اجرا می شود، پروژه هزینه می شود.

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 که جدول به آن تعلق دارد. اگر مشخص نشده باشد، projectId در نظر گرفته می شود.

tableId

string

شناسه جدول BigQuery.

datasetId

string

شناسه مجموعه داده BigQuery.

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 فیلد اتحادیه شناسه پارامتر identifier می تواند تنها یکی از موارد زیر باشد:
name

string

پارامتر نامگذاری شده باید یک شناسه قانونی برای DataSource باشد که از آن پشتیبانی می کند. به عنوان مثال، شناسه BigQuery .

value فیلد اتحادیه مقدار پارامتر value فقط می تواند یکی از موارد زیر باشد:
namedRangeId

string

شناسه یک NamedRange . اندازه آن باید 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

اگر برنامه بازخوانی فعال باشد درست است یا در غیر این صورت نادرست است.

refreshScope

enum ( DataSourceRefreshScope )

دامنه تجدید. باید ALL_DATA_SOURCES باشد.

nextRun

object ( Interval )

فقط خروجی فاصله زمانی اجرای بعدی.

فیلد اتحادیه schedule_config . تنظیمات زمانبندی schedule_config تنها می تواند یکی از موارد زیر باشد:
dailySchedule

object ( DataSourceRefreshDailySchedule )

برنامه به روز رسانی روزانه.

weeklySchedule

object ( DataSourceRefreshWeeklySchedule )

برنامه به روز رسانی هفتگی

monthlySchedule

object ( DataSourceRefreshMonthlySchedule )

برنامه به روز رسانی ماهانه.

DataSourceRefreshScope

حوزه های تازه سازی منبع داده.

Enums
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED مقدار پیش فرض، استفاده نکنید.
ALL_DATA_SOURCES همه منابع داده و اشیاء منبع داده مرتبط با آنها را در صفحه گسترده بازخوانی می کند.

DataSourceRefreshDailySchedule

برنامه ای برای به روز رسانی داده ها هر روز در یک بازه زمانی معین.

نمایندگی JSON
{
  "startTime": {
    object (TimeOfDay)
  }
}
زمینه های
startTime

object ( TimeOfDay )

زمان شروع یک بازه زمانی که در آن یک به روز رسانی منبع داده برنامه ریزی شده است. فقط قسمت hours استفاده شده است. اندازه بازه زمانی پیش‌فرض در ویرایشگر Sheets است.

TimeOfDay

یک زمان از روز را نشان می دهد. تاریخ و منطقه زمانی یا مهم نیستند یا در جای دیگری مشخص شده اند. یک 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 استفاده شده است. اندازه بازه زمانی پیش‌فرض در ویرایشگر Sheets است.

daysOfWeek[]

enum ( DayOfWeek )

روزهای هفته برای تازه کردن. حداقل یک روز باید مشخص شود.

روز هفته

یک روز از هفته را نشان می دهد.

Enums
DAY_OF_WEEK_UNSPECIFIED روز هفته نامشخص است.
MONDAY دوشنبه
TUESDAY سهشنبه
WEDNESDAY چهار شنبه
THURSDAY پنج شنبه
FRIDAY جمعه
SATURDAY شنبه
SUNDAY یکشنبه

DataSourceRefreshMonthlySchedule

یک برنامه ماهانه برای بازخوانی داده ها در روزهای خاصی در ماه در یک بازه زمانی معین.

نمایندگی JSON
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
زمینه های
startTime

object ( TimeOfDay )

زمان شروع یک بازه زمانی که در آن یک به روز رسانی منبع داده برنامه ریزی شده است. فقط قسمت hours استفاده شده است. اندازه بازه زمانی پیش‌فرض در ویرایشگر Sheets است.

daysOfMonth[]

integer

روزهای ماه برای تازه کردن. فقط 1-28 پشتیبانی می شود، نقشه برداری از روز 1 تا 28. حداقل یک روز باید مشخص شود.

فاصله

یک بازه زمانی را نشان می‌دهد که به‌عنوان شروع مهر زمانی (شامل) و پایان مهر زمانی (انحصاری) کدگذاری می‌شود.

شروع باید کمتر یا مساوی با پایان باشد. هنگامی که شروع برابر با پایان است، فاصله خالی است (هیچ زمانی مطابقت ندارد). وقتی شروع و پایان هر دو نامشخص هستند، فاصله زمانی با هر زمانی مطابقت دارد.

نمایندگی JSON
{
  "startTime": string,
  "endTime": string
}
زمینه های
startTime

string ( Timestamp format)

اختیاری. شروع فراگیر فاصله

اگر مشخص شده باشد، مهر زمانی مطابق با این بازه زمانی باید یکسان یا پس از شروع باشد.

endTime

string ( Timestamp format)

اختیاری. پایان انحصاری فاصله

اگر مشخص شده باشد، یک مهر زمانی مطابق با این فاصله باید قبل از پایان باشد.

مواد و روش ها

batchUpdate

 یک یا چند به روز رسانی را در صفحه گسترده اعمال می کند.

create

 یک صفحه گسترده ایجاد می کند و صفحه گسترده ایجاد شده جدید را برمی گرداند.

get

 صفحه گسترده را در شناسه داده شده برمی گرداند.

getByDataFilter

 صفحه گسترده را در شناسه داده شده برمی گرداند.