Class Document

दस्तावेज़

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

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

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

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

तरीके

तरीका	रिटर्न टाइप	संक्षिप्त विवरण
addBookmark(position)	Bookmark	दिए गए Position में एक Bookmark जोड़ता है.
addEditor(emailAddress)	Document	दिए गए उपयोगकर्ता को Document के लिए एडिटर की सूची में जोड़ता है.
addEditor(user)	Document	दिए गए उपयोगकर्ता को Document के लिए एडिटर की सूची में जोड़ता है.
addEditors(emailAddresses)	Document	उपयोगकर्ताओं के दिए गए अरे को Document के लिए एडिटर की सूची में जोड़ता है.
addFooter()	FooterSection	अगर दस्तावेज़ में फ़ुटर सेक्शन मौजूद नहीं है, तो इसे जोड़ा जाता है.
addHeader()	HeaderSection	अगर कोई दस्तावेज़ मौजूद नहीं है, तो हेडर सेक्शन को जोड़ा जाता है.
addNamedRange(name, range)	NamedRange	NamedRange जोड़ता है. यह ऐसा Range होता है जिसका एक नाम और आईडी होता है, जिसका इस्तेमाल बाद में वापस पाने के लिए किया जाता है.
addViewer(emailAddress)	Document	दिए गए उपयोगकर्ता को Document के दर्शकों की सूची में जोड़ता है.
addViewer(user)	Document	दिए गए उपयोगकर्ता को Document के दर्शकों की सूची में जोड़ता है.
addViewers(emailAddresses)	Document	Document के लिए दर्शकों की सूची में उपयोगकर्ताओं के दिए गए अरे को जोड़ता है.
getAs(contentType)	Blob	मौजूदा Document के कॉन्टेंट को, बताए गए टाइप के ब्लॉब के तौर पर लाता है.
getBlob()	Blob	Document के मौजूदा कॉन्टेंट को ब्लॉब के तौर पर फिर से लाता है.
getBody()	Body	सक्रिय दस्तावेज़ के Body को फिर से लाता है.
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 फ़ाइलों के साथ काम करने वाले सभी भाषा कोड मिलते हैं.
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 को सेव करता है.
setCursor(position)	Document	Position दिए जाने पर, चालू दस्तावेज़ में उपयोगकर्ता के कर्सर को सेट करता है.
setLanguage(languageCode)	Document	दस्तावेज़ का भाषा कोड सेट करता है.
setName(name)	Document	दस्तावेज़ का टाइटल सेट करता है.
setSelection(range)	Document	Range दिए जाने पर, चालू दस्तावेज़ में उपयोगकर्ता के चुने गए विकल्प को सेट करता है.

ज़्यादा जानकारी के साथ दस्तावेज़

addBookmark(position)

दिए गए Position में एक Bookmark जोड़ता है.

// 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('abc123456');

// Gets the document 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());

}

पैरामीटर

नाम	Type	ब्यौरा
position	Position	नए बुकमार्क की जगह.

रिटर्न

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

अनुमति देना

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

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

---

addEditor(emailAddress)

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

पैरामीटर

नाम	Type	ब्यौरा
emailAddress	String	जोड़ने के लिए उपयोगकर्ता का ईमेल पता.

रिटर्न

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

अनुमति देना

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

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

---

addEditor(user)

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

पैरामीटर

नाम	Type	ब्यौरा
user	User	जोड़े जाने वाले उपयोगकर्ता का इलस्ट्रेशन.

रिटर्न

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

अनुमति देना

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

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

---

addEditors(emailAddresses)

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

पैरामीटर

नाम	Type	ब्यौरा
emailAddresses	String[]	जोड़े जाने वाले उपयोगकर्ताओं के ईमेल पतों की कैटगरी.

रिटर्न

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

अनुमति देना

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

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

---

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('abc123456');

// Adds a footer to the document.
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()

अगर कोई दस्तावेज़ मौजूद नहीं है, तो हेडर सेक्शन को जोड़ा जाता है.

// 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('abc123456');

// Adds a header to the document.
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 जोड़ने के बाद, आप इसमें बदलाव नहीं कर सकते, आप इसे सिर्फ़ हटा सकते हैं.

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

// Creates a named range that includes every table in the document.
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.addNamedRange('Document tables', rangeBuilder.build());

पैरामीटर

नाम	Type	ब्यौरा
name	String	रेंज का नाम, जो अलग होना ज़रूरी नहीं है. रेंज के नाम 1 से 256 वर्णों के बीच होने चाहिए.
range	Range	नाम के साथ जोड़ने के लिए एलिमेंट की रेंज; यह रेंज मौजूदा चुनाव, खोज के नतीजे या मैन्युअल तरीके से newRange() का इस्तेमाल करके बनाई गई हो सकती है.

रिटर्न

NamedRange — NamedRange.

अनुमति देना

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

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

---

addViewer(emailAddress)

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

पैरामीटर

नाम	Type	ब्यौरा
emailAddress	String	जोड़ने के लिए उपयोगकर्ता का ईमेल पता.

रिटर्न

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

अनुमति देना

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

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

---

addViewer(user)

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

पैरामीटर

नाम	Type	ब्यौरा
user	User	जोड़े जाने वाले उपयोगकर्ता का इलस्ट्रेशन.

रिटर्न

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

अनुमति देना

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

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

---

addViewers(emailAddresses)

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

पैरामीटर

नाम	Type	ब्यौरा
emailAddresses	String[]	जोड़े जाने वाले उपयोगकर्ताओं के ईमेल पतों की कैटगरी.

रिटर्न

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

अनुमति देना

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

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

---

getAs(contentType)

मौजूदा 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('abc123456');

// 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());

पैरामीटर

नाम	Type	ब्यौरा
contentType	String	वह MIME टाइप जिसमें बदला जाना है. फ़िलहाल, यह सिर्फ़ 'application/pdf' के साथ काम करता है.

रिटर्न

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('abc123456');

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

रिटर्न

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

---

getBody()

सक्रिय दस्तावेज़ के Body को फिर से लाता है.

दस्तावेज़ में अलग-अलग तरह के सेक्शन हो सकते हैं (जैसे, 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('abc123456');

// Gets the document 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 मिलता है. अगर ऐसा कोई 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('abc123456');

// Gets the bookmark by its ID.
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.');
}

पैरामीटर

नाम	Type	ब्यौरा
id	String	Bookmark का आईडी.

रिटर्न

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

अनुमति देना

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

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

---

getBookmarks()

दस्तावेज़ के सभी Bookmark ऑब्जेक्ट दिखाता है.

// 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('abc123456');

// Gets all of the bookmarks in the document.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the document 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()

दस्तावेज़ का फ़ुटर सेक्शन मौजूद होने पर उसे फिर से लाता है.

// 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('abc123456');

// Gets the text of the document'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 एलिमेंट वापस लाता है.

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('abc123456');

// Gets the first footnote.
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()

दस्तावेज़ का हेडर सेक्शन मौजूद होने पर उसे फिर से लाता है.

// 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('abc123456');

// Gets the text of the document'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()

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

रिटर्न

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 मौजूद नहीं है, तो यह तरीका null दिखाता है. ज़रूरी नहीं कि नाम यूनीक हों; एक ही दस्तावेज़ में कई अलग-अलग रेंज का एक ही नाम हो सकता है, जो एचटीएमएल में क्लास वाली क्लास की तरह होता है. वहीं दूसरी ओर, दस्तावेज़ में आईडी यूनीक होते हैं, जैसे कि एचटीएमएल में मौजूद आईडी.

पैरामीटर

नाम	Type	ब्यौरा
id	String	रेंज का आईडी, जो दस्तावेज़ में यूनीक है

रिटर्न

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

अनुमति देना

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

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

---

getNamedRanges()

दस्तावेज़ के सभी NamedRange ऑब्जेक्ट दिखाता है.

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

रिटर्न

NamedRange[] — दस्तावेज़ में मौजूद NamedRange ऑब्जेक्ट का कलेक्शन, जिसमें एक ही नाम वाली कई रेंज शामिल हो सकती हैं

अनुमति देना

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

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

---

getNamedRanges(name)

दिए गए नाम वाले दस्तावेज़ के सभी NamedRange ऑब्जेक्ट दिखाता है. नाम ज़रूरी नहीं हैं. एक ही दस्तावेज़ में कई अलग-अलग रेंज में एक ही नाम हो सकता है. यह बिलकुल एचटीएमएल में बनी क्लास की तरह होता है. इसके उलट, दस्तावेज़ में आईडी यूनीक होते हैं, जैसे कि एचटीएमएल में आईडी.

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

पैरामीटर

नाम	Type	ब्यौरा
name	String	हो, जो ज़रूरी नहीं है कि

रिटर्न

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

---

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 के तौर पर दिखाया जाता है.

// Append a paragraph, 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);

पैरामीटर

नाम	Type	ब्यौरा
element	Element	वह एलिमेंट जिसमें नया Position शामिल होगा; यह Text एलिमेंट या Paragraph जैसा कोई कंटेनर एलिमेंट होना चाहिए
offset	Integer	Text एलिमेंट के लिए, Position से पहले के वर्णों की संख्या; दूसरे एलिमेंट के लिए, एक ही कंटेनर एलिमेंट में Position से पहले चाइल्ड एलिमेंट की संख्या

रिटर्न

Position — नया Position

अनुमति देना

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

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

---

newRange()

दस्तावेज़ एलिमेंट से Range ऑब्जेक्ट बनाने के लिए इस्तेमाल किया जाने वाला बिल्डर बनाता है.

// Change the user's selection to a range that includes every table in the document.
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 फ़ाइलों के लिए, इससे उपयोगकर्ता दर्शक की सूची से भी हट जाता है.

पैरामीटर

नाम	Type	ब्यौरा
emailAddress	String	जिस व्यक्ति को हटाना है उसका ईमेल पता.

रिटर्न

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

अनुमति देना

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

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

---

removeEditor(user)

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

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

पैरामीटर

नाम	Type	ब्यौरा
user	User	जिस उपयोगकर्ता को हटाना है उसके बारे में जानकारी.

रिटर्न

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

अनुमति देना

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

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

---

removeViewer(emailAddress)

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

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

पैरामीटर

नाम	Type	ब्यौरा
emailAddress	String	जिस व्यक्ति को हटाना है उसका ईमेल पता.

रिटर्न

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

अनुमति देना

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

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

---

removeViewer(user)

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

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

पैरामीटर

नाम	Type	ब्यौरा
user	User	जिस उपयोगकर्ता को हटाना है उसके बारे में जानकारी.

रिटर्न

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

---

setCursor(position)

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

// Append a paragraph, 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);

पैरामीटर

नाम	Type	ब्यौरा
position	Position	कर्सर की नई जगह

रिटर्न

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

अनुमति देना

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

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

---

setLanguage(languageCode)

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

पैरामीटर

नाम	Type	ब्यौरा
languageCode	String	भाषा कोड.

रिटर्न

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

अनुमति देना

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

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

---

setName(name)

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

पैरामीटर

नाम	Type	ब्यौरा
name	String	नए दस्तावेज़ का टाइटल

रिटर्न

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

अनुमति देना

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

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

---

setSelection(range)

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

// Change the user's selection to a range that includes every table in the document.
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());

पैरामीटर

नाम	Type	ब्यौरा
range	Range	चुनने के लिए एलिमेंट की नई रेंज

रिटर्न

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

अनुमति देना

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

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