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 タイプを判断します。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。
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 の概要をご覧ください。