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

स्प्रेडशीट का आईडी. इस फ़ील्ड को सिर्फ़ पढ़ा जा सकता है.

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)

सिर्फ़ आउटपुट के लिए. स्प्रेडशीट पर टिप्पणियां देखने का मोड लागू किया गया है.

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-1 कोड मौजूद नहीं है, तो ISO 639-2 भाषा कोड, जैसे कि fil

  • आईएसओ भाषा कोड और देश के कोड का कॉम्बिनेशन, जैसे कि 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

इमेज और इंपोर्ट फ़ंक्शन के लिए, बाहरी यूआरएल का ऐक्सेस देना है या नहीं. सही होने पर ही पढ़ें. गलत होने पर, इसे सही के तौर पर सेट किया जा सकता है. अगर एडमिन ने अनुमति वाली सूची की सुविधा चालू की है, तो इस वैल्यू को अनदेखा कर दिया जाएगा और हमेशा 'सही है' वैल्यू दिखेगी.

RecalculationInterval

रीकैलकुलेशन के इंटरवल के संभावित विकल्पों की गिनती.

Enums
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)
    }
  ],

  "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 प्रोजेक्ट आईडी. डेटा सोर्स के ख़िलाफ़ की गई किसी भी क्वेरी के लिए, प्रोजेक्ट से शुल्क लिया जाता है.

यूनियन फ़ील्ड 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 डेटासेट आईडी.

LookerDataSourceSpec

Looker डेटा सोर्स की जानकारी.

JSON के काेड में दिखाना
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
फ़ील्ड
instanceUri

string

Looker इंस्टेंस का यूआरएल.

model

string

Looker मॉडल का नाम.

explore

string

Looker मॉडल एक्सप्लोर का नाम.

DataSourceParameter

डेटा सोर्स की क्वेरी में मौजूद पैरामीटर. इस पैरामीटर की मदद से उपयोगकर्ता, स्प्रेडशीट से वैल्यू को क्वेरी में पास कर सकता है.

JSON के काेड में दिखाना
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
फ़ील्ड
यूनियन फ़ील्ड identifier. पैरामीटर का आइडेंटिफ़ायर. identifier इनमें से सिर्फ़ एक हो सकता है:
name

string

नाम वाला पैरामीटर. यह DataSource के लिए एक मान्य आइडेंटिफ़ायर होना चाहिए. उदाहरण के लिए, BigQuery आइडेंटिफ़ायर.

यूनियन फ़ील्ड value. पैरामीटर वैल्यू. value इनमें से सिर्फ़ एक हो सकता है:
namedRangeId

string

NamedRange का आईडी. इसका साइज़ 1x1 होना चाहिए.

range

object (GridRange)

ऐसी रेंज जिसमें पैरामीटर की वैल्यू शामिल होती है. इसका साइज़ 1x1 होना चाहिए.

DataSourceRefreshSchedule

डेटा सोर्स को रीफ़्रेश करने का शेड्यूल.

स्प्रेडशीट में मौजूद डेटा सोर्स को तय समय अंतराल में रीफ़्रेश किया जाता है. Sheets एडिटर में, शेड्यूल किया गया रीफ़्रेश बटन पर क्लिक करके, शुरू होने का समय तय किया जा सकता है. हालांकि, इंटरवल चार घंटे पर सेट होता है. उदाहरण के लिए, अगर आपने डेटा रीफ़्रेश होने का समय सुबह 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

डेटा सोर्स रीफ़्रेश करने के स्कोप.

Enums
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED डिफ़ॉल्ट वैल्यू, इसका इस्तेमाल न करें.
ALL_DATA_SOURCES यह विकल्प, स्प्रेडशीट में मौजूद सभी डेटा सोर्स और उनसे जुड़े डेटा सोर्स ऑब्जेक्ट को रीफ़्रेश करता है.

DataSourceRefreshDailySchedule

किसी तय अवधि में हर दिन डेटा रीफ़्रेश करने का शेड्यूल.

JSON के काेड में दिखाना
{
  "startTime": {
    object (TimeOfDay)
  }
}
फ़ील्ड
startTime

object (TimeOfDay)

यह उस टाइम इंटरवल की शुरुआत का समय होता है जिसमें डेटा सोर्स को रीफ़्रेश करने के लिए शेड्यूल किया जाता है. सिर्फ़ hours वाले हिस्से का इस्तेमाल किया जाता है. समय अंतराल का साइज़, Sheets एडिटर में मौजूद साइज़ के बराबर होता है.

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 के बराबर या इससे ज़्यादा और 99,99,99,999 के बराबर या इससे कम होना चाहिए.

DataSourceRefreshWeeklySchedule

डेटा को रीफ़्रेश करने के लिए, हफ़्ते का शेड्यूल. इसमें किसी तय समय अंतराल में, डेटा को रीफ़्रेश करने के लिए हफ़्ते के खास दिन तय किए जाते हैं.

JSON के काेड में दिखाना
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
फ़ील्ड
startTime

object (TimeOfDay)

यह उस टाइम इंटरवल की शुरुआत का समय होता है जिसमें डेटा सोर्स को रीफ़्रेश करने के लिए शेड्यूल किया जाता है. सिर्फ़ hours वाले हिस्से का इस्तेमाल किया जाता है. समय अंतराल का साइज़, Sheets एडिटर में मौजूद साइज़ के बराबर होता है.

daysOfWeek[]

enum (DayOfWeek)

रीफ़्रेश करने के लिए हफ़्ते के दिन. कम से कम एक दिन की जानकारी देना ज़रूरी है.

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 तक की वैल्यू इस्तेमाल की जा सकती हैं. ये वैल्यू, महीने के पहले से लेकर 28वें दिन तक के लिए होती हैं. कम से कम एक दिन की जानकारी देना ज़रूरी है.

इंटरवल

यह टाइम इंटरवल को दिखाता है. इसे टाइमस्टैंप के तौर पर कोड किया जाता है. इसमें टाइमस्टैंप के शुरू होने का समय (शामिल है) और टाइमस्टैंप के खत्म होने का समय (शामिल नहीं है) होता है.

शुरू होने की तारीख, खत्म होने की तारीख से पहले या उसके बराबर होनी चाहिए. शुरू होने और खत्म होने का समय एक जैसा होने पर, इंटरवल खाली होता है. इसका मतलब है कि यह किसी भी समय से मेल नहीं खाता. शुरू और खत्म होने का समय तय न होने पर, अंतराल किसी भी समय से मेल खाता है.

JSON के काेड में दिखाना
{
  "startTime": string,
  "endTime": string
}
फ़ील्ड
startTime

string (Timestamp format)

ज़रूरी नहीं. समय अंतराल शुरू होने का समय शामिल है.

अगर इस इंटरवल के हिसाब से कोई टाइमस्टैंप दिया गया है, तो वह शुरू होने के समय के बराबर या उसके बाद का होना चाहिए.

endTime

string (Timestamp format)

ज़रूरी नहीं. इंटरवल खत्म होने का समय (अलग से उपलब्ध).

अगर यह तय किया गया है, तो इस इंटरवल से मेल खाने वाला टाइमस्टैंप, खत्म होने के समय से पहले का होना चाहिए.

CommentThread

यह स्प्रेडशीट में मौजूद किसी टिप्पणी थ्रेड को दिखाता है.

JSON के काेड में दिखाना
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
फ़ील्ड
commentId

string

टिप्पणी थ्रेड का यूनीक आईडी.

anchorId

string

शीट में मौजूद उस CommentAnchor का आईडी जिससे यह थ्रेड जुड़ी है.

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

सिर्फ़ आउटपुट के लिए. पोस्ट का यूनीक आईडी.

content

string

पोस्ट का कॉन्टेंट.

अगर commentAction की वैल्यू RESOLVE या REOPEN नहीं है, तो इस एट्रिब्यूट की वैल्यू देना ज़रूरी है.

इस टेक्स्ट कॉन्टेंट को, Sheets Editor में बनाई गई टिप्पणियों की तरह ही मैनेज किया जाएगा. इसमें फ़ॉर्मैटिंग, सूचनाओं वगैरह के लिए एक जैसे तरीके इस्तेमाल किए जाएंगे.

इसमें 2048 से ज़्यादा UTF-8 कोड यूनिट नहीं होनी चाहिए.

contentHtml

string

सिर्फ़ आउटपुट के लिए. पोस्ट का कॉन्टेंट, एचटीएमएल के तौर पर.

author

object (PostAuthor)

सिर्फ़ आउटपुट के लिए. पोस्ट बनाने वाला उपयोगकर्ता.

createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. पोस्ट बनाए जाने का समय.

updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. पोस्ट को आखिरी बार अपडेट किए जाने का समय.

deleted

boolean

सिर्फ़ आउटपुट के लिए. पोस्ट मिटा दी गई है या नहीं. अगर true, content, और author फ़ील्ड खाली होंगे.

fromImportedSpreadsheet

boolean

सिर्फ़ आउटपुट के लिए. पोस्ट, इंपोर्ट की गई स्प्रेडशीट से है या नहीं. कॉल करने वाले लोग, इस फ़ील्ड को सीधे तौर पर सेट नहीं कर सकते.

fromCopiedSpreadsheet

boolean

सिर्फ़ आउटपुट के लिए. क्या पोस्ट, कॉपी की गई स्प्रेडशीट से है. कॉल करने वाले लोग, इस फ़ील्ड को सीधे तौर पर सेट नहीं कर सकते.

assigneeEmail

string

ज़रूरी नहीं. उस उपयोगकर्ता का ईमेल पता जिसे इस पोस्ट के हिस्से के तौर पर, थ्रेड में नया असाइन किया जा रहा है.

इन मामलों में, गड़बड़ी 400: गलत अनुरोध का मैसेज दिखता है:

  • पैरंट थ्रेड एक CommentThread है, जिसके headPost को कोई असाइन नहीं किया गया है.

  • commentAction को RESOLVE या REOPEN के तौर पर दिखाया गया हो.

  • assigneeEmail, 2048 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

टिप्पणी थ्रेड के इस जवाब पर की गई कार्रवाई.

Enums
COMMENT_ACTION_TYPE_UNSPECIFIED डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया गया है.
NO_COMMENT_ACTION_CHANGE इस पोस्ट में कोई बदलाव नहीं किया गया है.
RESOLVE इस पोस्ट से थ्रेड बंद हो जाती है.
REOPEN इस पोस्ट से थ्रेड फिर से खुल जाती है.

स्थिति

टिप्पणी थ्रेड के स्टेटस के विकल्प.

Enums
STATUS_UNSPECIFIED डिफ़ॉल्ट मान. इस वैल्यू का इस्तेमाल नहीं किया गया है.
OPEN टिप्पणी थ्रेड खुला है.
RESOLVED टिप्पणी थ्रेड का समाधान कर दिया गया है.

CommentsViewMode

स्प्रेडशीट पर लागू किया गया टिप्पणियां देखने का मोड. इससे पता चलता है कि टिप्पणियां शामिल हैं या नहीं. इससे स्प्रेडशीट को टिप्पणियों और टिप्पणी ऐंकर के साथ या उनके बिना पढ़ने के विकल्प मिलते हैं.

Enums
COMMENTS_VIEW_MODE_UNSPECIFIED CommentsViewMode की जानकारी नहीं दी गई है; COMMENTS_VIEW_MODE_OMITTED लागू किया गया है.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS स्प्रेडशीट में टिप्पणियां देखने का मोड, उपयोगकर्ता के मौजूदा ऐक्सेस लेवल पर निर्भर करता है. अगर उपयोगकर्ता के पास सिर्फ़ देखने का ऐक्सेस है, तो COMMENTS_VIEW_MODE_OMITTED लागू होता है. ऐसा न होने पर, COMMENTS_VIEW_MODE_INCLUDED लागू होता है.
COMMENTS_VIEW_MODE_OMITTED वापस भेजी गई स्प्रेडशीट में टिप्पणियां शामिल नहीं हैं.
COMMENTS_VIEW_MODE_INCLUDED

वापस की गई स्प्रेडशीट में टिप्पणियां शामिल हैं.

इस मोड का इस्तेमाल करके, स्प्रैडशीट को वापस पाने के अनुरोधों पर 403 गड़बड़ी दिखेगी. ऐसा तब होगा, जब उपयोगकर्ता के पास टिप्पणियां देखने की अनुमति नहीं होगी.

तरीके

batchUpdate

यह स्प्रेडशीट में एक या उससे ज़्यादा अपडेट लागू करता है.

create

यह एक स्प्रेडशीट बनाता है और नई बनाई गई स्प्रेडशीट दिखाता है.

get

यह फ़ंक्शन, दी गई आईडी वाली स्प्रेडशीट दिखाता है.

getByDataFilter

यह फ़ंक्शन, दी गई आईडी वाली स्प्रेडशीट दिखाता है.