REST Resource: notes

संसाधन: ध्यान दें

एक नोट.

JSON के काेड में दिखाना 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "trashTime": string,
  "trashed": boolean,
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "permissions": [
    {
      object (Permission)
    }
  ],
  "title": string,
  "body": {
    object (Section)
  }
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. इस नोट के संसाधन का नाम. KeepService में आइडेंटिफ़ायर के बारे में सामान्य जानकारी देखें.
createTime

string (Timestamp format)

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

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस नोट में पिछली बार कब बदलाव किया गया था.
trashTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस नोट को ट्रैश में कब भेजा गया था. अगर trashed, तो नोट को मिटा दिया जाता है. अगर नोट को ट्रैश में नहीं डाला गया है, तो यह फ़ील्ड सेट नहीं होता. साथ ही, ट्रैश में मौजूद फ़ील्ड false होता है.
trashed

boolean

सिर्फ़ आउटपुट के लिए. true अगर यह नोट ट्रैश में डाल दिया गया है. ट्रैश में भेजने पर, नोट को मिटा दिया जाता है.
attachments[]

object (Attachment)

सिर्फ़ आउटपुट के लिए. इस नोट में अटैच किए गए दस्तावेज़.
permissions[]

object (Permission)

सिर्फ़ आउटपुट के लिए. नोट पर सेट की गई अनुमतियों की सूची. नोट के मालिक के लिए कम से कम एक एंट्री हो.
title

string

नोट का टाइटल. इसमें 1,000 से कम वर्ण होने चाहिए.
body

object (Section)

नोट का मुख्य हिस्सा.

अटैचमेंट

किसी नोट में अटैच किया गया आइटम.

JSON के काेड में दिखाना 
{
  "name": string,
  "mimeType": [
    string
  ]
}
फ़ील्ड
name

string

संसाधन का नाम;
mimeType[]

string

अटैचमेंट के लिए उपलब्ध MIME टाइप (IANA मीडिया टाइप).

अनुमति

नोट पर एक अनुमति. member को role से जोड़ता है.

JSON के काेड में दिखाना 
{
  "name": string,
  "role": enum (Role),
  "email": string,
  "deleted": boolean,

  // Union field member can be only one of the following:
  "user": {
    object (User)
  },
  "group": {
    object (Group)
  },
  "family": {
    object (Family)
  }
  // End of list of possible types for union field member.
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. संसाधन का नाम.
role

enum (Role)

इस अनुमति से मिली भूमिका. भूमिका से यह तय होता है कि इकाई के पास नोट पढ़ने, लिखने, और शेयर करने की सुविधा है या नहीं.
email

string

सदस्य का ईमेल पता. अगर 'बनाने पर' सेट किया जाता है, तो User या Group मैसेज में email फ़ील्ड खाली होना चाहिए या इस फ़ील्ड से मेल खाना चाहिए. अगर सदस्य के पास कोई ईमेल पता नहीं है, तो पढ़ने के बाद यह सेटिंग हट सकती है.
deleted

boolean

सिर्फ़ आउटपुट के लिए. इस सदस्य को मिटाया गया है या नहीं. अगर सदस्य को वापस लाया जाता है, तो यह वैल्यू 'गलत' पर सेट हो जाती है. साथ ही, वापस लाया गया सदस्य नोट में अपनी भूमिका बनाए रखता है.
यूनियन फ़ील्ड member. उस पहचान के बारे में बताता है जिसे भूमिका दी गई है. अगर सदस्य को मिटा दिया गया है, तो सदस्य की स्थिति सेट नहीं की जाती. member इनमें से कोई एक हो सकता है:
user

object (User)

सिर्फ़ आउटपुट के लिए. वह उपयोगकर्ता जिस पर यह भूमिका लागू होती है.
group

object (Group)

सिर्फ़ आउटपुट के लिए. वह ग्रुप जिस पर यह भूमिका लागू होती है.
family

object (Family)

सिर्फ़ आउटपुट के लिए. वह Google फ़ैमिली ग्रुप जिस पर यह भूमिका लागू होती है.

भूमिका

इससे पता चलता है कि किसी इकाई की क्या भूमिकाएं हो सकती हैं.

Enums
ROLE_UNSPECIFIED कोई भूमिका तय नहीं की गई है.
OWNER ऐसी भूमिका जिसे पूरा ऐक्सेस दिया गया हो. इस भूमिका को जोड़ा या हटाया नहीं जा सकता. नोट बनाने वाले ने तय किया है.
WRITER इस भूमिका वाले व्यक्ति को कॉन्टेंट बनाने और नोट की अनुमतियों में बदलाव करने की अनुमति मिलती है.

उपयोगकर्ता

किसी एक उपयोगकर्ता के बारे में जानकारी देता है.

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

string

उपयोगकर्ता का ईमेल पता.

ग्रुप

किसी एक ग्रुप के बारे में बताता है.

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

string

ग्रुप का ईमेल पता.

फ़ैमिली

इस टाइप में कोई फ़ील्ड नहीं है.

किसी एक Google फ़ैमिली ग्रुप के बारे में जानकारी देता है.

सेक्शन

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

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

  // Union field Content can be only one of the following:
  "text": {
    object (TextContent)
  },
  "list": {
    object (ListContent)
  }
  // End of list of possible types for union field Content.
}
फ़ील्ड
यूनियन फ़ील्ड Content. सेक्शन का कॉन्टेंट, इनमें से किसी एक वैल्यू टाइप का होना चाहिए. Content इनमें से कोई एक हो सकता है:
text

object (TextContent)

इसका इस्तेमाल तब किया जाता है, जब इस सेक्शन का कॉन्टेंट टेक्स्ट का ब्लॉक हो. टेक्स्ट कॉन्टेंट की लंबाई 20,000 वर्णों से कम होनी चाहिए.
list

object (ListContent)

इस सेक्शन का कॉन्टेंट सूची होने पर इसका इस्तेमाल किया जाता है.

TextContent

किसी टेक्स्ट सेक्शन या सूची के आइटम के लिए टेक्स्ट का ब्लॉक.

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

string

नोट का टेक्स्ट. इसकी सीमाएं, इस टाइप का इस्तेमाल करने वाले फ़ील्ड के हिसाब से अलग-अलग होती हैं.

ListContent

किसी एक सूची वाले नोट के लिए आइटम की सूची.

JSON के काेड में दिखाना 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
फ़ील्ड
listItems[]

object (ListItem)

सूची में मौजूद आइटम. आइटम की संख्या 1,000 से कम होनी चाहिए.

ListItem

नोट की सूची में मौजूद एक आइटम.

JSON के काेड में दिखाना 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
फ़ील्ड
childListItems[]

object (ListItem)

अगर सेट किया गया है, तो इस सूची के आइटम के नीचे नेस्ट किए गए सूची के आइटम की सूची. नेस्ट करने की सुविधा का इस्तेमाल सिर्फ़ एक लेवल पर किया जा सकता है.
text

object (TextContent)

इस आइटम का टेक्स्ट. इसमें 1,000 से कम वर्ण होने चाहिए.
checked

boolean

इस आइटम पर सही का निशान लगा है या नहीं.

तरीके

create

 नया नोट बनाता है.

delete

 किसी नोट को मिटाता है.

get

 कोई नोट मिलता है.

list

 नोट की सूचियां.