Google Docs API を使用すると、名前付き範囲を使用して一部の編集タスクを簡素化できます。
名前付き範囲を作成すると、後で参照できるドキュメントのセクションを指定できます。名前付き範囲のインデックスは、ドキュメントにコンテンツが追加または削除されると自動的に更新されます。これにより、編集変更を追跡したり、ドキュメント内を検索したりする必要がないため、将来更新するテキストを見つけやすくなります。代わりに、名前付き範囲を読み取り、そのインデックスを使用して編集位置を取得できます。
たとえば、ドキュメントに「商品説明」という文字列が表示される名前付き範囲を作成するとします。
これにより、説明を置き換えることができます。名前付き範囲の開始インデックスと終了インデックスを取得し、それらのインデックス間のテキストを新しいコンテンツに更新します。
次のサンプルコードは、ドキュメントの最初のタブにある名前付き範囲の内容を置き換えるヘルパー関数を実装する方法を示しています。この名前付き範囲は、以前に CreateNamedRangeRequest
を使用して作成されています。すべてのタブの名前付き範囲を置き換えるには、このコードを拡張してすべてのタブを反復処理します。詳細とサンプルコードについては、タブを操作するをご覧ください。
/** 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(); }
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()
名前付き範囲はドキュメント コンテンツの範囲を指定しますが、そのコンテンツの一部ではありません。名前付き範囲を含むコンテンツを抽出して別の場所に挿入すると、名前付き範囲は元のコンテンツのみを指し、重複するセクションは指しません。