new_releases עדכונים: בדקו את
נתוני הגרסה כדי לגלות תכונות חדשות ועדכוני מוצרים.
Method: files.create
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
העלאת קובץ לשימוש בהודעות עם מדיה או כרטיסים עשירים.
הסוכן מספק את כתובת ה-URL או את הקובץ הבינארי של הקובץ, ואפשרותית גם את כתובת ה-URL של קובץ התמונה הממוזערת התואם.
חשוב: כדי לשמור על פרטיות המשתמשים ועל האבטחה שלהם, פלטפורמת RBM מורידת ומעבדת קובצי מדיה וקובצי PDF מכתובות ה-URL שסופקו לפני שהיא מעבירה אותם למשתמש. כך אפשר למנוע מעקב אחר סוכנים לפי כתובות URL ייחודיות. לכן, אל תשלחו כמות גדולה של כתובות URL ייחודיות. פלטפורמת RBM לא תומכת בכך, גם אם כתובות ה-URL מפנות לאותו קובץ וגם אם הן מפנות לקבצים שונים. להשתמש באותה כתובת URL לקבצים זהים.
פלטפורמת RBM שומרת את הקובץ במטמון למשך 60 יום ומחזירה שם ייחודי שאפשר להשתמש בו כדי לזהות את הקובץ כששולחים הודעות לסוכנים.
כדי להעלות קובץ בינארי, שולחים בקשת POST ב-HTTP למזהה ה-URI של ההעלאה, משמיטים את השדה fileUrl מתוך תוכן הבקשה ב-JSON ומציינים את הקובץ הבינארי כתוכן הבקשה ב-POST. לדוגמה, משתמשים בדגל cURL --upload-file עם נתיב הקובץ המלא והמתאים של הקובץ הבינארי.
בקשת HTTP
- URI להעלאה, לבקשות העלאה של מדיה:
POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
- URI של מטא-נתונים, לבקשות של מטא-נתונים בלבד:
POST https://rcsbusinessmessaging.googleapis.com/v1/files
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"fileUrl": string,
"thumbnailUrl": string,
"agentId": string
} |
| שדות |
fileUrl |
string
אופציונלי. כתובת ה-URL של הקובץ שגלויה לכולם. פלטפורמת RBM קובעת את סוג ה-MIME של הקובץ מהשדה content-type בכותרות ה-HTTP בזמן אחזור הקובץ. RBM תומך בתמונות, בקובצי אודיו, בסרטונים ובקובצי PDF. סוגי התוכן הנתמכים של תמונות: image/jpeg, image/jpg, image/gif, image/png. סוגי תוכן אודיו נתמכים: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg. סוגי תוכן הווידאו הנתמכים: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm. סוגי התוכן הנתמכים בקובצי PDF: application/pdf. הערה: כתובת ה-URL של הקובץ יכולה לכלול הפניה אוטומטית אחת. כתובות ה-URL של הקבצים שהופנו צריכות להיות נגישות לכולם. אין תמיכה בהפניות אוטומטיות לכתובות URL של קבצים ב-CreateAgentMessageRequest.
|
thumbnailUrl |
string
אופציונלי. כתובת URL זמינה לכולם של התמונה הממוזערת התואמת לקובץ. אם השדה הזה לא מוגדר, פלטפורמת RBM יוצרת תמונה ממוזערת מהקובץ באופן אוטומטי. פלטפורמת RBM קובעת את סוג ה-MIME של הקובץ מהשדה content-type בכותרות ה-HTTP בזמן אחזור הקובץ. סוגי התוכן הנתמכים של תמונות: image/jpeg, image/jpg, image/gif, image/png.
|
agentId |
string
חובה. המזהה הייחודי של הסוכן.
|
גוף התשובה
משאב קובץ עם שם ייחודי שסוכן יכול להשתמש בו כדי לזהות את הקובץ בזמן שליחת הודעות.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
{
"name": string
} |
| שדות |
name |
string
השם הייחודי של משאב הקובץ שהוקצה על ידי השרת, והסוכן יכול להשתמש בו כדי לזהות את הקובץ בזמן שליחת הודעות. הפורמט הוא 'files/{uid}', כאשר {uid} הוא מזהה ייחודי.
|
היקפי הרשאה
נדרשת הרשאת OAuth ברמה הבאה:
https://www.googleapis.com/auth/rcsbusinessmessaging
מידע נוסף זמין בOAuth 2.0 Overview.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\u003cp\u003eThis process allows agents to upload files, including images, audio, video, and PDFs, for use in media or rich card messages, either by providing a public URL or the file's binary data.\u003c/p\u003e\n"],["\u003cp\u003eThe RBM platform handles file privacy and security by downloading and processing media files from provided URLs, preventing agent tracking via unique URLs, and caches the file for 60 days.\u003c/p\u003e\n"],["\u003cp\u003eThe file upload requires an HTTP POST request to either the upload URI \u003ccode\u003ehttps://rcsbusinessmessaging.googleapis.com/upload/v1/files\u003c/code\u003e or the metadata-only URI \u003ccode\u003ehttps://rcsbusinessmessaging.googleapis.com/v1/files\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe agent can provide a public \u003ccode\u003efileUrl\u003c/code\u003e, \u003ccode\u003ethumbnailUrl\u003c/code\u003e, and must include the \u003ccode\u003eagentId\u003c/code\u003e within the request body to upload files.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful upload, the RBM platform returns a unique file name (\u003ccode\u003ename\u003c/code\u003e) that agents can use to reference the file in subsequent messages.\u003c/p\u003e\n"]]],[],null,["# Method: files.create\n\nUploads a file for use in media or rich card messages.\n\nThe agent provides the URL or binary of the file and (optionally) the URL of the corresponding thumbnail file.\n\nImportant: For user privacy and security, the RBM platform downloads and processes media and PDF files from the provided URLs before delivering them to the user. This prevents agent tracking by unique URLs. Therefore, do not submit a high volume of unique URLs. The RBM platform does not support this, whether the URLs point to the same or different files. Use the same URL for identical files.\n\nThe RBM platform caches the file for 60 days and returns a unique name that you can use to identify the file when sending agent messages.\n\nTo upload a file binary, make an HTTP POST request to the Upload URI, omit the `fileUrl` field from the JSON request body, and specify the binary as the POST request body. For example, use the `--upload-file` cURL flag with the fully qualified file path of the binary file.\n\n### HTTP request\n\n- Upload URI, for media upload requests: \n `POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files`\n- Metadata URI, for metadata-only requests: \n `POST https://rcsbusinessmessaging.googleapis.com/v1/files`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------|\n| ``` { \"fileUrl\": string, \"thumbnailUrl\": string, \"agentId\": string } ``` |\n\n| Fields ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fileUrl` | `string` Optional. Publicly available URL of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when fetching the file. RBM supports image, audio, video, and pdf. Supported image content types: image/jpeg, image/jpg, image/gif, image/png. Supported audio content types: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg. Supported video content types: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm. Supported pdf content types: application/pdf. Note: file URL can have 1 redirect. Redirected file URLs must be publicly accessible. Redirects are not supported for file URLs in CreateAgentMessageRequest. |\n| `thumbnailUrl` | `string` Optional. Publicly available URL of the thumbnail corresponding to the file. If this field is not set, then the RBM platform automatically generates a thumbnail from the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when fetching the file. Supported image content types: image/jpeg, image/jpg, image/gif, image/png. |\n| `agentId` | `string` Required. The agent's unique identifier. |\n\n### Response body\n\nA file resource with a unique name that an agent can use to identify the file when sending messages.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------|\n| ``` { \"name\": string } ``` |\n\n| Fields ||\n|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Server-assigned unique name of the file resource, which an agent can use to identify the file when sending messages. The format is \"files/{uid}\", where {uid} is a unique ID. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/rcsbusinessmessaging`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
