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

تمثّل هذه السمة عنوان 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

تمثّل هذه السمة المنطقة الزمنية لجدول البيانات، بتنسيق CLDR، مثل America/New_York. إذا لم يتم التعرف على المنطقة الزمنية، فقد تكون هذه المنطقة الزمنية مخصصة مثل GMT-07:00.
defaultFormat

object (CellFormat)

التنسيق التلقائي لجميع الخلايا في جدول البيانات. لن يتم ضبط CellData.effectiveFormat إذا كان تنسيق الخلية يساوي هذا التنسيق التلقائي. هذا الحقل للقراءة فقط.
iterativeCalculationSettings

object (IterativeCalculationSettings)

تحدد ما إذا كان يتم حل المراجع الدائرية باستخدام الحساب التكراري وكيف يتم ذلك. يعني عدم وجود هذا الحقل أن المراجع الدائرية تؤدي إلى أخطاء في الحساب.
spreadsheetTheme

object (SpreadsheetTheme)

تم تطبيق المظهر على جدول البيانات.
importFunctionsExternalUrlAccessAllowed

boolean

ما إذا كان سيتم السماح بالوصول إلى عنوان URL الخارجي لوظائف الاستيراد والصور. اقرأ فقط عند الصواب. عندما تكون القيمة false، يمكنك ضبطها على true.

RecalculationInterval

عبارة عن تعداد لخيارات الفاصل الزمني لإعادة الاحتساب.

عمليات التعداد
RECALCULATION_INTERVAL_UNSPECIFIED القيمة التلقائية. يجب عدم استخدام هذه القيمة.
ON_CHANGE يتم تعديل الدوال المتغيّرة عند كل تغيير.
MINUTE يتم تعديل الدوال المتغيّرة عند كل تغيير وكل دقيقة.
HOUR يتم تعديل الدوال المتغيّرة عند كل تغيير وكل ساعة.

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

رقم تعريف النطاق المُعنون.
name

string

اسم النطاق المُعنون.
range

object (GridRange)

النطاق الذي يمثله هذا.

DataSource

معلومات عن مصدر بيانات خارجي في جدول البيانات.

تمثيل 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

يمكنك جدولة إعادة تحميل مصدر البيانات.

وتتم إعادة تحميل مصادر البيانات في جدول البيانات خلال فترة زمنية معيّنة. يمكنك تحديد وقت البدء من خلال النقر على زر "إعادة التحميل المجدولة" في محرّر "جداول بيانات Google"، ولكن يتم تثبيت الفاصل الزمني عند 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

نطاقات إعادة تحميل مصدر البيانات.

عمليات التعداد
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED القيمة التلقائية، يُرجى عدم استخدامها.
ALL_DATA_SOURCES إعادة تحميل جميع مصادر البيانات وكائنات مصدر البيانات المرتبطة بها في جدول البيانات.

DataSourceRefreshDailySchedule

جدول زمني لإعادة تحميل البيانات كل يوم خلال فاصل زمني محدّد

تمثيل JSON 
{
  "startTime": {
    object (TimeOfDay)
  }
}
الحقول
startTime

object (TimeOfDay)

وقت بدء الفاصل الزمني الذي تمت فيه جدولة إعادة تحميل مصدر البيانات. يُستخدم جزء hours فقط. يكون حجم الفاصل الزمني تلقائيًا على ذلك في محرّر "جداول بيانات Google".

TimeOfDay

تمثل وقتًا من اليوم. قد يكون التاريخ والمنطقة الزمنية غير مهمَّين أو تم تحديدهما في مكان آخر. وقد تختار واجهة برمجة التطبيقات السماح بالثواني الكبيسة. النوعان ذوا الصلة هما google.type.Date وgoogle.protobuf.Timestamp.

تمثيل JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
الحقول
hours

integer

ساعات اليوم بتنسيق 24 ساعة يجب أن يتراوح الرقم بين 0 و23. قد تسمح واجهة برمجة التطبيقات بالقيمة "24:00:00" في سيناريوهات مثل وقت إغلاق النشاط التجاري.
minutes

integer

دقائق من الساعة من اليوم. يجب أن تتراوح القيمة بين 0 و59.
seconds

integer

ثواني من الدقائق من الوقت. يجب أن يتراوح الرقم عادةً من 0 إلى 59. قد تسمح واجهة برمجة التطبيقات بالقيمة 60 إذا كانت تتيح الثواني الكبيسة.
nanos

integer

كسور الثواني بالنانوثانية. يجب أن تتراوح القيمة بين 0 و999,999,999.

DataSourceRefreshWeeklySchedule

جدول أسبوعي لإعادة تحميل البيانات في أيام محدّدة خلال فترة زمنية معيّنة.

تمثيل JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
الحقول
startTime

object (TimeOfDay)

وقت بدء الفاصل الزمني الذي تمت فيه جدولة إعادة تحميل مصدر البيانات. يُستخدم جزء hours فقط. يكون حجم الفاصل الزمني تلقائيًا على ذلك في محرّر "جداول بيانات Google".
daysOfWeek[]

enum (DayOfWeek)

أيام الأسبوع المطلوب إعادة تحميلها يجب تحديد يوم واحد على الأقل.

DayOfWeek

يمثّل أحد أيام الأسبوع.

عمليات التعداد
DAY_OF_WEEK_UNSPECIFIED لم يتم تحديد يوم من الأسبوع.
MONDAY الاثنين
TUESDAY الثلاثاء
WEDNESDAY الأربعاء
THURSDAY الخميس
FRIDAY الجمعة
SATURDAY السبت
SUNDAY الأحد

DataSourceRefreshMonthlySchedule

جدول شهري لإعادة تحميل البيانات في أيام محدّدة من الشهر خلال فترة زمنية معيّنة

تمثيل JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
الحقول
startTime

object (TimeOfDay)

وقت بدء الفاصل الزمني الذي تمت فيه جدولة إعادة تحميل مصدر البيانات. يُستخدم جزء hours فقط. يكون حجم الفاصل الزمني تلقائيًا على ذلك في محرّر "جداول بيانات Google".
daysOfMonth[]

integer

أيام الشهر المطلوب إعادة تحميلها يمكن استخدام من 1 إلى 28 فقط، مع الربط بين اليوم الأول واليوم الثامن والعشرين. يجب تحديد يوم واحد على الأقل.

الفاصل الزمني

تمثّل هذه السمة فاصلاً زمنيًا مرمَّزًا كبداية طابع زمني (شاملًا) ونهاية طابع زمني (حصريًا).

يجب أن تكون البداية أقل من النهاية أو مساوية لها. عندما تساوي البداية النهاية، يكون الفاصل الزمني فارغًا (لا يتطابق أي وقت). عندما لا يتم تحديد كل من البداية والنهاية، يتطابق الفاصل الزمني في أي وقت.

تمثيل JSON 
{
  "startTime": string,
  "endTime": string
}
الحقول
startTime

string (Timestamp format)

اختياريّ. بداية شاملة للفاصل الزمني.

يجب أن يكون الطابع الزمني الذي يتطابق مع هذا الفاصل الزمني هو نفسه في البداية أو بعده، في حال تحديد ذلك.
endTime

string (Timestamp format)

اختياريّ. نهاية حصرية للفاصل الزمني

يجب أن يكون الطابع الزمني الذي يتطابق مع هذا الفاصل الزمني قبل النهاية، في حال تحديده.

الطُرق

batchUpdate

 يتم تطبيق تعديل واحد أو أكثر على جدول البيانات.

create

 لإنشاء جدول بيانات، وعرض جدول البيانات الذي تم إنشاؤه حديثًا.

get

 يؤدي ذلك إلى عرض جدول البيانات على المعرّف المحدّد.

getByDataFilter

 يؤدي ذلك إلى عرض جدول البيانات على المعرّف المحدّد.