All Downloads are FREE. Search and download functionalities are using the official Maven repository.

target.apidocs.com.google.api.services.youtube.YouTube.LiveBroadcasts.List.html Maven / Gradle / Ivy

There is a newer version: v3-rev20240514-2.0.0
Show newest version






YouTube.LiveBroadcasts.List (YouTube Data API v3 v3-rev20240417-2.0.0)












com.google.api.services.youtube

Class YouTube.LiveBroadcasts.List

    • Constructor Detail

      • List

        protected List(List<String> part)
        Retrieve the list of broadcasts associated with the given channel. Create a request for the method "liveBroadcasts.list". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

        YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

        Parameters:
        part - The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics.
        Since:
        1.13
    • Method Detail

      • executeUsingHead

        public com.google.api.client.http.HttpResponse executeUsingHead()
                                                                 throws IOException
        Overrides:
        executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LiveBroadcastListResponse>
        Throws:
        IOException
      • buildHttpRequestUsingHead

        public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                         throws IOException
        Overrides:
        buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LiveBroadcastListResponse>
        Throws:
        IOException
      • getPart

        public List<String> getPart()
        The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics.
      • setPart

        public YouTube.LiveBroadcasts.List setPart(List<String> part)
        The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, status and statistics.
      • getBroadcastStatus

        public String getBroadcastStatus()
        Return broadcasts with a certain status, e.g. active broadcasts.
      • setBroadcastStatus

        public YouTube.LiveBroadcasts.List setBroadcastStatus(String broadcastStatus)
        Return broadcasts with a certain status, e.g. active broadcasts.
      • getBroadcastType

        public String getBroadcastType()
        Return only broadcasts with the selected type. [default: event]
      • getId

        public List<String> getId()
        Return broadcasts with the given ids from Stubby or Apiary.
      • getMaxResults

        public Long getMaxResults()
        The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. [default: 5] [minimum: 0] [maximum: 50]
      • setMaxResults

        public YouTube.LiveBroadcasts.List setMaxResults(Long maxResults)
        The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
      • getMine

        public Boolean getMine()
      • getOnBehalfOfContentOwner

        public String getOnBehalfOfContentOwner()
        Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
      • setOnBehalfOfContentOwner

        public YouTube.LiveBroadcasts.List setOnBehalfOfContentOwner(String onBehalfOfContentOwner)
        *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
      • getOnBehalfOfContentOwnerChannel

        public String getOnBehalfOfContentOwnerChannel()
        This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
      • setOnBehalfOfContentOwnerChannel

        public YouTube.LiveBroadcasts.List setOnBehalfOfContentOwnerChannel(String onBehalfOfContentOwnerChannel)
        This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
      • getPageToken

        public String getPageToken()
        The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
      • setPageToken

        public YouTube.LiveBroadcasts.List setPageToken(String pageToken)
        The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.

Copyright © 2011–2024 Google. All rights reserved.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy