Comments: list

API 요청 매개변수와 일치하는 댓글 목록을 반환합니다.

할당량 영향: 이 메서드를 호출하면 할당량 비용이 1단위 발생합니다.

일반적인 사용 사례

요청

HTTP 요청

GET https://www.googleapis.com/youtube/v3/comments

매개변수

다음 표에는 이 쿼리에서 지원하는 매개변수가 나와 있습니다. 나열된 모든 매개변수는 쿼리 매개변수입니다.

매개변수
필수 매개변수
part string
part 매개변수는 API 응답에 포함될 하나 이상의 comment 리소스 속성의 쉼표로 구분된 목록을 지정합니다.

다음 목록에는 매개변수 값에 포함할 수 있는 part 이름이 포함되어 있습니다.
  • id
  • snippet
필터 (다음 매개변수 중 정확히 하나를 지정)
id string
id 매개변수는 가져오는 리소스의 댓글 ID를 쉼표로 구분한 목록을 지정합니다. comment 리소스에서 id 속성은 댓글의 ID를 지정합니다.
parentId string
parentId 매개변수는 답글을 가져올 댓글의 ID를 지정합니다.

참고: YouTube는 현재 최상위 댓글에 대한 답글만 지원합니다. 하지만 향후 답글에 대한 답글이 지원될 수 있습니다.
선택적 매개변수
maxResults unsigned integer
maxResults 매개변수는 결과 집합에서 반환해야 하는 최대 항목 수를 지정합니다.

참고: 이 매개변수는 id 매개변수와 함께 사용할 수 없습니다. 허용되는 값은 1~100입니다(경계값 포함). 기본값은 20입니다.
pageToken string
pageToken 매개변수는 반환해야 하는 결과 집합의 특정 페이지를 식별합니다. API 응답에서 nextPageToken 속성은 가져올 수 있는 결과의 다음 페이지를 식별합니다.

참고: 이 매개변수는 id 매개변수와 함께 사용할 수 없습니다.
textFormat string
이 매개변수는 API가 HTML 또는 일반 텍스트로 형식이 지정된 댓글을 반환해야 하는지 여부를 나타냅니다. 기본값은 html입니다.

허용되는 값은 다음과 같습니다:
  • html – 댓글을 HTML 형식으로 반환합니다. 기본값입니다.
  • plainText – 댓글을 일반 텍스트 형식으로 반환합니다.

요청 본문

이 메소드를 호출할 때 요청 본문을 제공하지 마세요.

응답

요청에 성공할 경우 이 메소드는 다음과 같은 구조의 응답 본문을 반환합니다.

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

속성

다음 표는 이 리소스에 표시되는 속성을 정의합니다.

속성
kind string
API 리소스의 유형을 식별합니다. 값은 youtube#commentListResponse입니다.
etag etag
이 리소스의 ETag입니다.
nextPageToken string
결과 집합의 다음 페이지를 가져오기 위해 pageToken 매개변수의 값으로 사용할 수 있는 토큰입니다.
pageInfo object
pageInfo 객체는 결과 집합의 페이징 정보를 캡슐화합니다.
pageInfo.totalResults integer
결과 집합의 총 결과 수입니다.
pageInfo.resultsPerPage integer
API 응답에 포함된 결과 수입니다.
items[] list
요청 기준과 일치하는 댓글 목록입니다.

오류

다음 표에서는 이 메서드 호출에 대한 응답으로 API가 반환할 수 있는 오류 메시지를 보여줍니다. 자세한 내용은 오류 메시지 설명서를 참조하세요.

오류 유형 오류 세부정보 설명
badRequest (400) operationNotSupported ID 필터는 Google+를 기반으로 하는 댓글과만 호환됩니다.
forbidden (403) forbidden 권한이 부족하여 요청된 댓글 중 하나 이상을 가져올 수 없습니다. 요청이 제대로 인증되지 않았을 수 있습니다.
notFound (404) commentNotFound 지정된 댓글 중 하나 이상을 찾을 수 없습니다. 요청의 id 및 parentId 매개변수 값이 올바른지 확인합니다.

기능을 사용해 보세요.

APIs Explorer을 사용하여 이 API를 호출하고 API 요청 및 응답을 확인합니다.