GoogleApi.YouTubeReporting.V1.Api.Jobs (google_api_you_tube_reporting v0.14.0) View Source
API calls for all endpoints tagged Jobs
.
Link to this section Summary
Functions
Creates a job and returns it.
Gets the metadata of a specific report.
Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.
Link to this section Functions
Link to this function
youtubereporting_jobs_create(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
youtubereporting_jobs_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a job and returns it.
Parameters
-
connection
(type:GoogleApi.YouTubeReporting.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"). -
:onBehalfOfContentOwner
(type:String.t
) - The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). -
:body
(type:GoogleApi.YouTubeReporting.V1.Model.Job.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.YouTubeReporting.V1.Model.Job{}}
on success -
{:error, info}
on failure
Link to this function
youtubereporting_jobs_delete(connection, job_id, optional_params \\ [], opts \\ [])
View SourceSpecs
youtubereporting_jobs_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a job.
Parameters
-
connection
(type:GoogleApi.YouTubeReporting.V1.Connection.t
) - Connection to server -
job_id
(type:String.t
) - The ID of the job to delete. -
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"). -
:onBehalfOfContentOwner
(type:String.t
) - The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.YouTubeReporting.V1.Model.Empty{}}
on success -
{:error, info}
on failure
Link to this function
youtubereporting_jobs_get(connection, job_id, optional_params \\ [], opts \\ [])
View SourceSpecs
youtubereporting_jobs_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a job.
Parameters
-
connection
(type:GoogleApi.YouTubeReporting.V1.Connection.t
) - Connection to server -
job_id
(type:String.t
) - The ID of the job to retrieve. -
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"). -
:onBehalfOfContentOwner
(type:String.t
) - The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.YouTubeReporting.V1.Model.Job{}}
on success -
{:error, info}
on failure
Link to this function
youtubereporting_jobs_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
youtubereporting_jobs_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.ListJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists jobs.
Parameters
-
connection
(type:GoogleApi.YouTubeReporting.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"). -
:includeSystemManaged
(type:boolean()
) - If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System-managed jobs can neither be modified nor deleted. -
:onBehalfOfContentOwner
(type:String.t
) - The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). -
:pageSize
(type:integer()
) - Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to theListJobs
method.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.YouTubeReporting.V1.Model.ListJobsResponse{}}
on success -
{:error, info}
on failure
Link to this function
youtubereporting_jobs_reports_get(connection, job_id, report_id, optional_params \\ [], opts \\ [])
View SourceSpecs
youtubereporting_jobs_reports_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.Report.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the metadata of a specific report.
Parameters
-
connection
(type:GoogleApi.YouTubeReporting.V1.Connection.t
) - Connection to server -
job_id
(type:String.t
) - The ID of the job. -
report_id
(type:String.t
) - The ID of the report to retrieve. -
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"). -
:onBehalfOfContentOwner
(type:String.t
) - The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.YouTubeReporting.V1.Model.Report{}}
on success -
{:error, info}
on failure
Link to this function
youtubereporting_jobs_reports_list(connection, job_id, optional_params \\ [], opts \\ [])
View SourceSpecs
youtubereporting_jobs_reports_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.ListReportsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.
Parameters
-
connection
(type:GoogleApi.YouTubeReporting.V1.Connection.t
) - Connection to server -
job_id
(type:String.t
) - The ID of the job. -
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"). -
:createdAfter
(type:DateTime.t
) - If set, only reports created after the specified date/time are returned. -
:onBehalfOfContentOwner
(type:String.t
) - The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel). -
:pageSize
(type:integer()
) - Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to theListReports
method. -
:startTimeAtOrAfter
(type:DateTime.t
) - If set, only reports whose start time is greater than or equal the specified date/time are returned. -
:startTimeBefore
(type:DateTime.t
) - If set, only reports whose start time is smaller than the specified date/time are returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.YouTubeReporting.V1.Model.ListReportsResponse{}}
on success -
{:error, info}
on failure