Method: documents.batchUpdate

ডকুমেন্টে এক বা একাধিক আপডেট প্রয়োগ করে।

প্রয়োগ করার আগে প্রতিটি request যাচাই করা হয়। কোনও অনুরোধ সঠিক না হলে, সম্পূর্ণ অনুরোধটি বাতিল হয়ে যাবে এবং কিছুই প্রয়োগ করা হবে না।

কিছু অনুরোধে replies থাকে, যাতে সেগুলি কীভাবে প্রয়োগ করা হয় সেই সম্পর্কে আপনাকে কিছু তথ্য দেওয়া যায়। অন্যান্য অনুরোধের ক্ষেত্রে কোনও তথ্য রিটার্ন করার প্রয়োজন নেই; এগুলির প্রত্যেকটি একটি ফাঁকা উত্তর রিটার্ন করে। অনুরোধের ক্রমের সাথে উত্তরের ক্রম মিলে যায়।

যেমন, ধরুন আপনি চারটি আপডেট সহ batchUpdate কল করেছেন এবং শুধুমাত্র তৃতীয়টি তথ্য রিটার্ন করেছে। উত্তরটিতে দুটি খালি উত্তর, তৃতীয় অনুরোধের উত্তর এবং আরেকটি খালি উত্তর থাকবে, এই ক্রমে।

অন্যান্য ব্যবহারকারী ডকুমেন্ট এডিট করতে পারেন বলে, ডকুমেন্টটি আপনার করা পরিবর্তনগুলি সঠিকভাবে নাও দেখাতে পারে: আপনার করা পরিবর্তনগুলি সহযোগীর করা পরিবর্তনের সাথে সাথে পরিবর্তিত হতে পারে। কোনও সহযোগী না থাকলে, ডকুমেন্টে আপনার করা পরিবর্তন দেখা যাবে। যাই হোক না কেন, আপনার অনুরোধে করা আপডেটগুলি একসাথে অ্যাটমিক উপায়ে প্রয়োগ করা হবে।

HTTP অনুরোধ

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

URL-এ gRPC ট্রান্সকোডিং সিনট্যাক্স ব্যবহার করা হয়।

পাথ প্যারামিটার

প্যারামিটারগুলি
documentId

string

আপডেট করার জন্য ডকুমেন্টের আইডি।

অনুরোধের বডি

অনুরোধের বডিতে নিম্নলিখিত স্ট্রাকচার সহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
ফিল্ড
requests[]

object (Request)

ডকুমেন্টে প্রয়োগ করার জন্য আপডেটের তালিকা।
writeControl

object (WriteControl)

রাইট রিকোয়েস্ট কীভাবে এক্সিকিউট করা হবে তা নিয়ন্ত্রণ করে।

প্রতিক্রিয়ার বডি

documents.batchUpdate অনুরোধ থেকে পাওয়া উত্তর মেসেজ।

সফল হলে, প্রতিক্রিয়ার বডিতে নিচে উল্লেখ করা স্ট্রাকচার সহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  },
  "suggestionResponses": [
    {
      object (SuggestionResponse)
    }
  ],
  "commentUpdateState": enum (CommentUpdateState)
}
ফিল্ড
documentId

string

যে ডকুমেন্টে আপডেট প্রয়োগ করা হয়েছে সেটির আইডি।
replies[]

object (Response)

আপডেটের উত্তর। এটি আপডেটের সাথে ১:১ ম্যাপ করে, যদিও কিছু অনুরোধের উত্তর খালি থাকতে পারে।
writeControl

object (WriteControl)

অনুরোধ প্রয়োগ করার পরে আপডেট করা রাইট কন্ট্রোল।
suggestionResponses[]

object (SuggestionResponse)

প্রতিটি আপডেটের ফলে প্রভাবিত হওয়া সাজেশন। এটি আপডেটের সাথে ১:১ ম্যাপ করে।
commentUpdateState

enum (CommentUpdateState)

ব্যাচ অনুরোধে কমেন্ট আপডেট প্রয়োগ করা হয়েছে কিনা।

অনুমোদনের স্কোপ

নিম্নলিখিত OAuth স্কোপের মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

আরও তথ্যের জন্য, অনুমোদন সংক্রান্ত নির্দেশিকা দেখুন।

WriteControl

রাইট রিকোয়েস্ট কীভাবে এক্সিকিউট করা হবে তা নিয়ন্ত্রণ করে।

JSON উপস্থাপনা 
{
  "writeMode": enum (WriteMode),

  "requiredRevisionId": string,
  "targetRevisionId": string
}
ফিল্ড
writeMode

enum (WriteMode)

ডকুমেন্টে কীভাবে অনুরোধের আপডেট প্রয়োগ করতে হবে।

উল্লেখ না করা থাকলে, অনুরোধের আপডেটগুলি সাধারণ এডিট হিসেবে প্রয়োগ করা হবে।
কোন ডকুমেন্টের কোন রিভিশনে লিখতে হবে এবং সেই রিভিশনটি ডকুমেন্টের বর্তমান রিভিশন না হলে অনুরোধটি কীভাবে আচরণ করবে তা নির্ধারণ করে। কোনও ফিল্ড নির্দিষ্ট করা না থাকলে, লেটেস্ট রিভিশনে আপডেট প্রয়োগ করা হয়। নিচে পারস্পরিকভাবে এক্সক্লুসিভ ফিল্ডের তালিকা দেওয়া হল। কোনও উত্তরে সর্বাধিক একটি ফিল্ড সেট করা হবে:
requiredRevisionId

string

যে ডকুমেন্টে লেখার অনুরোধ প্রয়োগ করা হয়েছে তার ঐচ্ছিক revision ID। এটি ডকুমেন্টের লেটেস্ট রিভিশন না হলে, অনুরোধ প্রসেস করা হয় না এবং 400 ভুল অনুরোধ সংক্রান্ত সমস্যা দেখানো হয়।

উত্তরে প্রয়োজনীয় রিভিশন আইডি ফেরত দেওয়া হলে, এটি অনুরোধ প্রয়োগ করার পরে ডকুমেন্টের রিভিশন আইডি নির্দেশ করে।
targetRevisionId

string

রাইট অনুরোধ প্রয়োগ করা হয়েছে এমন ডকুমেন্টের ঐচ্ছিক টার্গেট revision ID।

API ব্যবহার করে ডকুমেন্ট পড়ার পরে যদি কোনও সহযোগী পরিবর্তন করে থাকেন, তাহলে এই লেখার অনুরোধের মাধ্যমে করা পরিবর্তনগুলি সহযোগীর করা পরিবর্তনের উপর প্রয়োগ করা হয়। এর ফলে ডকুমেন্টের একটি নতুন রিভিশন তৈরি হয় যাতে সহযোগী ও অনুরোধে করা পরিবর্তনগুলি অন্তর্ভুক্ত থাকে এবং Docs সার্ভার পরস্পরবিরোধী পরিবর্তনগুলি সমাধান করে দেয়। টার্গেট রিভিশন আইডি ব্যবহার করার সময়, API ক্লায়েন্টকে ডকুমেন্টটির আরেকজন কোলাবোরেটর হিসেবে বিবেচনা করা যেতে পারে।

টার্গেট রিভিশন আইডি শুধুমাত্র কোনও ডকুমেন্টের সাম্প্রতিক ভার্সনে লেখার জন্য ব্যবহার করা যেতে পারে। টার্গেট করা রিভিশন যদি লেটেস্ট রিভিশনের থেকে অনেক পুরনো হয়, তাহলে অনুরোধ প্রসেস করা হয় না এবং 400 ত্রুটিপূর্ণ অনুরোধ সংক্রান্ত সমস্যা দেখানো হয়। ডকুমেন্টের লেটেস্ট ভার্সন রিকভার করার পরে আবার অনুরোধ করা উচিত। সাধারণত, কোনও রিভিশন আইডি পড়ার পরে সেটি কয়েক মিনিট ধরে টার্গেট রিভিশন হিসেবে ব্যবহার করা যায়, তবে ঘন ঘন এডিট করা ডকুমেন্টের ক্ষেত্রে এই সময়সীমা কম হতে পারে।
পারস্পরিকভাবে এক্সক্লুসিভ ফিল্ডের শেষ।

WriteMode

ডকুমেন্টে কীভাবে অনুরোধ আপডেট প্রয়োগ করা হবে তা নির্ধারণ করে।

Enums
WRITE_MODE_UNSPECIFIED রাইট মোড নির্দিষ্ট করা নেই। ডিফল্ট হিসেবে EDIT আচরণ সেট করা থাকে।
EDIT সাধারণ এডিট হিসেবে সব আপডেট প্রয়োগ করুন।
SUGGEST সাজেশন হিসেবে সব আপডেট প্রয়োগ করুন।

SuggestionResponse

প্রদত্ত আপডেটের ফলে প্রভাবিত হওয়া সাজেশন।

JSON উপস্থাপনা 
{
  "createdSuggestionIds": [
    string
  ],
  "updatedSummarySuggestionIds": [
    string
  ],
  "deletedSuggestionIds": [
    string
  ],
  "acceptedSuggestionIds": [
    string
  ],
  "rejectedSuggestionIds": [
    string
  ]
}
ফিল্ড
createdSuggestionIds[]

string

আপডেট চলাকালীন তৈরি হওয়া সাজেশনের আইডি।
updatedSummarySuggestionIds[]

string

আপডেট চলাকালীন যেসব সাজেশনের সারসংক্ষেপ আপডেট করা হয়েছে সেগুলির আইডি।
deletedSuggestionIds[]

string

আপডেট চলাকালীন মুছে দেওয়া সাজেশনগুলির আইডি।
acceptedSuggestionIds[]

string

আপডেট চলাকালীন গ্রহণ করা সাজেশনের আইডি।
rejectedSuggestionIds[]

string

আপডেট চলাকালীন বাতিল করা সাজেশনের আইডি।

CommentUpdateState

ব্যাচ অনুরোধে কমেন্ট আপডেটের স্ট্যাটাস।

Enums
COMMENT_UPDATE_STATE_UNSPECIFIED কমেন্ট আপডেট সংক্রান্ত স্ট্যাটাস উল্লেখ করা নেই।
NO_UPDATES_REQUESTED ব্যাচ অনুরোধে কোনও কমেন্ট আপডেট করার অনুরোধ করা হয়নি।
ALL_SAVED অনুরোধ করা সব কমেন্ট আপডেট ব্যাচ অনুরোধে প্রয়োগ করা হয়েছে।
ALL_FAILED_UNKNOWN_REASON কমেন্ট আপডেট করার জন্য করা সব অনুরোধ ব্যর্থ হয়েছে।