View Source GoogleApi.DisplayVideo.V1.Api.Sdfdownloadtasks (google_api_display_video v0.35.0)

API calls for all endpoints tagged Sdfdownloadtasks.

Summary

Functions

displayvideo_sdfdownloadtasks_create(connection, optional_params \\ [], opts \\ [])

Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.

displayvideo_sdfdownloadtasks_operations_get(connection, name, optional_params \\ [], opts \\ [])

Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.

Functions

Link to this function

displayvideo_sdfdownloadtasks_create(connection, optional_params \\ [], opts \\ [])

View Source 
@spec displayvideo_sdfdownloadtasks_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an SDF Download Task. Returns an Operation. An SDF Download Task is a long-running, asynchronous operation. The metadata type of this operation is SdfDownloadTaskMetadata. If the request is successful, the response type of the operation is SdfDownloadTask. The response will not include the download files, which must be retrieved with media.download. The state of operation can be retrieved with sdfdownloadtask.operations.get. Any errors can be found in the error.message. Note that error.details is expected to be empty.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DisplayVideo.V1.Model.CreateSdfDownloadTaskRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

displayvideo_sdfdownloadtasks_operations_get(connection, name, optional_params \\ [], opts \\ [])

View Source 
@spec displayvideo_sdfdownloadtasks_operations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DisplayVideo.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.

Parameters

  • connection (type: GoogleApi.DisplayVideo.V1.Connection.t) - Connection to server
  • name (type: String.t) - The name of the operation resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DisplayVideo.V1.Model.Operation{}} on success
  • {:error, info} on failure