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

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

রাইটকন্ট্রোল

রাইট রিকোয়েস্টগুলো কীভাবে কার্যকর করা হবে, তার ওপর নিয়ন্ত্রণ প্রদান করে।

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

  "requiredRevisionId": string,
  "targetRevisionId": string
}
ক্ষেত্র
writeMode

enum ( WriteMode )

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

অনির্দিষ্ট থাকলে, অনুরোধের আপডেটগুলি সাধারণ সম্পাদনা হিসাবে প্রয়োগ করা হবে।

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

string

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

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

targetRevisionId

string

যে ডকুমেন্টের উপর লেখার অনুরোধটি প্রয়োগ করা হয়, তার ঐচ্ছিক টার্গেট revision ID ।

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

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

রাইটমোড

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

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

পরামর্শ প্রতিক্রিয়া

যে পরামর্শগুলো একটি নির্দিষ্ট আপডেটের দ্বারা প্রভাবিত হয়েছিল।

JSON উপস্থাপনা 
{
  "createdSuggestionIds": [
    string
  ],
  "updatedSummarySuggestionIds": [
    string
  ],
  "deletedSuggestionIds": [
    string
  ],
  "acceptedSuggestionIds": [
    string
  ],
  "rejectedSuggestionIds": [
    string
  ]
}
ক্ষেত্র
createdSuggestionIds[]

string

আপডেটের সময় তৈরি হওয়া সাজেশনগুলোর আইডি।

updatedSummarySuggestionIds[]

string

সেইসব সাজেশনের আইডি, যাদের সারাংশ আপডেটের সময় হালনাগাদ করা হয়েছিল।

deletedSuggestionIds[]

string

আপডেটের সময় মুছে ফেলা সাজেশনগুলোর আইডি।

acceptedSuggestionIds[]

string

আপডেটের সময় গৃহীত পরামর্শগুলোর আইডি।

rejectedSuggestionIds[]

string

আপডেটের সময় প্রত্যাখ্যাত হওয়া পরামর্শগুলোর আইডি।

মন্তব্য আপডেট অবস্থা

ব্যাচ অনুরোধে মন্তব্যের অবস্থা আপডেট হয়।

এনাম
COMMENT_UPDATE_STATE_UNSPECIFIED মন্তব্য আপডেটের অবস্থা অনির্দিষ্ট।
NO_UPDATES_REQUESTED ব্যাচ অনুরোধে কোনো মন্তব্য হালনাগাদের অনুরোধ করা হয়নি।
ALL_SAVED অনুরোধকৃত সকল মন্তব্য আপডেট ব্যাচ অনুরোধের মাধ্যমে প্রয়োগ করা হয়েছে।
ALL_FAILED_UNKNOWN_REASON অনুরোধ করা সমস্ত মন্তব্য আপডেট ব্যর্থ হয়েছে।