Method: files.create

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

エージェントは、ファイルの URL またはバイナリと、（必要に応じて）対応するサムネイル ファイルの URL を提供します。

重要: ユーザーのプライバシーとセキュリティを確保するため、RBM プラットフォームは、指定された URL からメディア ファイルと PDF ファイルをダウンロードして処理してから、ユーザーに配信します。これにより、一意の URL によるエージェントのトラッキングが妨げられます。したがって、大量の一意の URL を送信しないでください。URL が同じファイルを指しているかどうかにかかわらず、RBM プラットフォームではサポートされていません。同じファイルには同じ URL を使用します。

RBM プラットフォームはファイルを 60 日間キャッシュに保存し、エージェント メッセージを送信する際にファイルの識別に使用できる一意の名前を返します。

ファイルのバイナリをアップロードするには、アップロード 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,
  "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。

注: ファイル URL には 1 つのリダイレクトを含めることができます。リダイレクト先のファイルの URL は一般公開されている必要があります。CreateAgentMessageRequest のファイル URL はリダイレクトに対応していません。
thumbnailUrl

string

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

サポートされている画像コンテンツの種類: image/jpeg、image/jpg、image/gif、image/png。
agentId

string

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

レスポンスの本文

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

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

string

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

認可スコープ

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

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

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