LiveBroadcasts: list

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

일반적인 사용 사례

요청

HTTP 요청

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

승인

이 요청에는 다음 범위 중 하나 이상의 승인이 필요합니다. 인증 및 승인에 대해 자세히 알아보려면 OAuth 2.0 인증 구현을 참고하세요.

범위
https://www.googleapis.com/auth/youtube.readonly
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

매개변수

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

매개변수
필수 매개변수
part string
part 매개변수는 API 응답에 포함될 하나 이상의 liveBroadcast 리소스 속성이 쉼표로 구분된 목록을 지정합니다. 매개변수 값에 포함할 수 있는 part 이름은 id, snippet, contentDetails, monetizationDetails, status입니다.
필터 (다음 매개변수 중 정확히 하나를 지정)
broadcastStatus string
broadcastStatus 매개변수는 지정된 상태의 방송만 포함하도록 API 응답을 필터링합니다.

허용되는 값은 다음과 같습니다.
  • active – 현재 라이브 방송을 반환합니다.
  • all – 모든 방송을 반환합니다.
  • completed – 이미 종료된 방송을 반환합니다.
  • upcoming – 아직 시작되지 않은 방송을 반환합니다.
id string
id 매개변수는 검색 중인 방송을 식별하는 YouTube 방송 ID가 쉼표로 구분된 목록을 지정합니다. liveBroadcast 리소스에서 id 속성은 방송의 ID를 지정합니다.
mine boolean
mine 매개변수를 사용하여 인증된 사용자가 소유한 방송만 반환하도록 API에 지시할 수 있습니다. 자신의 브로드캐스트만 검색하려면 파라미터 값을 true로 설정합니다.
선택적 매개변수
broadcastType string
broadcastType 매개변수는 지정된 유형의 방송만 포함하도록 API 응답을 필터링합니다. 이 매개변수는 mine 매개변수를 true로 설정하거나 broadcastStatus 매개변수를 사용하는 요청에 사용해야 합니다. 기본값은 event입니다.

허용되는 값은 다음과 같습니다.
  • all – 모든 방송을 반환합니다.
  • event – 예약된 이벤트 방송만 반환합니다.
  • persistent – 영구 방송만 반환합니다.
maxResults unsigned integer
maxResults 매개변수는 결과 집합에서 반환되어야 하는 최대 항목 수를 지정합니다. 허용되는 값은 0~50입니다(경계값 포함). 기본값은 5입니다.
onBehalfOfContentOwner string
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다.
참고: 이 파라미터는 YouTube 콘텐츠 파트너 전용입니다.

onBehalfOfContentOwner 파라미터는 요청의 승인 사용자 인증 정보가 파라미터 값에 지정된 콘텐츠 소유자를 대신하여 행동하는 YouTube 콘텐츠 관리 시스템 (CMS) 사용자를 식별함을 나타냅니다. 이 매개변수는 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너를 위한 것입니다. 콘텐츠 소유자는 각 채널에 사용자 인증 정보를 제공하지 않고 한 번 인증하여 모든 동영상 및 채널 데이터에 액세스할 수 있습니다. 사용자가 인증할 CMS 계정은 지정된 YouTube 콘텐츠 소유자에게 연결되어야 합니다.
onBehalfOfContentOwnerChannel string
이 매개변수는 적절하게 승인된 요청에서만 사용할 수 있습니다.
참고: 이 매개변수는 YouTube 콘텐츠 파트너 전용입니다.

onBehalfOfContentOwnerChannel 매개변수는 동영상이 추가되는 채널의 YouTube 채널 ID를 지정합니다. 이 매개변수는 요청에서 onBehalfOfContentOwner 매개변수의 값을 지정할 때 필요하며 이 매개변수와 함께만 사용할 수 있습니다. 또한 요청은 onBehalfOfContentOwner 매개변수가 지정하는 콘텐츠 소유자에게 연결된 CMS 계정을 사용하여 승인되어야 합니다. 마지막으로 onBehalfOfContentOwnerChannel 매개변수 값이 지정하는 채널은 onBehalfOfContentOwner 매개변수가 지정하는 콘텐츠 소유자에게 연결되어야 합니다.

이 매개변수는 여러 YouTube 채널을 소유하고 관리하는 YouTube 콘텐츠 파트너를 위한 것입니다. 콘텐츠 소유자는 각 채널에 사용자 인증 정보를 제공하지 않고 한 번 인증하여 파라미터 값에 지정된 채널을 대신하여 작업을 실행할 수 있습니다.
pageToken string
pageToken 매개변수는 반환되어야 하는 결과 집합의 특정 페이지를 식별합니다. API 응답에서 nextPageToken 및 prevPageToken 속성은 검색할 수 있는 다른 페이지를 식별합니다.

요청 본문

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

응답

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

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

속성

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

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

오류

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

오류 유형 오류 세부정보 설명
insufficientPermissions insufficientLivePermissions 요청에 라이브 방송을 검색할 권한이 없습니다.
insufficientPermissions liveStreamingNotEnabled 요청을 승인한 사용자가 YouTube에서 라이브 동영상을 스트리밍할 수 없습니다. 자세한 내용은 기능 사용 자격 요건을 참고하세요.

기능을 사용해 보세요.

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