Package video.api.client.api.clients

Class AnalyticsApi.APIgetVideosPlaysRequest

  • Enclosing class:
    AnalyticsApi
    public class AnalyticsApi.APIgetVideosPlaysRequest
extends Object

    • Method Detail

      • to

        public AnalyticsApi.APIgetVideosPlaysRequest to​(LocalDate to)
        Set to
        Parameters:
        to - Use this optional query parameter to set the end date for the time period that you want analytics for. - If you do not specify a `to` date, the API returns analytics data starting from the `from` date up until today, and excluding today. - The date you set must be **within the last 30 days**. - The value you provide must follow the `YYYY-MM-DD` format. (optional)
        Returns:
        APIgetVideosPlaysRequest

      • filter

        public AnalyticsApi.APIgetVideosPlaysRequest filter​(String filter)
        Set filter
        Parameters:
        filter - Use this query parameter to filter your results to a specific video in a project that you want analytics for. You must use the `videoId:` prefix when specifying a video ID. (optional)
        Returns:
        APIgetVideosPlaysRequest

      • currentPage

        public AnalyticsApi.APIgetVideosPlaysRequest currentPage​(Integer currentPage)
        Set currentPage
        Parameters:
        currentPage - Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
        Returns:
        APIgetVideosPlaysRequest

      • pageSize

        public AnalyticsApi.APIgetVideosPlaysRequest pageSize​(Integer pageSize)
        Set pageSize
        Parameters:
        pageSize - Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
        Returns:
        APIgetVideosPlaysRequest

      • buildCall

        public okhttp3.Call buildCall​(ApiCallback _callback)
                       throws ApiException
        Build call for getVideosPlays
        Parameters:
        _callback - ApiCallback API callback
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad request error -
        403 Forbidden - Disabled Analytics -
        404 Not Found -

      • execute

        public Page<AnalyticsData> execute()
                            throws ApiException
        Execute getVideosPlays request
        Returns:
        AnalyticsPlaysResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad request error -
        403 Forbidden - Disabled Analytics -
        404 Not Found -

      • executeWithHttpInfo

        public ApiResponse<AnalyticsPlaysResponse> executeWithHttpInfo()
                                                        throws ApiException
        Execute getVideosPlays request with HTTP info returned
        Returns:
        ApiResponse<AnalyticsPlaysResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad request error -
        403 Forbidden - Disabled Analytics -
        404 Not Found -

      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<Page<AnalyticsData>> _callback)
                          throws ApiException
        Execute getVideosPlays request (asynchronously)
        Parameters:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Success -
        400 Bad request error -
        403 Forbidden - Disabled Analytics -
        404 Not Found -