CommentThreads: list

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

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

일반적인 사용 사례

요청

HTTP 요청

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

매개변수

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

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

다음 목록에는 매개변수 값에 포함할 수 있는 part 이름이 포함되어 있습니다.
  • id
  • replies
  • snippet
필터 (다음 매개변수 중 하나를 정확히 지정)
allThreadsRelatedToChannelId string
allThreadsRelatedToChannelId 매개변수는 API에 지정된 채널과 연결된 모든 댓글 대화목록을 반환하도록 지시합니다.
id string
id 매개변수는 가져올 리소스의 댓글 대화목록 ID를 쉼표로 구분한 목록을 지정합니다.
videoId string
videoId 매개변수는 API에 지정된 동영상 ID와 연결된 댓글 대화목록을 반환하도록 지시합니다.
선택적 매개변수
maxResults unsigned integer
maxResults 매개변수는 결과 집합에서 반환되어야 하는 항목의 최대 개수를 지정합니다.

참고: 이 매개변수는 id 매개변수와 함께 사용할 수 없습니다. 허용되는 값은 1~100입니다(경계값 포함). 기본값은 20입니다.
moderationStatus string
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다. 반환된 댓글 대화목록을 특정 검토 상태로 제한하려면 이 매개변수를 설정하세요.

참고: 이 매개변수는 id 매개변수와 함께 사용할 수 없습니다. 기본값은 published입니다.

허용되는 값은 다음과 같습니다.
  • heldForReview – 운영자의 검토를 기다리는 댓글 대화목록을 가져옵니다. 최상위 댓글 또는 해당 댓글에 대한 답글 중 하나 이상이 검토를 기다리는 경우 댓글 대화목록이 응답에 포함될 수 있습니다.
  • likelySpam – 스팸일 가능성이 높은 것으로 분류된 댓글 대화목록을 가져옵니다. 최상위 댓글 또는 해당 댓글에 대한 답글 중 하나 이상이 스팸일 가능성이 높은 것으로 간주되는 경우 댓글 대화목록이 응답에 포함될 수 있습니다.
  • published – 게시된 댓글의 대화목록을 가져옵니다. 기본값입니다. 최상위 댓글이 게시된 경우 댓글 대화목록이 응답에 포함될 수 있습니다.
order string
order 매개변수는 API 응답에서 댓글 대화목록을 나열해야 하는 순서를 지정합니다. 유효한 값은 다음과 같습니다.
  • time - 댓글 대화목록이 시간순으로 정렬됩니다. 이것이 기본 동작입니다.
  • relevance - 댓글 대화목록이 관련도순으로 정렬됩니다.
참고: 이 매개변수는 id 매개변수와 함께 사용할 수 없습니다.
pageToken string
pageToken 매개변수는 반환되어야 하는 결과 집합의 특정 페이지를 식별합니다. API 응답에서 nextPageToken 속성은 가져올 수 있는 결과의 다음 페이지를 식별합니다.

참고: 이 매개변수는 id 매개변수와 함께 사용할 수 없습니다.
searchTerms string
searchTerms 매개변수는 API에 지정된 검색어가 포함된 댓글만 포함하도록 API 응답을 제한하도록 지시합니다.

참고: 이 매개변수는 id 매개변수와 함께 사용할 수 없습니다.
textFormat string
이 매개변수의 값을 html 또는 plainText로 설정하여 API에 사용자가 남긴 댓글을 HTML 형식 또는 일반 텍스트로 반환하도록 지시합니다. 기본값은 html입니다.

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

요청 본문

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

응답

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

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

속성

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

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

오류

다음 표에서는 이 메서드 호출에 대한 응답으로 API가 반환할 수 있는 오류 메시지를 식별합니다. 자세한 내용은 오류 메시지 문서를 참고하세요.

오류 유형 오류 세부정보 설명
badRequest (400) operationNotSupported id 필드는 Google+를 기반으로 하는 댓글과만 호환됩니다.
badRequest (400) processingFailure API 서버에서 요청을 성공적으로 처리하지 못했습니다. 일시적인 오류일 수 있지만 일반적으로 요청의 입력이 잘못되었음을 나타냅니다. 요청 본문의 commentThread 리소스 구조가 유효한지 확인합니다.
forbidden (403) commentsDisabled videoId 매개변수로 식별된 동영상에서 댓글이 사용 중지되었습니다.
forbidden (403) forbidden 권한이 부족하여 요청된 댓글 대화목록 중 하나 이상을 가져올 수 없습니다. 요청이 제대로 인증되지 않았을 수 있습니다.
notFound (404) channelNotFound allThreadsRelatedToChannelId 매개변수로 식별된 채널을 찾을 수 없습니다.
notFound (404) commentThreadNotFound 지정된 댓글 대화목록 중 하나 이상을 찾을 수 없습니다. 요청의 id 매개변수 값이 올바른지 확인합니다.
notFound (404) videoNotFound videoId 매개변수로 식별된 동영상을 찾을 수 없습니다.

기능을 사용해 보세요.

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