REST Resource: attachments

리소스: Attachment

에이전트가 첨부파일을 식별하는 데 사용할 수 있는 고유한 이름의 첨부파일 리소스입니다.

JSON 표현
{
  "name": string,
  "gcsUrl": string,
  "displayName": string,
  "description": string,
  "contentType": string,
  "sizeBytes": string,
  "attachmentOperationSource": enum (AttachmentOperationSource),
  "uploadTime": string,
  "uploadError": {
    object (Status)
  }
}
필드
name

string

출력 전용입니다. 첨부파일의 고유 식별자입니다. 읽기 전용입니다. 플랫폼에서 정의합니다.

gcsUrl

string

출력 전용입니다. 첨부파일의 GCS URL입니다. GCS에서 첨부파일을 가져오는 데 사용되는 공개적으로 액세스 가능한 URL입니다.

displayName

string

선택사항입니다. 첨부파일의 표시 이름입니다.

description

string

선택사항입니다. 첨부파일 콘텐츠의 텍스트 설명입니다. 스크린 리더는 이 설명을 사용하여 장애가 있는 사용자가 첨부파일에 포함된 내용을 이해하도록 돕습니다.

contentType

string

선택사항입니다. 첨부파일의 콘텐츠 유형입니다.

sizeBytes

string (int64 format)

출력 전용입니다. 첨부파일의 크기(바이트)입니다.

attachmentOperationSource

enum (AttachmentOperationSource)

필수 항목입니다. 첨부파일 업로드를 트리거한 소스입니다.

uploadType=media인 경우에 필요합니다. 업로드 이유를 지정합니다. 가능한 값은 AttachmentOperationSource를 참고하세요.

uploadTime

string (Timestamp format)

출력 전용입니다. 첨부파일이 GCS에 업로드된 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.

uploadError

object (Status)

출력 전용입니다. 첨부파일 업로드 중에 발생한 오류 결과입니다(발생한 경우).

AttachmentOperationSource

첨부파일 작업 소스 목록입니다.

열거형
ATTACHMENT_OPERATION_SOURCE_UNSPECIFIED 첨부파일 작업이 지정되지 않았습니다.
VERIFICATION_PAGE 콘솔 확인 페이지입니다.
VERIFICATION_ATTACHMENT_VIA_BC_API Business Communications API를 사용하여 업로드된 에이전트 확인을 지원하는 첨부파일입니다.

상태

Status 유형은 REST API, RPC API를 비롯하여 다양한 프로그래밍 환경에 적합한 논리적 오류 모델을 정의하며, gRPC에서 사용됩니다. 각 Status 메시지에는 오류 코드, 오류 메시지, 오류 세부정보라는 3가지 데이터가 포함됩니다.

API 설계 가이드에서 이 오류 모델과 모델 작업 방법에 대해 자세히 알아볼 수 있습니다.

JSON 표현
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
필드
code

integer

상태 코드로, google.rpc.Code의 열거형 값이어야 합니다.

message

string

개발자에게 정보를 제공하는 오류 메시지로, 영어로 작성되어야 합니다. 사용자에게 표시되는 모든 오류 메시지는 현지화되어 google.rpc.Status.details 필드에 전송되거나, 클라이언트 측에서 현지화되어야 합니다.

details[]

object

오류 세부정보를 설명하는 메시지 목록입니다. API에서 사용할 일반적인 메시지 유형 집합이 있습니다.

임의 유형의 필드를 포함하는 객체입니다. 추가 필드 "@type"은 유형을 식별하는 URI를 포함합니다. 예: { "id": 1234, "@type": "types.example.com/standard/id" }

메서드

create

비즈니스용 RCS 에이전트의 첨부파일을 만듭니다.