Method: files.create

メディアまたはリッチカード メッセージで使用するファイルをアップロードします。

エージェントはファイルの URL またはバイナリと、対応するサムネイル ファイルの URL（省略可）を提供します。RBM プラットフォームは、ファイルを 30 日間キャッシュに保存し、エージェント メッセージの送信時にファイルを識別するために使用できる一意の名前を返します。

ファイル バイナリをアップロードするには、アップロード URI に HTTP POST リクエストを行い、JSON リクエストの本文の fileUrl フィールドを省略して、POST リクエストの本文にバイナリを指定します。たとえば、バイナリ ファイルの完全修飾ファイルパスを指定して、--upload-file cURL フラグを使用します。

HTTP リクエスト

  • メディア アップロード リクエスト用のアップロード URI:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • メタデータ URI（メタデータのみのリクエストの場合）:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

この URL は gRPC Transcoding 構文を使用します。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
フィールド
fileUrl

string

（省略可）ファイルの一般公開 URL。RBM プラットフォームは、ファイルを取得するときに HTTP ヘッダーの content-type フィールドからファイルの MIME タイプを判断します。

サポートされている画像コンテンツ タイプ: image/jpeg、image/jpg、image/gif、image/png。

サポートされている動画コンテンツ タイプ: video/h263、video/m4v、video/mp4、video/mpeg、video/mpeg4、video/webm。
thumbnailUrl

string

（省略可）ファイルに対応するサムネイルの公開 URL。このフィールドが設定されていない場合、RBM プラットフォームはファイルからサムネイルを自動的に生成します。RBM プラットフォームは、ファイルを取得するときに HTTP ヘッダーの content-type フィールドからファイルの MIME タイプを判断します。

サポートされている画像コンテンツ タイプ: image/jpeg、image/jpg、image/gif、image/png。
contentDescription

string

（省略可）ファイルの内容に関するテキストによる説明。スクリーン リーダーはこの説明を使用して、障がいのあるユーザーがファイルの内容を理解できるようにしています。
agentId

string

必須。エージェントの一意の識別子。

レスポンスの本文

一意の名前を持つファイル リソース。エージェントがメッセージを送信する際に、このファイルの識別に使用できます。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "name": string
}
フィールド
name

string

サーバーが割り当てたファイル リソースの一意の名前。エージェントがメッセージを送信する際に、この名前を使用してファイルを識別できます。形式は「files/{uid}」です。{uid} は一意の ID です。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/rcsbusinessmessaging

詳細については、OAuth 2.0 の概要をご覧ください。