일괄 요청

이 문서에서는 API 호출을 일괄 처리하여 클라이언트가 수행해야 하는 연결 수를 줄이는 방법을 보여줍니다. 일괄 처리를 사용하면 네트워크 왕복을 줄이고 처리량을 늘려 애플리케이션의 효율성을 개선할 수 있습니다.

개요

클라이언트가 만드는 각 연결에 일정량의 오버헤드가 발생합니다. Google Slides API는 클라이언트에서 여러 요청 객체를 실행할 수 있도록 일괄 처리를 지원합니다. 각 객체는 실행할 단일 유형의 요청을 단일 일괄 요청으로 지정합니다. 일괄 요청은 여러 하위 요청을 서버에 대한 단일 호출로 결합하여 단일 응답을 다시 검색함으로써 성능을 높일 수 있습니다.

사용자는 여러 개의 요청을 항상 함께 일괄 처리하는 것이 좋습니다. 다음은 일괄 처리를 사용할 수 있는 상황의 예입니다.

  • 이제 막 API를 사용하기 시작했고 업로드할 데이터가 많습니다.
  • 여러 객체에서 메타데이터 또는 속성(예: 서식 지정)을 업데이트해야 합니다.
  • 여러 객체를 삭제해야 합니다.

한도, 승인, 종속 항목 고려사항

다음은 일괄 업데이트를 사용할 때 고려해야 할 기타 항목의 목록입니다.

  • 모든 하위 요청을 포함한 각 일괄 요청은 사용량 한도 계산 시 API 요청 1회로 집계됩니다.
  • 일괄 요청은 한 번 인증됩니다. 이 단일 인증은 요청의 모든 일괄 업데이트 객체에 적용됩니다.
  • 서버는 일괄 요청에 표시된 것과 동일한 순서로 하위 요청을 처리합니다. 이후 하위 요청은 이전 하위 요청 중에 실행한 작업에 따라 달라질 수 있습니다. 예를 들어 동일한 일괄 요청에서 사용자는 기존 문서에 텍스트를 삽입한 다음 스타일을 지정할 수 있습니다.

일괄 처리 세부정보

일괄 요청은 프레젠테이션 추가 및 서식을 지정하는 등의 여러 하위 요청이 있는 하나의 batchUpdate 메서드 호출로 구성됩니다.

각 요청은 검증 후 적용됩니다. 일괄 업데이트의 모든 하위 요청은 원자적으로 적용됩니다. 즉, 유효하지 않은 요청이 있으면 전체 업데이트가 실패하고 종속될 수 있는 변경사항이 적용되지 않습니다.

일부 요청은 적용된 요청에 대한 정보를 응답과 함께 제공합니다. 예를 들어 객체 추가에 대한 모든 일괄 업데이트 요청은 응답을 반환하므로 ID 또는 제목과 같이 새로 추가된 객체의 메타데이터에 액세스할 수 있습니다.

이 방법을 사용하면 여러 하위 요청이 있는 하나의 API 일괄 업데이트 요청을 사용하여 전체 Google 문서를 빌드할 수 있습니다.

일괄 요청의 형식

요청은 하나의 필수 속성(requests)과 여러 중첩된 하위 요청이 포함된 단일 JSON 요청입니다. 요청은 개별 요청의 배열로 구성됩니다. 각 요청은 JSON을 사용하여 요청 객체를 나타내고 해당 속성을 포함합니다.

일괄 응답의 형식

일괄 요청의 응답 형식은 요청 형식과 유사합니다. 서버의 응답에는 단일 응답 객체의 전체 응답이 포함됩니다.

기본 JSON 객체의 속성 이름은 replies입니다. 응답은 배열로 반환되며, 요청 중 하나에 대한 각 응답은 해당 요청과 동일한 색인 순서를 차지합니다. 일부 요청에는 응답이 없으며 해당 배열 색인의 응답이 비어 있습니다.

예시

다음 코드 샘플은 Slides API에서 일괄 처리를 사용하는 방법을 보여줍니다.

요청

이 일괄 요청 예시는 다음 작업을 수행하는 방법을 보여줍니다.

  • CreateSlideRequest 메서드를 사용하여 insertionIndex 1로 presentations.pages 리소스를 기존 프레젠테이션에 추가합니다.

  • CreateShapeRequest 메서드를 사용하여 TEXT_BOX 유형의 shapeType를 새 슬라이드에 추가합니다.

  • InsertTextRequest 메서드를 사용하여 새 필드에 'Hello World' 텍스트를 삽입합니다.

{
   "requests":[
      {
         "createSlide":{
            "insertionIndex":1,
            "objectId":"newSlide"
         }
      },
      {
         "createShape":{
            "elementProperties":{
               "pageObjectId":"newSlide",
               "size":{
                  "height":{
                     "magnitude":50,
                     "unit":"PT"
                  },
                  "width":{
                     "magnitude":200,
                     "unit":"PT"
                  }
               }
            },
            "shapeType":"TEXT_BOX",
            "objectId":"newTextBox"
         }
      },
      {
         "insertText":{
            "objectId":"newTextBox",
            "text":"Hello World"
         }
      }
   ]
}

대답

이 일괄 응답 예시는 일괄 요청 내의 각 하위 요청이 어떻게 적용되었는지에 대한 정보를 표시합니다. InsertTextRequest 메서드에는 응답이 포함되어 있지 않으므로 [2]에 있는 배열의 색인 값은 빈 중괄호로 구성됩니다. 일괄 요청은 쓰기 요청이 실행된 방법을 보여주는 WriteControl 속성을 표시합니다.

{
   "requiredRevisionId": ID
   "presentationId": "",
   "replies":[
      {
         "createSlide":{
            "objectId":"newSlide"
         }
      },
      {
         "createShape":{
            "objectId":"newTextBox"
         }
      },
      {
         
      }
   ],
   "writeControl":{
      "requiredRevisionId": REVISION_ID
   }
}