- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- تصویر
- بند انگشتی
- وضعیت
- آن را امتحان کنید!
تصاویر کوچک تصاویر پیوست شده به یک مرحله را فهرست می کند.
ممکن است هر یک از کدهای خطای متعارف زیر را برگرداند: - PERMISSION_DENIED - اگر کاربر مجاز به خواندن از پروژه یا هر یک از تصاویر نیست - INVALID_ARGUMENT - اگر درخواست بد شکل باشد - NOT_FOUND - اگر مرحله وجود نداشته باشد، یا اگر هیچ یک از تصاویر وجود نداشته باشد
درخواست HTTP
GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
مولفه های | |
---|---|
projectId | شناسه پروژه ضروری. |
historyId | شناسه تاریخچه ضروری. |
executionId | یک شناسه اعدام ضروری. |
stepId | شناسه مرحله ضروری. |
پارامترهای پرس و جو
مولفه های | |
---|---|
pageToken | یک نشانه ادامه برای از سرگیری پرس و جو در مورد بعدی. اختیاری. |
pageSize | حداکثر تعداد تصاویر کوچک برای واکشی. مقدار پیش فرض: 50. اگر فیلد تنظیم نشده باشد یا مقدار 0 داشته باشد، سرور از این پیش فرض استفاده خواهد کرد. اختیاری. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پاسخی که شامل تصاویر کوچک در یک مرحله است.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"thumbnails": [
{
object ( |
زمینه های | |
---|---|
thumbnails[] | لیستی از داده های تصویری تصاویر به ترتیب قطعی برگردانده می شوند. آنها بر اساس این عوامل به ترتیب اهمیت مرتب می شوند: * اول، بر اساس مورد آزمایشی مرتبط با آنها. تصاویر بدون مورد آزمایشی بزرگتر از تصاویر با یک مورد در نظر گرفته می شوند. * دوم، با زمان ایجاد آنها. تصاویر بدون زمان ایجاد بیشتر از تصاویر دارای یک هستند. * سوم، به ترتیبی که آنها به مرحله اضافه شدند (با فراخوانی به step.create یا steps.patch). |
nextPageToken | یک نشانه ادامه برای از سرگیری پرس و جو در مورد بعدی. اگر تنظیم شود، با فراخوانی مجدد لیست با این مقدار در قسمت pageToken، نشان می دهد که تصاویر کوچک بیشتری برای خواندن وجود دارد. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/cloud-platform
برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.
تصویر
یک تصویر، با پیوند به تصویر اصلی و یک تصویر کوچک.
نمایندگی JSON |
---|
{ "stepId": string, "sourceImage": { object ( |
زمینه های | |
---|---|
stepId | مرحله ای که تصویر به آن پیوست شده است. همیشه تنظیم شده است. |
sourceImage | ارجاع به تصویر در اندازه کامل و اصلی. این همان ورودی toolOutputs برای تصویر زیر Step آن است. همیشه تنظیم شده است. |
فیلد اتحاد thumbnail_or_error . یا یک تصویر کوچک از تصویر، یا یک خطا در توضیح اینکه چرا تصویر کوچک نمی تواند ارائه شود. thumbnail_or_error تنها می تواند یکی از موارد زیر باشد: | |
thumbnail | تصویر کوچک. |
error | خطایی در توضیح اینکه چرا تصویر کوچک ارائه نشد. |
بند انگشتی
یک تصویر کوچک، با اندازه و قالب آن.
نمایندگی JSON |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
زمینه های | |
---|---|
contentType | نوع محتوای تصویر کوچک، یعنی "image/png". همیشه تنظیم شده است. |
heightPx | ارتفاع تصویر کوچک، بر حسب پیکسل. همیشه تنظیم شده است. |
widthPx | عرض تصویر کوچک، بر حسب پیکسل. همیشه تنظیم شده است. |
data | خود فایل تصویر کوچک. یعنی بایت های اینجا دقیقا همان بایت هایی هستند که فایل تصویر کوچک را تشکیل می دهند. آنها را می توان به عنوان یک تصویر همانطور که هست (با نوع محتوای مناسب) ارائه کرد. همیشه تنظیم شده است. رشته ای با کد base64. |
وضعیت
نوع Status
یک مدل خطای منطقی را تعریف می کند که برای محیط های برنامه نویسی مختلف، از جمله REST API و RPC API مناسب است. توسط gRPC استفاده می شود. هر پیام Status
شامل سه داده است: کد خطا، پیام خطا و جزئیات خطا.
در راهنمای طراحی API میتوانید درباره این مدل خطا و نحوه کار با آن اطلاعات بیشتری کسب کنید.
نمایندگی JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
زمینه های | |
---|---|
code | کد وضعیت، که باید مقداری از |
message | یک پیغام خطای برنامهنویس، که باید به زبان انگلیسی باشد. هر پیام خطای کاربر باید بومی سازی شده و در قسمت |
details[] | لیستی از پیام هایی که حاوی جزئیات خطا هستند. مجموعه ای متداول از انواع پیام ها برای استفاده API ها وجود دارد. یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی |