ওয়েবহুকের মাধ্যমে, অ্যাসিঙ্ক্রোনাস বা দীর্ঘ-চলমান অপারেশন (LRO) সম্পন্ন হলে জেমিনি এপিআই আপনার সার্ভারে রিয়েল-টাইম নোটিফিকেশন পাঠাতে পারে। এর ফলে স্ট্যাটাস আপডেটের জন্য এপিআই পোল করার প্রয়োজন হয় না, যা ল্যাটেন্সি এবং ওভারহেড কমিয়ে আনে।
CreateWebhook
একটি নতুন ওয়েবহুক তৈরি করে।
অনুরোধকারী শরীর
অনুরোধের মূল অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
ঐচ্ছিক। ব্যবহারকারীর দেওয়া ওয়েবহুকের নাম।
প্রয়োজনীয়। যে ইভেন্টগুলোতে ওয়েবহুকটি সাবস্ক্রাইব করা আছে। উপলব্ধ ইভেন্টসমূহ: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
সম্ভাব্য মানসমূহ:
-
batch.succeededব্যাচ প্রক্রিয়াকরণ সফলভাবে সম্পন্ন হয়েছে।
-
batch.expired৪৮ ঘণ্টার সময়সীমার মধ্যে ব্যাচটি প্রসেস করা হয়নি।
-
batch.failedব্যাচ জবটি ব্যর্থ হয়েছে।
-
interaction.requires_actionমিথস্ক্রিয়ার জন্য কোনো কাজ করার প্রয়োজন হয় (যেমন, ফাংশন কল করা)।
-
interaction.completedমিথস্ক্রিয়া সফলভাবে সম্পন্ন হয়েছে।
-
interaction.failedমিথস্ক্রিয়া ব্যর্থ হয়েছে।
-
video.generatedভিডিও তৈরি সম্পন্ন হয়েছে।
আবশ্যক। যে URI-তে ওয়েবহুক ইভেন্টগুলো পাঠানো হবে।
প্রতিক্রিয়া
সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
শুধুমাত্র আউটপুট। ওয়েবহুকটি তৈরি হওয়ার সময়কার টাইমস্ট্যাম্প।
শুধুমাত্র আউটপুট। ওয়েবহুকের আইডি।
ঐচ্ছিক। ব্যবহারকারীর দেওয়া ওয়েবহুকের নাম।
শুধুমাত্র আউটপুট। ওয়েবহুকের জন্য নতুন সাইনিং সিক্রেট। শুধুমাত্র তৈরির সময় পূরণ করা হয়।
signing_secrets অ্যারে (SigningSecret) (ঐচ্ছিক)
শুধুমাত্র আউটপুট। এই ওয়েবহুকের সাথে যুক্ত স্বাক্ষর করার গোপনীয় তথ্য।
ক্ষেত্র
শুধুমাত্র আউটপুট। স্বাক্ষর গোপনীয়তার মেয়াদ শেষ হওয়ার তারিখ।
শুধুমাত্র আউটপুট। স্বাক্ষর-গোপনীয়তার সংক্ষিপ্ত সংস্করণ।
শুধুমাত্র আউটপুট। ওয়েবহুকের অবস্থা।
সম্ভাব্য মানসমূহ:
-
enabledওয়েবহুকটি সক্রিয় করা হয়েছে।
-
disabledব্যবহারকারী ওয়েবহুকটি নিষ্ক্রিয় করেছেন।
-
disabled_due_to_failed_deliveriesডেলিভারি ব্যর্থ হওয়ায় ওয়েবহুকটি নিষ্ক্রিয় করা হয়েছে।
প্রয়োজনীয়। যে ইভেন্টগুলোতে ওয়েবহুকটি সাবস্ক্রাইব করা আছে। উপলব্ধ ইভেন্টসমূহ: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
সম্ভাব্য মানসমূহ:
-
batch.succeededব্যাচ প্রক্রিয়াকরণ সফলভাবে সম্পন্ন হয়েছে।
-
batch.expired৪৮ ঘণ্টার সময়সীমার মধ্যে ব্যাচটি প্রসেস করা হয়নি।
-
batch.failedব্যাচ জবটি ব্যর্থ হয়েছে।
-
interaction.requires_actionমিথস্ক্রিয়ার জন্য কোনো কাজ করার প্রয়োজন হয় (যেমন, ফাংশন কল করা)।
-
interaction.completedমিথস্ক্রিয়া সফলভাবে সম্পন্ন হয়েছে।
-
interaction.failedমিথস্ক্রিয়া ব্যর্থ হয়েছে।
-
video.generatedভিডিও তৈরি সম্পন্ন হয়েছে।
শুধুমাত্র আউটপুট। ওয়েবহুকটি সর্বশেষ আপডেট হওয়ার সময়কার টাইমস্ট্যাম্প।
আবশ্যক। যে URI-তে ওয়েবহুক ইভেন্টগুলো পাঠানো হবে।
উদাহরণ
উদাহরণ প্রতিক্রিয়া
{ "create_time": "string", "id": "string", "name": "string", "new_signing_secret": "string", "signing_secrets": [ { "expire_time": "string", "truncated_secret": "string" } ], "state": "enabled", "subscribed_events": [ "batch.succeeded" ], "update_time": "string", "uri": "string" }
পিংওয়েবহুক
একটি ওয়েবহুকে পিং ইভেন্ট পাঠায়।
পাথ / কোয়েরি প্যারামিটার
আবশ্যক। যে ওয়েবহুকটি পিং করতে হবে তার আইডি। ফরম্যাট: `{webhook_id}`
অনুরোধকারী শরীর
অনুরোধের মূল অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
প্রতিক্রিয়া
সফল হলে, প্রতিক্রিয়াটি খালি থাকে।
উদাহরণ
ঘোরানো স্বাক্ষর গোপনীয়তা
একটি ওয়েবহুকের জন্য একটি নতুন সাইনিং সিক্রেট তৈরি করে।
পাথ / কোয়েরি প্যারামিটার
আবশ্যক। যে ওয়েবহুকের জন্য সাইনিং সিক্রেট তৈরি করতে হবে, তার আইডি। ফরম্যাট: `{webhook_id}`
অনুরোধকারী শরীর
অনুরোধের মূল অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
ঐচ্ছিক। পূর্ববর্তী স্বাক্ষর গোপনীয়তা প্রত্যাহারের আচরণ।
সম্ভাব্য মানসমূহ:
-
revoke_previous_secrets_after_h24একটি নতুন সাইনিং সিক্রেট তৈরি করুন এবং ২৪ ঘণ্টা পর পূর্বের সমস্ত সিক্রেট বাতিল করুন। মাইগ্রেশনের জন্য এটিই ডিফল্ট এবং সবচেয়ে নিরাপদ বিকল্প।
-
revoke_previous_secrets_immediatelyপূর্বের সমস্ত গোপনীয়তা অবিলম্বে প্রত্যাহার করুন। সতর্কতার সাথে ব্যবহার করুন, কারণ এটি চলমান বিজ্ঞপ্তিগুলিতে বাধা সৃষ্টি করতে পারে।
প্রতিক্রিয়া
সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
শুধুমাত্র আউটপুট। নতুন তৈরি হওয়া স্বাক্ষর গোপনীয়তা।
উদাহরণ
উদাহরণ প্রতিক্রিয়া
{ "secret": "string" }
ListWebhooks
সমস্ত ওয়েবহুক তালিকাভুক্ত করে।
পাথ / কোয়েরি প্যারামিটার
ঐচ্ছিক। ফেরত দেওয়ার জন্য ওয়েবহুকের সর্বোচ্চ সংখ্যা। পরিষেবাটি এই মানের চেয়ে কমও ফেরত দিতে পারে। যদি নির্দিষ্ট না করা হয়, তবে সর্বাধিক ৫০টি ওয়েবহুক ফেরত দেওয়া হবে। সর্বোচ্চ মান হলো ১০০০।
ঐচ্ছিক। পূর্ববর্তী `ListWebhooks` কল থেকে প্রাপ্ত একটি পেজ টোকেন। পরবর্তী পেজটি পাওয়ার জন্য এটি প্রদান করুন।
প্রতিক্রিয়া
সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
একটি টোকেন, যা পরবর্তী পৃষ্ঠা আনার জন্য `page_token` হিসেবে পাঠানো যেতে পারে। এই ক্ষেত্রটি বাদ দিলে, পরবর্তী কোনো পৃষ্ঠা থাকবে না।
ওয়েবহুকগুলো।
উদাহরণ
উদাহরণ প্রতিক্রিয়া
{ "next_page_token": "string", "webhooks": [ { "create_time": "string", "id": "string", "name": "string", "new_signing_secret": "string", "signing_secrets": [ { "expire_time": "string", "truncated_secret": "string" } ], "state": "enabled", "subscribed_events": [ "batch.succeeded" ], "update_time": "string", "uri": "string" } ] }
GetWebhook
একটি নির্দিষ্ট ওয়েবহুক পায়।
পাথ / কোয়েরি প্যারামিটার
প্রয়োজনীয়। যে ওয়েবহুকটি পুনরুদ্ধার করতে হবে তার আইডি।
প্রতিক্রিয়া
সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
শুধুমাত্র আউটপুট। ওয়েবহুকটি তৈরি হওয়ার সময়কার টাইমস্ট্যাম্প।
শুধুমাত্র আউটপুট। ওয়েবহুকের আইডি।
ঐচ্ছিক। ব্যবহারকারীর দেওয়া ওয়েবহুকের নাম।
শুধুমাত্র আউটপুট। ওয়েবহুকের জন্য নতুন সাইনিং সিক্রেট। শুধুমাত্র তৈরির সময় পূরণ করা হয়।
signing_secrets অ্যারে (SigningSecret) (ঐচ্ছিক)
শুধুমাত্র আউটপুট। এই ওয়েবহুকের সাথে যুক্ত স্বাক্ষর করার গোপনীয় তথ্য।
ক্ষেত্র
শুধুমাত্র আউটপুট। স্বাক্ষর গোপনীয়তার মেয়াদ শেষ হওয়ার তারিখ।
শুধুমাত্র আউটপুট। স্বাক্ষর-গোপনীয়তার সংক্ষিপ্ত সংস্করণ।
শুধুমাত্র আউটপুট। ওয়েবহুকের অবস্থা।
সম্ভাব্য মানসমূহ:
-
enabledওয়েবহুকটি সক্রিয় করা হয়েছে।
-
disabledব্যবহারকারী ওয়েবহুকটি নিষ্ক্রিয় করেছেন।
-
disabled_due_to_failed_deliveriesডেলিভারি ব্যর্থ হওয়ায় ওয়েবহুকটি নিষ্ক্রিয় করা হয়েছে।
প্রয়োজনীয়। যে ইভেন্টগুলোতে ওয়েবহুকটি সাবস্ক্রাইব করা আছে। উপলব্ধ ইভেন্টসমূহ: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
সম্ভাব্য মানসমূহ:
-
batch.succeededব্যাচ প্রক্রিয়াকরণ সফলভাবে সম্পন্ন হয়েছে।
-
batch.expired৪৮ ঘণ্টার সময়সীমার মধ্যে ব্যাচটি প্রসেস করা হয়নি।
-
batch.failedব্যাচ জবটি ব্যর্থ হয়েছে।
-
interaction.requires_actionমিথস্ক্রিয়ার জন্য কোনো কাজ করার প্রয়োজন হয় (যেমন, ফাংশন কল করা)।
-
interaction.completedমিথস্ক্রিয়া সফলভাবে সম্পন্ন হয়েছে।
-
interaction.failedমিথস্ক্রিয়া ব্যর্থ হয়েছে।
-
video.generatedভিডিও তৈরি সম্পন্ন হয়েছে।
শুধুমাত্র আউটপুট। ওয়েবহুকটি সর্বশেষ আপডেট হওয়ার সময়কার টাইমস্ট্যাম্প।
আবশ্যক। যে URI-তে ওয়েবহুক ইভেন্টগুলো পাঠানো হবে।
উদাহরণ
উদাহরণ প্রতিক্রিয়া
{ "create_time": "string", "id": "string", "name": "string", "new_signing_secret": "string", "signing_secrets": [ { "expire_time": "string", "truncated_secret": "string" } ], "state": "enabled", "subscribed_events": [ "batch.succeeded" ], "update_time": "string", "uri": "string" }
আপডেটওয়েবহুক
বিদ্যমান ওয়েবহুক আপডেট করে।
পাথ / কোয়েরি প্যারামিটার
প্রয়োজনীয়। যে ওয়েবহুকটি আপডেট করতে হবে তার আইডি।
ঐচ্ছিক। হালনাগাদ করার জন্য ক্ষেত্রসমূহের তালিকা।
অনুরোধকারী শরীর
অনুরোধের মূল অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
ঐচ্ছিক। ব্যবহারকারীর দেওয়া ওয়েবহুকের নাম।
ঐচ্ছিক। ওয়েবহুকের অবস্থা।
সম্ভাব্য মানসমূহ:
-
enabledওয়েবহুকটি সক্রিয় করা হয়েছে।
-
disabledব্যবহারকারী ওয়েবহুকটি নিষ্ক্রিয় করেছেন।
-
disabled_due_to_failed_deliveriesডেলিভারি ব্যর্থ হওয়ায় ওয়েবহুকটি নিষ্ক্রিয় করা হয়েছে।
ঐচ্ছিক। যে ইভেন্টগুলোতে ওয়েবহুকটি সাবস্ক্রাইব করা আছে। উপলব্ধ ইভেন্টসমূহ: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
সম্ভাব্য মানসমূহ:
-
batch.succeededব্যাচ প্রক্রিয়াকরণ সফলভাবে সম্পন্ন হয়েছে।
-
batch.expired৪৮ ঘণ্টার সময়সীমার মধ্যে ব্যাচটি প্রসেস করা হয়নি।
-
batch.failedব্যাচ জবটি ব্যর্থ হয়েছে।
-
interaction.requires_actionমিথস্ক্রিয়ার জন্য কোনো কাজ করার প্রয়োজন হয় (যেমন, ফাংশন কল করা)।
-
interaction.completedমিথস্ক্রিয়া সফলভাবে সম্পন্ন হয়েছে।
-
interaction.failedমিথস্ক্রিয়া ব্যর্থ হয়েছে।
-
video.generatedভিডিও তৈরি সম্পন্ন হয়েছে।
ঐচ্ছিক। যে URI-তে ওয়েবহুক ইভেন্টগুলো পাঠানো হবে।
প্রতিক্রিয়া
সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:
শুধুমাত্র আউটপুট। ওয়েবহুকটি তৈরি হওয়ার সময়কার টাইমস্ট্যাম্প।
শুধুমাত্র আউটপুট। ওয়েবহুকের আইডি।
ঐচ্ছিক। ব্যবহারকারীর দেওয়া ওয়েবহুকের নাম।
শুধুমাত্র আউটপুট। ওয়েবহুকের জন্য নতুন সাইনিং সিক্রেট। শুধুমাত্র তৈরির সময় পূরণ করা হয়।
signing_secrets অ্যারে (SigningSecret) (ঐচ্ছিক)
শুধুমাত্র আউটপুট। এই ওয়েবহুকের সাথে যুক্ত স্বাক্ষর করার গোপনীয় তথ্য।
ক্ষেত্র
শুধুমাত্র আউটপুট। স্বাক্ষর গোপনীয়তার মেয়াদ শেষ হওয়ার তারিখ।
শুধুমাত্র আউটপুট। স্বাক্ষর-গোপনীয়তার সংক্ষিপ্ত সংস্করণ।
শুধুমাত্র আউটপুট। ওয়েবহুকের অবস্থা।
সম্ভাব্য মানসমূহ:
-
enabledওয়েবহুকটি সক্রিয় করা হয়েছে।
-
disabledব্যবহারকারী ওয়েবহুকটি নিষ্ক্রিয় করেছেন।
-
disabled_due_to_failed_deliveriesডেলিভারি ব্যর্থ হওয়ায় ওয়েবহুকটি নিষ্ক্রিয় করা হয়েছে।
প্রয়োজনীয়। যে ইভেন্টগুলোতে ওয়েবহুকটি সাবস্ক্রাইব করা আছে। উপলব্ধ ইভেন্টসমূহ: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
সম্ভাব্য মানসমূহ:
-
batch.succeededব্যাচ প্রক্রিয়াকরণ সফলভাবে সম্পন্ন হয়েছে।
-
batch.expired৪৮ ঘণ্টার সময়সীমার মধ্যে ব্যাচটি প্রসেস করা হয়নি।
-
batch.failedব্যাচ জবটি ব্যর্থ হয়েছে।
-
interaction.requires_actionমিথস্ক্রিয়ার জন্য কোনো কাজ করার প্রয়োজন হয় (যেমন, ফাংশন কল করা)।
-
interaction.completedমিথস্ক্রিয়া সফলভাবে সম্পন্ন হয়েছে।
-
interaction.failedমিথস্ক্রিয়া ব্যর্থ হয়েছে।
-
video.generatedভিডিও তৈরি সম্পন্ন হয়েছে।
শুধুমাত্র আউটপুট। ওয়েবহুকটি সর্বশেষ আপডেট হওয়ার সময়কার টাইমস্ট্যাম্প।
আবশ্যক। যে URI-তে ওয়েবহুক ইভেন্টগুলো পাঠানো হবে।
উদাহরণ
উদাহরণ প্রতিক্রিয়া
{ "create_time": "string", "id": "string", "name": "string", "new_signing_secret": "string", "signing_secrets": [ { "expire_time": "string", "truncated_secret": "string" } ], "state": "enabled", "subscribed_events": [ "batch.succeeded" ], "update_time": "string", "uri": "string" }
DeleteWebhook
একটি ওয়েবহুক মুছে ফেলে।
পাথ / কোয়েরি প্যারামিটার
আবশ্যক। যে ওয়েবহুকটি মুছে ফেলতে হবে তার আইডি। ফরম্যাট: `{webhook_id}`
প্রতিক্রিয়া
সফল হলে, প্রতিক্রিয়াটি খালি থাকে।
উদাহরণ
সম্পদ
ওয়েবহুক
একটি ওয়েবহুক রিসোর্স।
ক্ষেত্র
শুধুমাত্র আউটপুট। ওয়েবহুকটি তৈরি হওয়ার সময়কার টাইমস্ট্যাম্প।
শুধুমাত্র আউটপুট। ওয়েবহুকের আইডি।
ঐচ্ছিক। ব্যবহারকারীর দেওয়া ওয়েবহুকের নাম।
শুধুমাত্র আউটপুট। ওয়েবহুকের জন্য নতুন সাইনিং সিক্রেট। শুধুমাত্র তৈরির সময় পূরণ করা হয়।
signing_secrets অ্যারে (SigningSecret) (ঐচ্ছিক)
শুধুমাত্র আউটপুট। এই ওয়েবহুকের সাথে যুক্ত স্বাক্ষর করার গোপনীয় তথ্য।
ক্ষেত্র
শুধুমাত্র আউটপুট। স্বাক্ষর গোপনীয়তার মেয়াদ শেষ হওয়ার তারিখ।
শুধুমাত্র আউটপুট। স্বাক্ষর-গোপনীয়তার সংক্ষিপ্ত সংস্করণ।
শুধুমাত্র আউটপুট। ওয়েবহুকের অবস্থা।
সম্ভাব্য মানসমূহ:
-
enabledওয়েবহুকটি সক্রিয় করা হয়েছে।
-
disabledব্যবহারকারী ওয়েবহুকটি নিষ্ক্রিয় করেছেন।
-
disabled_due_to_failed_deliveriesডেলিভারি ব্যর্থ হওয়ায় ওয়েবহুকটি নিষ্ক্রিয় করা হয়েছে।
প্রয়োজনীয়। যে ইভেন্টগুলোতে ওয়েবহুকটি সাবস্ক্রাইব করা আছে। উপলব্ধ ইভেন্টসমূহ: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated
সম্ভাব্য মানসমূহ:
-
batch.succeededব্যাচ প্রক্রিয়াকরণ সফলভাবে সম্পন্ন হয়েছে।
-
batch.expired৪৮ ঘণ্টার সময়সীমার মধ্যে ব্যাচটি প্রসেস করা হয়নি।
-
batch.failedব্যাচ জবটি ব্যর্থ হয়েছে।
-
interaction.requires_actionমিথস্ক্রিয়ার জন্য কোনো কাজ করার প্রয়োজন হয় (যেমন, ফাংশন কল করা)।
-
interaction.completedমিথস্ক্রিয়া সফলভাবে সম্পন্ন হয়েছে।
-
interaction.failedমিথস্ক্রিয়া ব্যর্থ হয়েছে।
-
video.generatedভিডিও তৈরি সম্পন্ন হয়েছে।
শুধুমাত্র আউটপুট। ওয়েবহুকটি সর্বশেষ আপডেট হওয়ার সময়কার টাইমস্ট্যাম্প।
আবশ্যক। যে URI-তে ওয়েবহুক ইভেন্টগুলো পাঠানো হবে।