google_api_you_tube_reporting v0.2.0 GoogleApi.YouTubeReporting.V1.Api.Jobs View Source

API calls for all endpoints tagged Jobs.

Link to this section Summary

Link to this section Functions

Link to this function

youtubereporting_jobs_create(connection, optional_params \\ [], opts \\ []) View Source

Creates a job and returns it.

Parameters

  • connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :onBehalfOfContentOwner (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 (Job):

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 Source

Deletes a job.

Parameters

  • connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
  • job_id (String.t): The ID of the job to delete.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :onBehalfOfContentOwner (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).

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 Source

Gets a job.

Parameters

  • connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
  • job_id (String.t): The ID of the job to retrieve.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :onBehalfOfContentOwner (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).

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 Source

Lists jobs.

Parameters

  • connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :includeSystemManaged (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 (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 (integer()): Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.
    • :pageToken (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 the `ListJobs` method.

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 Source

Gets the metadata of a specific report.

Parameters

  • connection (GoogleApi.YouTubeReporting.V1.Connection): Connection to server
  • job_id (String.t): The ID of the job.
  • report_id (String.t): The ID of the report to retrieve.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :onBehalfOfContentOwner (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).

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 Source

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.t): The ID of the job.
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :createdAfter (DateTime.t): If set, only reports created after the specified date/time are returned.
    • :onBehalfOfContentOwner (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 (integer()): Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.
    • :pageToken (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 the `ListReports` method.
    • :startTimeAtOrAfter (DateTime.t): If set, only reports whose start time is greater than or equal the specified date/time are returned.
    • :startTimeBefore (DateTime.t): 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