Method: files.create

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

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

重要: ユーザーのプライバシーとセキュリティを保護するため、RCS for Business プラットフォームは、提供された URL からメディア ファイルと PDF ファイルをダウンロードして処理してから、ユーザーに配信します。これにより、固有の URL によるエージェントのトラッキングが防止されます。そのため、固有の URL を大量に送信しないでください。URL が同じファイルを参照しているか、異なるファイルを参照しているかにかかわらず、RCS for Business プラットフォームではこの機能はサポートされていません。同一のファイルには同じ URL を使用します。

RCS for Business プラットフォームはファイルを 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。RCS for Business プラットフォームは、ファイルを取得する際に HTTP ヘッダーの content-type フィールドからファイルの MIME タイプを判断します。RCS for Business は、画像、音声、動画、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。このフィールドが設定されていない場合、RCS for Business プラットフォームはファイルから自動的にサムネイルを生成します。RCS for Business プラットフォームは、ファイルを取得するときに 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 をご覧ください。