Class Document

दस्तावेज़

कोई दस्तावेज़, जिसमें एक या उससे ज़्यादा Tab ऑब्जेक्ट हों. हर दस्तावेज़ में रिच टेक्स्ट और टेबल और सूची जैसे एलिमेंट शामिल करें.

दस्तावेज़ों को DocumentApp का इस्तेमाल करके खोला या बनाया जा सकता है. 

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

टेक्स्ट कॉन्टेंट को सीधे ऐक्सेस करने और उसमें बदलाव करने वाले Document क्लास के तरीके इन पर काम करते हैं या तो सक्रिय टैब (स्क्रिप्ट में बात विशेष दस्तावेज़) या पहला टैब (अगर कोई सक्रिय दस्तावेज़ उपलब्ध नहीं है). इन पर निर्भर स्क्रिप्ट इन तरीकों (जैसे कि getBody()) को सहायता टैब पर माइग्रेट किया जा सकता है. इसके लिए, आपको getTabs() और फिर Tab.asDocumentTab() चुकाने होंगे.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
addBookmark(position)Bookmarkपहले टैब पर दिए गए Position पर या उन स्क्रिप्ट के लिए Bookmark जोड़ता है जिन्हें बाउंड करें, जो ऐक्टिव टैब है.
addEditor(emailAddress)Documentदिए गए उपयोगकर्ता को Document के संपादकों की सूची में जोड़ता है.
addEditor(user)Documentदिए गए उपयोगकर्ता को Document के संपादकों की सूची में जोड़ता है.
addEditors(emailAddresses)DocumentDocument के लिए, एडिटर की सूची में उपयोगकर्ताओं के दिए गए अरे को जोड़ता है.
addFooter()FooterSectionपहले टैब में, अगर कोई फ़ुटर सेक्शन मौजूद नहीं है, तो इसे पहले टैब में जोड़ देता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब जोड़ देता है.
addHeader()HeaderSectionपहले टैब में, अगर कोई हेडर सेक्शन मौजूद नहीं है, तो हेडर सेक्शन को जोड़ देता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, 'चालू' टैब जोड़ देता है.
addNamedRange(name, range)NamedRangeएक NamedRange जोड़ता है, जो एक Range है, जिसमें इस्तेमाल करने के लिए नाम और आईडी होता है बाद में वापस लाने की प्रोसेस, पहले टैब में या किसी दस्तावेज़ से जुड़ी स्क्रिप्ट के लिए, चालू टैब.
addViewer(emailAddress)Documentदिए गए उपयोगकर्ता को Document के दर्शकों की सूची में जोड़ता है.
addViewer(user)Documentदिए गए उपयोगकर्ता को Document के दर्शकों की सूची में जोड़ता है.
addViewers(emailAddresses)DocumentDocument के लिए, उपयोगकर्ताओं की दी गई अरे को दर्शकों की सूची में जोड़ता है.
getActiveTab()Tabउपयोगकर्ता के मौजूदा Tab को दस्तावेज़ में दिखाता है.
getAs(contentType)Blobमौजूदा Document कॉन्टेंट को, बताए गए टाइप के BLOB के तौर पर फ़ेच करता है.
getBlob()BlobDocument के मौजूदा कॉन्टेंट को ब्लॉब के तौर पर वापस लाता है.
getBody()Bodyपहले टैब के Body को हासिल करता है या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, चालू टैब के DocumentBodySection को हासिल करता है.
getBookmark(id)Bookmarkपहले टैब में दिए गए आईडी के साथ Bookmark दिखाता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब दिखाता है.
getBookmarks()Bookmark[]सभी Bookmark ऑब्जेक्ट को पहले टैब में शामिल करता है या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब को ऐक्सेस करता है.
getCursor()Positionयह नीति उपयोगकर्ता के कर्सर को ऐक्टिव टैब पर ले जाती है.
getEditors()User[]इस Document के संपादकों की सूची पाएं.
getFooter()FooterSectionयह फ़ंक्शन पहले टैब के फ़ुटर सेक्शन को दिखाता है. इसके अलावा, किसी दस्तावेज़ से जुड़ी स्क्रिप्ट के लिए, चालू टैब का फ़ुटर दिखाता है सेक्शन में जाएं.
getFootnotes()Footnote[]पहले टैब के मुख्य हिस्से में मौजूद सभी Footnote एलिमेंट या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, टैब के मुख्य हिस्से को हासिल करता है.
getHeader()HeaderSectionयह फ़ंक्शन पहले टैब के हेडर सेक्शन को हासिल करता है. इसके अलावा, किसी दस्तावेज़ से लिंक होने वाली स्क्रिप्ट के लिए, टैब के हेडर को वापस लाता है सेक्शन में जाएं.
getId()Stringदस्तावेज़ के यूनीक आइडेंटिफ़ायर की जानकारी हासिल करता है.
getLanguage()Stringदस्तावेज़ का भाषा कोड हासिल करता है.
getName()Stringदस्तावेज़ का शीर्षक वापस लाता है.
getNamedRangeById(id)NamedRangeपहले टैब में दिए गए आईडी के साथ NamedRange दिखाता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब दिखाता है.
getNamedRanges()NamedRange[]सभी NamedRange ऑब्जेक्ट को पहले टैब में शामिल करता है या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब को ऐक्सेस करता है.
getNamedRanges(name)NamedRange[]पहले टैब में दिए गए नाम के साथ सभी NamedRange ऑब्जेक्ट हासिल करता है या उन स्क्रिप्ट के लिए किसी दस्तावेज़, यानी ऐक्टिव टैब से बाउंड हो सकते हैं.
getSelection()Rangeऐक्टिव टैब में उपयोगकर्ता के चुने गए विकल्प की जानकारी दिखाता है.
getSupportedLanguageCodes()String[]उन सभी भाषा कोड को पाएं जो Google Docs फ़ाइलों के साथ काम करते हैं.
getTab(tabId)Tabबताए गए आईडी के साथ Tab मिलता है.
getTabs()Tab[]बिना नेस्ट किए गए Tab को ऐक्सेस करता है, जो दस्तावेज़ का हिस्सा हैं.
getUrl()Stringमौजूदा दस्तावेज़ को ऐक्सेस करने के लिए, यूआरएल को फ़ेच करता है.
getViewers()User[]इस Document के दर्शकों और टिप्पणी करने वालों की सूची दिखाता है.
newPosition(element, offset)Positionएक नया Position बनाता है, जो किसी टैब में मौजूद किसी जगह का रेफ़रंस होता है. पहले टैब का खास एलिमेंट या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब.
newRange()RangeBuilderइसमें टैब एलिमेंट से Range ऑब्जेक्ट बनाने के लिए इस्तेमाल किया जाने वाला बिल्डर बनाता है पहला टैब या, उन स्क्रिप्ट के लिए जो किसी सक्रिय टैब होता है.
removeEditor(emailAddress)Documentदिए गए उपयोगकर्ता को Document के संपादकों की सूची से हटाता है.
removeEditor(user)Documentदिए गए उपयोगकर्ता को Document के संपादकों की सूची से हटाता है.
removeViewer(emailAddress)Documentदिए गए उपयोगकर्ता को Document के दर्शकों और टिप्पणी करने वालों की सूची से हटाता है.
removeViewer(user)Documentदिए गए उपयोगकर्ता को Document के दर्शकों और टिप्पणी करने वालों की सूची से हटाता है.
saveAndClose()voidमौजूदा Document को सेव करता है.
setActiveTab(tabId)voidयह विकल्प, मौजूदा दस्तावेज़ में उपयोगकर्ता के चुने गए Tab को, बताए गए आईडी वाले टैब पर सेट करता है.
setCursor(position)DocumentPosition के हिसाब से, उपयोगकर्ता का कर्सर सेट करता है.
setLanguage(languageCode)Documentदस्तावेज़ का भाषा कोड सेट करता है.
setName(name)Documentदस्तावेज़ का टाइटल सेट करता है.
setSelection(range)DocumentRange के हिसाब से, ऐक्टिव टैब में उपयोगकर्ता के चुने गए विकल्प को सेट करता है.

विस्तृत दस्तावेज़

addBookmark(position)

पहले टैब पर दिए गए Position पर या उन स्क्रिप्ट के लिए Bookmark जोड़ता है जिन्हें बाउंड करें, जो ऐक्टिव टैब है. किसी कीवर्ड को किसी भी टैब को बुकमार्क करने के लिए, DocumentTab.addBookmark(position) तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

पैरामीटर

नामटाइपब्यौरा
positionPositionनए बुकमार्क की स्थिति.

वापसी का टिकट

Bookmark — नया बुकमार्क.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(emailAddress)

दिए गए उपयोगकर्ता को Document के संपादकों की सूची में जोड़ता है. अगर उपयोगकर्ता पहले से इस तरीके से, उपयोगकर्ता को दर्शकों की सूची से बाहर किया जाता है.

पैरामीटर

नामटाइपब्यौरा
emailAddressStringजोड़ने के लिए उपयोगकर्ता का ईमेल पता.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(user)

दिए गए उपयोगकर्ता को Document के संपादकों की सूची में जोड़ता है. अगर उपयोगकर्ता पहले से इस तरीके से, उपयोगकर्ता को दर्शकों की सूची से बाहर किया जाता है.

पैरामीटर

नामटाइपब्यौरा
userUserजोड़ने के लिए व्यक्ति का प्रतिनिधित्व.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditors(emailAddresses)

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

पैरामीटर

नामटाइपब्यौरा
emailAddressesString[]जोड़े जाने वाले उपयोगकर्ताओं के ईमेल पतों का कलेक्शन.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addFooter()

पहले टैब में, अगर कोई फ़ुटर सेक्शन मौजूद नहीं है, तो इसे पहले टैब में जोड़ देता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब जोड़ देता है. फ़ुटर जोड़ने के लिए सेक्शन पर जाएं, तो DocumentTab.addFooter() तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

वापसी का टिकट

FooterSection — टैब फ़ुटर.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addHeader()

पहले टैब में, अगर कोई हेडर सेक्शन मौजूद नहीं है, तो हेडर सेक्शन को जोड़ देता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, 'चालू' टैब जोड़ देता है. हेडर जोड़ने के लिए सेक्शन पर जाएं, तो DocumentTab.addHeader() तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

वापसी का टिकट

HeaderSection — टैब हेडर.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addNamedRange(name, range)

एक NamedRange जोड़ता है, जो एक Range है, जिसमें इस्तेमाल करने के लिए नाम और आईडी होता है बाद में वापस लाने की प्रोसेस, पहले टैब में या किसी दस्तावेज़ से जुड़ी स्क्रिप्ट के लिए, चालू टैब. किसी भी टैब में NamedRange जोड़ने के लिए, DocumentTab.addNamedRange(name, range) तरीके का इस्तेमाल करें. नाम नहीं यूनीक होना ज़रूरी है; एक ही दस्तावेज़ में कई अलग-अलग रेंज का एक ही नाम हो सकता है. की तरह ही काम करता है. इसके उलट, दस्तावेज़ में आईडी यूनीक होते हैं, जैसे कि एचटीएमएल में आईडी. किसी दस्तावेज़ में NamedRange जोड़ने के बाद, आपके पास उसमें बदलाव करने का विकल्प नहीं होता है. उसे सिर्फ़ हटाया जा सकता है.

दस्तावेज़ को ऐक्सेस करने वाली कोई भी स्क्रिप्ट, NamedRange को ऐक्सेस कर सकती है. अनजाने में होने वाली समस्याओं से बचने के लिए स्क्रिप्ट के बीच टकराव होता है, तो रेंज के नामों से पहले किसी यूनीक स्ट्रिंग का इस्तेमाल करें. 

// Creates a named range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

पैरामीटर

नामटाइपब्यौरा
nameStringरेंज का नाम, जिसका यूनीक होना ज़रूरी नहीं है; रेंज के नाम ये होने चाहिए 1 से 256 वर्णों का होना चाहिए.
rangeRangeनाम के साथ जोड़े जाने वाले एलिमेंट की रेंज; इस रेंज में, चुना गया मौजूदा विकल्प या खोज का नतीजा शामिल हो सकता है. इसके अलावा, मैन्युअल तरीके से newRange() की मदद से भी बनाया जा सकता है.

वापसी का टिकट

NamedRange — NamedRange.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(emailAddress)

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

पैरामीटर

नामटाइपब्यौरा
emailAddressStringजोड़ने के लिए उपयोगकर्ता का ईमेल पता.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(user)

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

पैरामीटर

नामटाइपब्यौरा
userUserजोड़ने के लिए व्यक्ति का प्रतिनिधित्व.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewers(emailAddresses)

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

पैरामीटर

नामटाइपब्यौरा
emailAddressesString[]जोड़े जाने वाले उपयोगकर्ताओं के ईमेल पतों का कलेक्शन.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getActiveTab()

उपयोगकर्ता के मौजूदा Tab को दस्तावेज़ में दिखाता है. स्क्रिप्ट केवल जो उपयोगकर्ता, स्क्रिप्ट चला रहा है उसका ऐक्टिव टैब. यह टैब सिर्फ़ तब दिखेगा, जब स्क्रिप्ट दस्तावेज़ से बाउंड हो. 

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());

वापसी का टिकट

Tab — उपयोगकर्ता की मौजूदा समय गतिविधि Tab है. इसके अलावा, अगर स्क्रिप्ट इस पर सीमित नहीं है, तो null दस्तावेज़.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAs(contentType)

मौजूदा Document कॉन्टेंट को, बताए गए टाइप के BLOB के तौर पर फ़ेच करता है. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

पैरामीटर

नामटाइपब्यौरा
contentTypeStringवह MIME प्रकार जिसमें बदलना है; 'application/pdf' और 'text/markdown' का इस्तेमाल किया जा सकता है.

वापसी का टिकट

Blob — ब्लॉब के तौर पर मौजूदा दस्तावेज़.

getBlob()

Document के मौजूदा कॉन्टेंट को ब्लॉब के तौर पर वापस लाता है. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

वापसी का टिकट

Blob — ब्लॉब के तौर पर मौजूदा दस्तावेज़.

getBody()

पहले टैब के Body को हासिल करता है या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, चालू टैब के DocumentBodySection को हासिल करता है. किसी भी टैब का DocumentBodySection पाने के लिए, DocumentTab.getBody() तरीके का इस्तेमाल करें.

टैब में अलग-अलग तरह के सेक्शन हो सकते हैं, जैसे कि HeaderSection, FooterSection. किसी टैब के लिए ऐक्टिव सेक्शन Body है.

Document में एलिमेंट के तरीके, ऐक्टिव Body को डेलिगेट करते हैं. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

वापसी का टिकट

Body — टैब का मुख्य सेक्शन.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmark(id)

पहले टैब में दिए गए आईडी के साथ Bookmark दिखाता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब दिखाता है. पाने के लिए तो DocumentTab.getBookmark(id) विधि का उपयोग करें. अगर टैब में ऐसा कोई Bookmark मौजूद नहीं है, तो यह तरीका null दिखाता है. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

पैरामीटर

नामटाइपब्यौरा
idStringBookmark का आईडी.

वापसी का टिकट

Bookmark — दिए गए आईडी वाला Bookmark या अगर कोई Bookmark नहीं है, तो null यह टैब में मौजूद होता है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmarks()

सभी Bookmark ऑब्जेक्ट को पहले टैब में शामिल करता है या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब को ऐक्सेस करता है. सभी पाने के लिए तो किसी भी टैब में बुकमार्क जोड़ने के लिए, DocumentTab.getBookmarks() तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

वापसी का टिकट

Bookmark[] — टैब में मौजूद Bookmark ऑब्जेक्ट का कलेक्शन.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getCursor()

यह नीति उपयोगकर्ता के कर्सर को ऐक्टिव टैब पर ले जाती है. स्क्रिप्ट केवल उस उपयोगकर्ता के कर्सर तक पहुंच सकती है जो और स्क्रिप्ट तभी चल रही है, जब स्क्रिप्ट दस्तावेज़ से बंध हो. 

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

वापसी का टिकट

Position — यह उपयोगकर्ता के कर्सर को दिखाता है, या अगर उपयोगकर्ता के पास नहीं होता है, तो null कर्सर को टैब में रखा जाता है या अगर स्क्रिप्ट दस्तावेज़ से बंधी नहीं होती है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getEditors()

इस Document के संपादकों की सूची पाएं.

वापसी का टिकट

User[] — बदलाव करने की अनुमति वाले उपयोगकर्ताओं का कलेक्शन.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFooter()

यह फ़ंक्शन पहले टैब के फ़ुटर सेक्शन को दिखाता है. इसके अलावा, किसी दस्तावेज़ से जुड़ी स्क्रिप्ट के लिए, चालू टैब का फ़ुटर दिखाता है सेक्शन में जाएं. किसी भी टैब का फ़ुटर सेक्शन पाने के लिए, DocumentTab.getFooter() तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

वापसी का टिकट

FooterSection — टैब का फ़ुटर.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFootnotes()

पहले टैब के मुख्य हिस्से में मौजूद सभी Footnote एलिमेंट या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, टैब के मुख्य हिस्से को हासिल करता है. पाने के लिए किसी भी टैब में मौजूद सभी फ़ुटनोट के लिए, DocumentTab.getFootnotes() तरीका इस्तेमाल करें.

getFootnotes पर किए जाने वाले कॉल से, टैब के एलिमेंट में गड़बड़ी पैदा होती है. बड़े टैब के लिए, इस तरीके को गैर-ज़रूरी कॉल से बचाएं. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

वापसी का टिकट

Footnote[] — टैब के फ़ुटनोट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getHeader()

यह फ़ंक्शन पहले टैब के हेडर सेक्शन को हासिल करता है. इसके अलावा, किसी दस्तावेज़ से लिंक होने वाली स्क्रिप्ट के लिए, टैब के हेडर को वापस लाता है सेक्शन में जाएं. किसी भी टैब का हेडर सेक्शन पाने के लिए, DocumentTab.getHeader() तरीका इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

वापसी का टिकट

HeaderSection — टैब का हेडर.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getId()

दस्तावेज़ के यूनीक आइडेंटिफ़ायर की जानकारी हासिल करता है. दस्तावेज़ आईडी का इस्तेमाल, DocumentApp.openById() के साथ किसी खास दस्तावेज़ को खोलने के लिए किया जाता है.

वापसी का टिकट

String — दस्तावेज़ का आईडी.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLanguage()

दस्तावेज़ का भाषा कोड हासिल करता है. यह भाषा दस्तावेज़ संपादक की फ़ाइल में दिखाई गई है &gt; भाषा, जो दस्तावेज़ में मौजूद असल भाषा नहीं हो सकती.

वापसी का टिकट

String — दस्तावेज़ की भाषा या अगर तय नहीं है, तो null.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getName()

दस्तावेज़ का शीर्षक वापस लाता है.

वापसी का टिकट

String — दस्तावेज़ का टाइटल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRangeById(id)

पहले टैब में दिए गए आईडी के साथ NamedRange दिखाता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब दिखाता है. पाने के लिए किसी भी टैब में दिए गए आईडी के साथ NamedRange, DocumentTab.getNamedRangeById(id) का इस्तेमाल करें तरीका. अगर टैब में ऐसा कोई NamedRange मौजूद नहीं है, तो यह तरीका null दिखाता है. नाम ज़रूरी नहीं है कि अलग-अलग टैब में भी अलग-अलग हों; एक ही टैब में कई अलग-अलग रेंज हो सकती हैं, एक ही नाम शेयर करें, काफ़ी हद तक HTML में एक क्लास की तरह. इसके उलट, टैब में आईडी यूनीक होते हैं, के रूप में दिखाई जाती है.

पैरामीटर

नामटाइपब्यौरा
idStringरेंज का आईडी, जो टैब के अंदर यूनीक होता है.

वापसी का टिकट

NamedRange — दिए गए आईडी के साथ NamedRange या null, अगर ऐसी कोई रेंज मौजूद नहीं है टैब.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges()

सभी NamedRange ऑब्जेक्ट को पहले टैब में शामिल करता है या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब को ऐक्सेस करता है. सभी पाने के लिए किसी भी टैब में NamedRange ऑब्जेक्ट होने पर, DocumentTab.getNamedRanges() तरीके का इस्तेमाल करें.

टैब को ऐक्सेस करने वाली कोई भी स्क्रिप्ट, NamedRange को ऐक्सेस कर सकती है. इससे बचने के लिए स्क्रिप्ट के बीच अनचाहे टकराव होते हैं, तो रेंज के नामों से पहले किसी यूनीक स्ट्रिंग का इस्तेमाल करें.

वापसी का टिकट

NamedRange[] — टैब में NamedRange ऑब्जेक्ट का कलेक्शन. इसमें कई आइटम शामिल हो सकते हैं समान नाम वाली रेंज.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges(name)

पहले टैब में दिए गए नाम के साथ सभी NamedRange ऑब्जेक्ट हासिल करता है या उन स्क्रिप्ट के लिए किसी दस्तावेज़, यानी ऐक्टिव टैब से बाउंड हो सकते हैं. पाने के लिए किसी भी टैब में मौजूद सभी NamedRange ऑब्जेक्ट के लिए, DocumentTab.getNamedRanges(name) तरीके का इस्तेमाल करें. यह ज़रूरी नहीं है कि नाम अलग-अलग हों, यहां तक कि पूरे टैब पर भी; कई अलग-अलग रेंज में उसी टैब का एक ही नाम हो सकता है, यानी HTML में किसी क्लास की तरह. इसके उलट, आईडी यूनीक होते हैं जैसे HTML में कोई आईडी.

दस्तावेज़ को ऐक्सेस करने वाली कोई भी स्क्रिप्ट, NamedRange को ऐक्सेस कर सकती है. इससे बचने के लिए स्क्रिप्ट के बीच अनचाहे टकराव होते हैं, तो रेंज के नामों से पहले किसी यूनीक स्ट्रिंग का इस्तेमाल करें.

पैरामीटर

नामटाइपब्यौरा
nameStringरेंज का नाम, जो ज़रूरी नहीं है कि यूनीक हो.

वापसी का टिकट

NamedRange[] — दिए गए नाम के साथ टैब में मौजूद NamedRange ऑब्जेक्ट का कलेक्शन.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSelection()

ऐक्टिव टैब में उपयोगकर्ता के चुने गए विकल्प की जानकारी दिखाता है. स्क्रिप्ट उपयोगकर्ता के चुने गए विकल्प को ही ऐक्सेस कर सकती है कौन स्क्रिप्ट चला रहा है और केवल तभी जब स्क्रिप्ट दस्तावेज़ से बंधा हो. 

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

वापसी का टिकट

Range — यह दिखाता है कि उपयोगकर्ता ने चुना है. इसके अलावा, अगर उपयोगकर्ता के पास नहीं है, तो null टैब में चुने गए किसी भी हिस्से को चुनें. अगर पैराग्राफ़ के आखिरी हिस्से को ही चुना जाता है, तो सिर्फ़ आखिरी हिस्से को में से एक पैराग्राफ़ और एक नई पंक्ति का चयन किया जाता है, या अगर स्क्रिप्ट दस्तावेज़ से बंधी नहीं होती है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSupportedLanguageCodes()

उन सभी भाषा कोड को पाएं जो Google Docs फ़ाइलों के साथ काम करते हैं.

वापसी का टिकट

String[] — भाषा कोड का कलेक्शन.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTab(tabId)

बताए गए आईडी के साथ Tab मिलता है. अगर ऐसा कोई Tab मौजूद नहीं है, तो यह तरीका null दिखाता है. टैब को किसी भी नेस्टिंग स्तर पर ऐक्सेस कर सकता है.

पैरामीटर

नामटाइपब्यौरा
tabIdStringपाने के लिए टैब का आईडी.

वापसी का टिकट

Tab — बताए गए आईडी वाला Tab या अगर कोई Tab मौजूद नहीं है, तो null.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTabs()

बिना नेस्ट किए गए Tab को ऐक्सेस करता है, जो दस्तावेज़ का हिस्सा हैं.

टैब में चाइल्ड टैब, यानी दूसरे टैब के अंदर नेस्ट किया गया टैब हो सकता है. चाइल्ड टैब ऐक्सेस कर सकते हैं Tab.getChildTabs() का इस्तेमाल करके.

वापसी का टिकट

Tab[] — सभी Tab की सूची जो दस्तावेज़ का हिस्सा है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUrl()

मौजूदा दस्तावेज़ को ऐक्सेस करने के लिए, यूआरएल को फ़ेच करता है. 

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

वापसी का टिकट

String — मौजूदा दस्तावेज़ को ऐक्सेस करने के लिए यूआरएल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getViewers()

इस Document के दर्शकों और टिप्पणी करने वालों की सूची दिखाता है.

वापसी का टिकट

User[] — ऐसे उपयोगकर्ताओं का कलेक्शन जिनके पास देखने या टिप्पणी करने की अनुमति है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newPosition(element, offset)

एक नया Position बनाता है, जो किसी टैब में मौजूद किसी जगह का रेफ़रंस होता है. पहले टैब का खास एलिमेंट या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब. बनाने के लिए किसी भी टैब में जगह से जुड़ी Position, DocumentTab.newPosition(element, offset) का इस्तेमाल करें तरीका. अन्य इस्तेमाल के साथ, उपयोगकर्ता के कर्सर को Position के तौर पर दिखाया जाता है. 

// Append a paragraph to the active tab, then place the user's cursor after the first word of
// the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

पैरामीटर

नामटाइपब्यौरा
elementElementवह एलिमेंट जिसमें नया Position शामिल होना चाहिए; यह Text एलिमेंट या Paragraph जैसा कंटेनर एलिमेंट.
offsetIntegerText एलिमेंट के लिए, Position से पहले के वर्णों की संख्या; अन्य एलिमेंट के लिए, Position से पहले चाइल्ड एलिमेंट की संख्या एक ही कंटेनर एलिमेंट.

वापसी का टिकट

Position — नया Position.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newRange()

इसमें टैब एलिमेंट से Range ऑब्जेक्ट बनाने के लिए इस्तेमाल किया जाने वाला बिल्डर बनाता है पहला टैब या, उन स्क्रिप्ट के लिए जो किसी सक्रिय टैब होता है. DocumentRange ऑब्जेक्ट बनाने के लिए इस्तेमाल किया गया बिल्डर बनाने के लिए किसी भी टैब के टैब एलिमेंट से, DocumentTab.newRange() तरीके का इस्तेमाल करें. 

// Change the user's selection to a range that includes every table in the active tab.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

वापसी का टिकट

RangeBuilder — नया बिल्डर.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(emailAddress)

दिए गए उपयोगकर्ता को Document के संपादकों की सूची से हटाता है. इस तरीके से, उपयोगकर्ताओं को Document ऐक्सेस करने से रोकें. ऐसा वे तब कर सकते हैं, जब वे किसी ऐसे उपयोगकर्ता की भूमिका से जुड़े हों जिनके पास सामान्य ऐक्सेस—उदाहरण के लिए, अगर Document को उपयोगकर्ता के पूरे डोमेन या अगर Document 'शेयर की गई ड्राइव' में है, जिसे उपयोगकर्ता ऐक्सेस कर सकता है.

Drive फ़ाइलों के लिए, इससे उपयोगकर्ता को दर्शकों की सूची से भी हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
emailAddressStringउपयोगकर्ता का ईमेल पता जिसे हटाना है.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(user)

दिए गए उपयोगकर्ता को Document के संपादकों की सूची से हटाता है. इस तरीके से, उपयोगकर्ताओं को Document ऐक्सेस करने से रोकें. ऐसा वे तब कर सकते हैं, जब वे किसी ऐसे उपयोगकर्ता की भूमिका से जुड़े हों जिनके पास सामान्य ऐक्सेस—उदाहरण के लिए, अगर Document को उपयोगकर्ता के पूरे डोमेन या अगर Document 'शेयर की गई ड्राइव' में है, जिसे उपयोगकर्ता ऐक्सेस कर सकता है.

Drive फ़ाइलों के लिए, इससे उपयोगकर्ता को दर्शकों की सूची से भी हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
userUserउपयोगकर्ता का ऐसा इलस्ट्रेशन जिसे हटाना है.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(emailAddress)

दिए गए उपयोगकर्ता को Document के दर्शकों और टिप्पणी करने वालों की सूची से हटाता है. यह तरीके से इस बात पर कोई असर नहीं पड़ता कि उपयोगकर्ता एडिटर है, दर्शक या टिप्पणी करने वाला नहीं है. इस तरीके से उपयोगकर्ताओं को Document को ऐक्सेस करने से नहीं रोकता है. ऐसा तब होता है, जब वे उन उपयोगकर्ताओं की कैटगरी से जुड़े हों जो उसे सामान्य ऐक्सेस मिल सकता है—उदाहरण के लिए, अगर Document को उपयोगकर्ता के साथ शेयर किया गया है या अगर Document 'शेयर की गई ड्राइव' में है, तो उपयोगकर्ता ऐक्सेस कर सकता है.

Drive फ़ाइलों के लिए, इससे उपयोगकर्ता को एडिटर की सूची से भी हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
emailAddressStringउपयोगकर्ता का ईमेल पता जिसे हटाना है.

वापसी का टिकट

Document — चेन बनाने के लिए यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(user)

दिए गए उपयोगकर्ता को Document के दर्शकों और टिप्पणी करने वालों की सूची से हटाता है. यह तरीके का कोई असर नहीं होता अगर उपयोगकर्ता संपादक है, न कि दर्शक. इस तरीके से, अगर वे सामान्य उपयोगकर्ताओं की किसी क्लास से जुड़े हैं, तो वे Document को ऐक्सेस करने से रोक सकते हैं उदाहरण के लिए, अगर Document को उपयोगकर्ता के पूरे डोमेन के साथ शेयर किया गया हो या अगर Document 'शेयर की गई ड्राइव' में है, तो उपयोगकर्ता उसे ऐक्सेस कर सकता है.

Drive फ़ाइलों के लिए, इससे उपयोगकर्ता को एडिटर की सूची से भी हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
userUserउपयोगकर्ता का ऐसा इलस्ट्रेशन जिसे हटाना है.

वापसी का टिकट

Document — चेन बनाने के लिए यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

saveAndClose()

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

स्क्रिप्ट प्रोसेस पूरी होने के बाद, saveAndClose() तरीका अपने-आप लागू हो जाता है बदलाव किए जा सकने वाले हर Document के लिए.

बंद Document में बदलाव नहीं किया जा सकता. फिर से खोलने के लिए DocumentApp.openById() का इस्तेमाल करें संपादन के लिए दिया गया दस्तावेज़.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setActiveTab(tabId)

यह विकल्प, मौजूदा दस्तावेज़ में उपयोगकर्ता के चुने गए Tab को, बताए गए आईडी वाले टैब पर सेट करता है. 

const doc = DocumentApp.getActiveDocument()

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab(TAB_ID);

पैरामीटर

नामटाइपब्यौरा
tabIdString'चालू है' के तौर पर सेट किए जाने वाले टैब का आईडी.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setCursor(position)

Position के हिसाब से, उपयोगकर्ता का कर्सर सेट करता है. स्क्रिप्ट केवल वह उपयोगकर्ता जो स्क्रिप्ट चला रहा है और सिर्फ़ तब, जब स्क्रिप्ट दस्तावेज़ से बाउंड हो.

इस्तेमाल नहीं किए जा रहे Tab से Position देने पर, उपयोगकर्ता का ऐक्टिव टैब बदल जाता है. 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

पैरामीटर

नामटाइपब्यौरा
positionPositionकर्सर की नई जगह.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLanguage(languageCode)

दस्तावेज़ का भाषा कोड सेट करता है. यह भाषा दस्तावेज़ संपादक की फ़ाइल में दिखाई गई है &gt; भाषा, जो दस्तावेज़ में मौजूद असल भाषा नहीं हो सकती. सभी मान्य भाषा कोड पाने के लिए, getSupportedLanguageCodes() का इस्तेमाल करें.

पैरामीटर

नामटाइपब्यौरा
languageCodeStringभाषा का कोड.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setName(name)

दस्तावेज़ का टाइटल सेट करता है.

पैरामीटर

नामटाइपब्यौरा
nameStringदस्तावेज़ का नया टाइटल.

वापसी का टिकट

Document — मौजूदा दस्तावेज़.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSelection(range)

Range के हिसाब से, ऐक्टिव टैब में उपयोगकर्ता के चुने गए विकल्प को सेट करता है. स्क्रिप्ट केवल उस उपयोगकर्ता के चुने गए ऐक्सेस को ऐक्सेस करें जो स्क्रिप्ट चला रहा है. ऐसा सिर्फ़ तब होगा, जब स्क्रिप्ट दस्तावेज़ से बाउंड हो. 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

पैरामीटर

नामटाइपब्यौरा
rangeRangeचुनने के लिए एलिमेंट की नई रेंज.

वापसी का टिकट

Document — चेन बनाने के लिए, यह Document.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, यहां दिए गए एक या एक से ज़्यादा स्कोप की अनुमति होनी चाहिए:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents