google_api_you_tube_reporting v0.0.1 GoogleApi.YouTubeReporting.V1.Api.Jobs 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
youtubereporting_jobs_create(Tesla.Env.client, keyword) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.Job.t} | {:error, Tesla.Env.t}
Creates a job and returns it.
Parameters
- connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :on_behalf_of_content_owner (String): 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 (Job):
Returns
{:ok, %GoogleApi.YouTubeReporting.V1.Model.Job{}} on success {:error, info} on failure
youtubereporting_jobs_delete(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.Empty.t} | {:error, Tesla.Env.t}
Deletes a job.
Parameters
- connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
- job_id (String): The ID of the job to delete.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :on_behalf_of_content_owner (String): 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).
Returns
{:ok, %GoogleApi.YouTubeReporting.V1.Model.Empty{}} on success {:error, info} on failure
youtubereporting_jobs_get(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.Job.t} | {:error, Tesla.Env.t}
Gets a job.
Parameters
- connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
- job_id (String): The ID of the job to retrieve.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :on_behalf_of_content_owner (String): 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).
Returns
{:ok, %GoogleApi.YouTubeReporting.V1.Model.Job{}} on success {:error, info} on failure
youtubereporting_jobs_list(Tesla.Env.client, keyword) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.ListJobsResponse.t} | {:error, Tesla.Env.t}
Lists jobs.
Parameters
- connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :include_system_managed (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.
- :page_token (String): 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 the `ListJobs` method.
- :page_size (Integer): Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.
- :on_behalf_of_content_owner (String): 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).
Returns
{:ok, %GoogleApi.YouTubeReporting.V1.Model.ListJobsResponse{}} on success {:error, info} on failure
youtubereporting_jobs_reports_get(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.Report.t} | {:error, Tesla.Env.t}
Gets the metadata of a specific report.
Parameters
- connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
- job_id (String): The ID of the job.
- report_id (String): The ID of the report to retrieve.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :on_behalf_of_content_owner (String): 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).
Returns
{:ok, %GoogleApi.YouTubeReporting.V1.Model.Report{}} on success {:error, info} on failure
youtubereporting_jobs_reports_list(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.YouTubeReporting.V1.Model.ListReportsResponse.t} | {:error, Tesla.Env.t}
Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.
Parameters
- connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
- job_id (String): The ID of the job.
opts (KeywordList): [optional] Optional parameters
- :fields (String): Selector specifying which fields to include in a partial response.
- :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
- :__/xgafv (String): V1 error format.
- :callback (String): JSONP
- :alt (String): Data format for response.
- :key (String): 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.
- :access_token (String): OAuth access token.
- :quota_user (String): 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.
- :pp (Boolean): Pretty-print response.
- :bearer_token (String): OAuth bearer token.
- :oauth_token (String): OAuth 2.0 token for the current user.
- :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :created_after (String): If set, only reports created after the specified date/time are returned.
- :start_time_at_or_after (String): If set, only reports whose start time is greater than or equal the specified date/time are returned.
- :page_token (String): 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 the `ListReports` method.
- :page_size (Integer): Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.
- :on_behalf_of_content_owner (String): 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).
- :start_time_before (String): If set, only reports whose start time is smaller than the specified date/time are returned.
Returns
{:ok, %GoogleApi.YouTubeReporting.V1.Model.ListReportsResponse{}} on success {:error, info} on failure