이 문서에서는 API 호출을 일괄 처리하여 클라이언트가 연결해야 하는 연결 수를 줄이는 방법을 보여줍니다. 일괄 처리를 사용하면 네트워크 왕복 횟수를 줄이고 처리량을 늘려 애플리케이션의 효율성을 높일 수 있습니다.
개요
클라이언트가 만드는 각 연결에는 어느 정도의 오버헤드가 수반됩니다. Google Docs API는 일괄 처리를 지원하므로 클라이언트가 실행할 요청 유형을 각각 지정하는 여러 요청 객체를 단일 일괄 요청에 배치할 수 있습니다. 일괄 요청은 여러 하위 요청을 단일 서버 호출로 결합하여 단일 응답을 다시 가져와 성능을 향상시킬 수 있습니다.
항상 여러 요청을 한 번에 일괄 처리하는 것이 좋습니다. 다음은 일괄 처리를 사용할 수 있는 상황의 몇 가지 예입니다.
API를 이제 막 사용하기 시작했고 업로드할 데이터가 많습니다.
여러 객체에서 메타데이터 또는 속성(예: 서식)을 업데이트해야 합니다.
많은 객체를 삭제해야 합니다.
한도, 승인, 종속 항목 고려사항
다음은 일괄 업데이트를 사용할 때 고려해야 할 기타 항목 목록입니다.
모든 하위 요청을 포함한 각 일괄 요청은 사용량 한도에 대해 하나의 API 요청으로 집계됩니다.
일괄 요청은 한 번 인증됩니다. 이 단일 인증은 요청의 모든 일괄 업데이트 객체에 적용됩니다.
서버는 하위 요청을 일괄 요청에 표시된 순서와 동일하게 처리합니다. 후속 하위 요청은 이전 하위 요청 중에 취해진 작업에 종속될 수 있습니다. 예를 들어 동일한 일괄 요청에서 사용자는 기존 문서에 텍스트를 삽입한 후 스타일을 지정할 수 있습니다.
일괄 처리 세부정보
일괄 요청은 문서를 추가한 다음 서식을 지정하는 등의 여러 하위 요청이 포함된 하나의 batchUpdate 메서드 호출로 구성됩니다.
각 요청은 적용되기 전에 검증됩니다. 일괄 업데이트의 모든 하위 요청은 원자적으로 적용됩니다. 즉, 요청이 유효하지 않으면 전체 업데이트가 실패하고 (잠재적으로 종속된) 변경사항이 적용되지 않습니다.
일부 요청은 적용된 요청에 관한 정보가 포함된 응답을 제공합니다. 예를 들어 객체를 추가하기 위한 모든 일괄 업데이트 요청은 응답을 반환하므로 새로 추가된 객체의 메타데이터(예: ID 또는 제목)에 액세스할 수 있습니다.
이 접근 방식을 사용하면 여러 하위 요청이 포함된 하나의 API 일괄 업데이트 요청을 사용하여 전체 Google 문서를 빌드할 수 있습니다.
일괄 요청의 형식
요청은 하나의 필수 속성인 requests이 있는 중첩된 여러 하위 요청을 포함하는 단일 JSON 요청입니다. 요청은 개별 요청 배열로 구성됩니다. 각 요청은 JSON을 사용하여 요청 객체를 나타내고 속성을 포함합니다.
일괄 응답의 형식
일괄 요청의 응답 형식은 요청 형식과 유사합니다. 서버의 응답에는 단일 응답 객체의 전체 답글이 포함됩니다.
기본 JSON 객체의 속성 이름은 replies입니다. 응답은 배열로 반환되며, 요청 중 하나에 대한 각 응답은 해당 요청과 동일한 색인 순서를 차지합니다. 일부 요청에는 응답이 없으며 해당 배열 색인의 응답은 비어 있습니다.
예
다음 코드 샘플은 Docs API에서 일괄 처리를 사용하는 방법을 보여줍니다.
요청
이 일괄 요청 예에서는 다음을 수행하는 방법을 보여줍니다.
InsertTextRequest를 사용하여 기존 문서의 시작 부분에 'Hello World' 텍스트를 삽입하고 색인 location를 1로 설정합니다.
UpdateTextStyleRequest를 사용하여 'Hello'라는 단어를 업데이트합니다. startIndex 및 endIndex는 세그먼트 내에서 형식이 지정된 텍스트의 range를 정의합니다.
textStyle를 사용하여 'Hello'라는 단어의 글꼴 스타일을 굵게, 색상을 파란색으로 설정합니다.
TAB_ID 및 REQUIRED_REVISION_ID를 쓰기 요청이 적용되는 문서의 탭 ID 및 버전 ID로 각각 바꿉니다.
응답
이 일괄 응답 예시에는 일괄 요청 내 각 하위 요청이 적용된 방식에 관한 정보가 표시됩니다. InsertTextRequest 또는 UpdateTextStyleRequest에는 응답이 포함되어 있지 않으므로 [0] 및 [1] 의 배열 색인 값은 빈 중괄호로 구성됩니다. 일괄 요청에는 요청이 실행된 방식을 보여주는 WriteControl 객체가 표시됩니다.
[[["이해하기 쉬움","easyToUnderstand","thumb-up"],["문제가 해결됨","solvedMyProblem","thumb-up"],["기타","otherUp","thumb-up"]],[["필요한 정보가 없음","missingTheInformationINeed","thumb-down"],["너무 복잡함/단계 수가 너무 많음","tooComplicatedTooManySteps","thumb-down"],["오래됨","outOfDate","thumb-down"],["번역 문제","translationIssue","thumb-down"],["샘플/코드 문제","samplesCodeIssue","thumb-down"],["기타","otherDown","thumb-down"]],["최종 업데이트: 2025-08-01(UTC)"],[],[],null,["This document shows how to batch API calls together to reduce the number of\nconnections your client has to make. Batching can improve an application's\nefficiency by decreasing network round trips and increasing throughput.\n\nOverview\n\n\nEach connection your client makes results in a certain amount of overhead.\nThe Google Docs API supports batching to let your client place multiple\nrequest objects, each one specifying a single type of request to perform,\ninto a single batch request. A batch request can boost performance by\ncombining multiple subrequests into a single call to the server, retrieving\na single response back.\n\n\nWe encourage users to always batch multiple requests together. Here are some\nexamples of situations where you can use batching:\n\n- You've just started using the API and you have lots of data to upload.\n- You need to update metadata or properties, such as formatting, on multiple objects.\n- You need to delete many objects.\n\nLimits, authorization, \\& dependency considerations\n\nHere's a list of other items to consider when employing batch updating:\n\n- Each batch request, including all subrequests, is counted as one API request toward your [usage limit](/workspace/docs/api/limits).\n- A batch request is authenticated once. This single authentication applies to all batch update objects in the request.\n- The server processes the subrequests in the same order they appear in the batch request. Latter subrequests can depend on actions taken during earlier subrequests. For example, in the same batch request, users can insert text into an existing document and then style it.\n\nBatch details\n\n\nA batch request consists of one [batchUpdate](/workspace/docs/api/reference/rest/v1/documents/batchUpdate) method call\nwith multiple subrequests to, for example, add and then format a document.\n\n\nEach request is validated before being applied. All subrequests in the batch\nupdate are applied atomically. That is, if any request is not valid then the\nentire update is unsuccessful and none of the (potentially dependent)\nchanges are applied.\n\n\nSome requests provide responses with information about the applied requests.\nFor example, all batch update requests to add objects return responses so\nyou can access the metadata of the newly added object, such as the ID or\ntitle.\n\n\nWith this approach, you can build an entire Google document using one API\nbatch update request with multiple subrequests.\n\nFormat of a batch request\n\n\nA [request](/workspace/docs/api/reference/rest/v1/documents/request) is a single JSON request containing multiple,\nnested subrequests with one required property: `requests`. The\nrequests are constructed in an array of individual requests. Each request uses\nJSON to represent the request object and to contain its properties.\n\nFormat of a batch response\n\n\nThe [response](/workspace/docs/api/reference/rest/v1/documents/response) format for a batch request is similar to the\nrequest format. The server's response contains a complete reply of the single\nresponse object.\n\n\nThe main JSON object's property is named `replies`. The responses\nare returned in an array, with each response to one of the requests occupying\nthe same index order as the corresponding request. Some requests don't have\nresponses and the response at that array index is empty.\n\nExample\n\nThe following code sample shows the use of batching with the Docs API.\n\nRequest\n\nThis example batch request demonstrates how to:\n\n- Insert \"Hello World\" text into the start of an existing document, with an\n index `location` of `1`, using the\n [`InsertTextRequest`](/workspace/docs/api/reference/rest/v1/documents/request#inserttextrequest).\n\n- Update the word \"Hello\" using the\n [`UpdateTextStyleRequest`](/workspace/docs/api/reference/rest/v1/documents/request#updatetextstylerequest).\n The `startIndex` and `endIndex` define the `range` of formatted text within\n the segment.\n\n- Using `textStyle`, set the font style to bold and the color to blue for just\n the word \"Hello\".\n\n- Using the [`WriteControl`](/workspace/docs/api/reference/rest/v1/documents/batchUpdate#writecontrol)\n field, you can control how write requests are executed. For more\n information, see [Establish state consistency with\n WriteControl](/workspace/docs/api/how-tos/best-practices#establish-state-consistency).\n\n```verilog\n{\n \"requests\":[\n {\n \"insertText\":{\n \"location\":{\n \"index\":1,\n \"tabId\":TAB_ID\n },\n \"text\":\"Hello World\"\n }\n },\n {\n \"updateTextStyle\":{\n \"range\":{\n \"startIndex\":1,\n \"endIndex\":6\n },\n \"textStyle\":{\n \"bold\":true,\n \"foregroundColor\":{\n \"color\":{\n \"rgbColor\":{\n \"blue\":1\n }\n }\n }\n },\n \"fields\":\"bold,foreground_color\"\n }\n }\n ],\n \"writeControl\": {\n \"requiredRevisionId\": \"\u003cvar translate=\"no\"\u003eREQUIRED_REVISION_ID\u003c/var\u003e\"\n }\n}\n```\n\nReplace \u003cvar translate=\"no\"\u003eTAB_ID\u003c/var\u003e and \u003cvar translate=\"no\"\u003eREQUIRED_REVISION_ID\u003c/var\u003e with\nthe tab ID and the revision ID, respectively, of the document the write request\nis applied to.\n\nResponse\n\nThis example batch response displays information on how each subrequest within\nthe batch request was applied. Neither the\n[`InsertTextRequest`](/workspace/docs/api/reference/rest/v1/documents/request#InsertTextRequest)\nor the\n[`UpdateTextStyleRequest`](/workspace/docs/api/reference/rest/v1/documents/request#updatetextstylerequest)\ncontain a response, so the index values of the array at \\[0\\] and \\[1\\] consist\nof empty curly braces. The batch request displays the `WriteControl` object,\nwhich shows how the requests were executed. \n\n```mysql\n{\n \"replies\":[\n {},\n {}\n ],\n \"writeControl\":{\n \"requiredRevisionId\":`\u003cvar translate=\"no\"\u003eREQUIRED_REVISION_ID\u003c/var\u003e`\n },\n \"documentId\":`\u003cvar translate=\"no\"\u003eDOCUMENT_ID\u003c/var\u003e`\n}\n```\n\nRelated topics\n\n- [Best practices for best results](/workspace/docs/api/how-tos/best-practices)"]]
