일괄 요청

이 문서에서는 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'라는 단어의 글꼴 스타일을 굵게, 색상을 파란색으로 설정합니다.

  • WriteControl 필드를 사용하면 쓰기 요청이 실행되는 방식을 제어할 수 있습니다. 자세한 내용은 WriteControl로 상태 일관성 설정을 참고하세요.

{
   "requests":[
      {
         "insertText":{
            "location":{
               "index":1,
               "tabId":TAB_ID
            },
            "text":"Hello World"
         }
      },
      {
         "updateTextStyle":{
            "range":{
               "startIndex":1,
               "endIndex":6
            },
            "textStyle":{
               "bold":true,
               "foregroundColor":{
                  "color":{
                     "rgbColor":{
                        "blue":1
                     }
                  }
               }
            },
            "fields":"bold,foreground_color"
         }
      }
   ],
   "writeControl": {
      "requiredRevisionId": "REQUIRED_REVISION_ID"
  }
}

TAB_ID 및 REQUIRED_REVISION_ID를 쓰기 요청이 적용되는 문서의 탭 ID와 버전 ID로 각각 바꿉니다.

응답

이 일괄 응답 예시에는 일괄 요청 내 각 하위 요청이 적용된 방식에 관한 정보가 표시됩니다. InsertTextRequest 또는 UpdateTextStyleRequest에는 응답이 포함되어 있지 않으므로 [0] 및 [1] 의 배열 색인 값은 빈 중괄호로 구성됩니다. 일괄 요청에는 요청이 실행된 방식을 보여주는 WriteControl 객체가 표시됩니다.

{
   "replies":[
      {},
      {}
   ],
   "writeControl":{
      "requiredRevisionId":`REQUIRED_REVISION_ID`
   },
   "documentId":`DOCUMENT_ID`
}