Interfejs API Dokumentów Google umożliwia korzystanie z zakresów nazwanych w celu uproszczenia niektórych zadań związanych z edycją.
Tworząc zakres nazwany, określasz część dokumentu, do której możesz się później odwoływać. Indeksy zakresu nazwanego są automatycznie aktualizowane w miarę dodawania i usuwania treści z dokumentu. Ułatwia to znajdowanie tekstu do zaktualizowania w przyszłości, ponieważ nie musisz śledzić zmian wprowadzonych w edytowaniu ani przeszukiwać dokumentu. Zamiast tego możesz uzyskać lokalizację edycji, odczytując zakres nazwany i używając jego indeksów.
Załóżmy na przykład, że tworzysz zakres nazwany, w którym w dokumencie musi występować ciąg znaków „opis produktu”:
Dzięki temu możesz zastąpić opis: wystarczy, że uzyskasz indeksy początkowy i końcowy zakresu o nazwie, a następnie zaktualizujesz tekst między tymi indeksami, podając nową treść.
Poniższy przykładowy kod pokazuje, jak zastosować funkcję pomocniczą, aby zastąpić zawartość zakresu nazwanego na pierwszej karcie dokumentu. Zakres nazwany został wcześniej utworzony za pomocą funkcji CreateNamedRangeRequest.
Aby zastąpić zakresy nazwane ze wszystkich kart, możesz rozszerzyć ten kod, aby przetwarzał wszystkie karty. Więcej informacji i kod przykładowy znajdziesz w artykule Praca z kartami.
Java
/** Replaces the text in existing named ranges. */
static void replaceNamedRange(Docs service, String documentId, String rangeName, String newText)
throws IOException {
// Fetch the document to determine the current indexes of the named ranges.
Document document =
service.documents().get(documentId).setIncludeTabsContent(true).execute();
// Find the matching named ranges in the first tab of the document.
NamedRanges namedRangeList =
document.getTabs()[0].getDocumentTab().getNamedRanges().get(rangeName);
if (namedRangeList == null) {
throw new IllegalArgumentException("The named range is no longer present in the document.");
}
// Determine all the ranges of text to be removed, and at which indexes the replacement text
// should be inserted.
List<Range> allRanges = new ArrayList<>();
Set<Integer> insertIndexes = new HashSet<>();
for (NamedRange namedRange : namedRangeList.getNamedRanges()) {
allRanges.addAll(namedRange.getRanges());
insertIndexes.add(namedRange.getRanges().get(0).getStartIndex());
}
// Sort the list of ranges by startIndex, in descending order.
allRanges.sort(Comparator.comparing(Range::getStartIndex).reversed());
// Create a sequence of requests for each range.
List<Request> requests = new ArrayList<>();
for (Range range : allRanges) {
// Delete all the content in the existing range.
requests.add(
new Request().setDeleteContentRange(new DeleteContentRangeRequest().setRange(range)));
if (insertIndexes.contains(range.getStartIndex())) {
// Insert the replacement text.
requests.add(
new Request()
.setInsertText(
new InsertTextRequest()
.setLocation(
new Location()
.setSegmentId(range.getSegmentId())
.setIndex(range.getStartIndex())
.setTabId(range.getTabId()))
.setText(newText)));
// Re-create the named range on the new text.
requests.add(
new Request()
.setCreateNamedRange(
new CreateNamedRangeRequest()
.setName(rangeName)
.setRange(
new Range()
.setSegmentId(range.getSegmentId())
.setStartIndex(range.getStartIndex())
.setEndIndex(range.getStartIndex() + newText.length())
.setTabId(range.getTabId()))));
}
}
// Make a batchUpdate request to apply the changes, ensuring the document hasn't changed since
// we fetched it.
BatchUpdateDocumentRequest batchUpdateRequest =
new BatchUpdateDocumentRequest()
.setRequests(requests)
.setWriteControl(new WriteControl().setRequiredRevisionId(document.getRevisionId()));
service.documents().batchUpdate(documentId, batchUpdateRequest).execute();
}
Python
def replace_named_range(service, document_id, range_name, new_text):
"""Replaces the text in existing named ranges."""
# Determine the length of the replacement text, as UTF-16 code units.
# https://developers.google.com/docs/api/concepts/structure#start_and_end_index
new_text_len = len(new_text.encode('utf-16-le')) / 2
# Fetch the document to determine the current indexes of the named ranges.
document = (
service.documents()
.get(documentId=document_id, includeTabsContent=True)
.execute()
)
# Find the matching named ranges in the first tab of the document.
named_range_list = (
document.get('tabs')[0]
.get('documentTab')
.get('namedRanges', {})
.get(range_name)
)
if not named_range_list:
raise Exception('The named range is no longer present in the document.')
# Determine all the ranges of text to be removed, and at which indices the
# replacement text should be inserted.
all_ranges = []
insert_at = {}
for named_range in named_range_list.get('namedRanges'):
ranges = named_range.get('ranges')
all_ranges.extend(ranges)
# Most named ranges only contain one range of text, but it's possible
# for it to be split into multiple ranges by user edits in the document.
# The replacement text should only be inserted at the start of the first
# range.
insert_at[ranges[0].get('startIndex')] = True
# Sort the list of ranges by startIndex, in descending order.
all_ranges.sort(key=lambda r: r.get('startIndex'), reverse=True)
# Create a sequence of requests for each range.
requests = []
for r in all_ranges:
# Delete all the content in the existing range.
requests.append({
'deleteContentRange': {
'range': r
}
})
segment_id = r.get('segmentId')
start = r.get('startIndex')
tab_id = r.get('tabId')
if insert_at[start]:
# Insert the replacement text.
requests.append({
'insertText': {
'location': {
'segmentId': segment_id,
'index': start,
'tabId': tab_id
},
'text': new_text
}
})
# Re-create the named range on the new text.
requests.append({
'createNamedRange': {
'name': range_name,
'range': {
'segmentId': segment_id,
'startIndex': start,
'endIndex': start + new_text_len,
'tabId': tab_id
}
}
})
# Make a batchUpdate request to apply the changes, ensuring the document
# hasn't changed since we fetched it.
body = {
'requests': requests,
'writeControl': {
'requiredRevisionId': document.get('revisionId')
}
}
service.documents().batchUpdate(documentId=document_id, body=body).execute()
Pamiętaj, że zakresy o nazwie określają zakres treści dokumentu, ale nie są częścią tych treści. Jeśli wyodrębnisz zawartość, która zawiera zakres nazwany, a potem wstawisz go w innym miejscu, zakres nazwany będzie wskazywał tylko oryginalną zawartość, a nie powieloną sekcję.