GoogleApi.DFAReporting.V4.Api.Reports (google_api_dfa_reporting v0.31.0)

View Source

API calls for all endpoints tagged Reports.

Summary

Functions

dfareporting_reports_compatible_fields_query(connection, profile_id, optional_params \\ [], opts \\ [])

Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.

dfareporting_reports_delete(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

Deletes a report by its ID.

dfareporting_reports_files_get(connection, profile_id, report_id, file_id, optional_params \\ [], opts \\ [])

Retrieves a report file by its report ID and file ID. This method supports media download.

dfareporting_reports_files_list(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

Lists files for a report.

dfareporting_reports_get(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

Retrieves a report by its ID.

dfareporting_reports_insert(connection, profile_id, optional_params \\ [], opts \\ [])

Creates a report.

dfareporting_reports_list(connection, profile_id, optional_params \\ [], opts \\ [])

Retrieves list of reports.

dfareporting_reports_patch(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

Updates an existing report. This method supports patch semantics.

dfareporting_reports_run(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

Runs a report.

dfareporting_reports_update(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

Updates a report.

Functions

dfareporting_reports_compatible_fields_query(connection, profile_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_compatible_fields_query(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.CompatibleFields.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • 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.DFAReporting.V4.Model.Report.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.CompatibleFields{}} on success
  • {:error, info} on failure

dfareporting_reports_delete(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes a report by its ID.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • report_id (type: String.t) - The ID of the report.
  • 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, %{}} on success
  • {:error, info} on failure

dfareporting_reports_files_get(connection, profile_id, report_id, file_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_files_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a report file by its report ID and file ID. This method supports media download.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • report_id (type: String.t) - The ID of the report.
  • file_id (type: String.t) - The ID of the report file.
  • 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.DFAReporting.V4.Model.File{}} on success
  • {:error, info} on failure

dfareporting_reports_files_list(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_files_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.FileList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists files for a report.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • report_id (type: String.t) - The ID of the parent report.
  • 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").
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :pageToken (type: String.t) - The value of the nextToken from the previous result page.
    • :sortField (type: String.t) - The field by which to sort the list.
    • :sortOrder (type: String.t) - Order of sorted results.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.FileList{}} on success
  • {:error, info} on failure

dfareporting_reports_get(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.Report.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a report by its ID.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • report_id (type: String.t) - The ID of the report.
  • 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.DFAReporting.V4.Model.Report{}} on success
  • {:error, info} on failure

dfareporting_reports_insert(connection, profile_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.Report.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a report.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • 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.DFAReporting.V4.Model.Report.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.Report{}} on success
  • {:error, info} on failure

dfareporting_reports_list(connection, profile_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.ReportList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves list of reports.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • 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").
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :pageToken (type: String.t) - The value of the nextToken from the previous result page.
    • :scope (type: String.t) - The scope that defines which results are returned.
    • :sortField (type: String.t) - The field by which to sort the list.
    • :sortOrder (type: String.t) - Order of sorted results.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.ReportList{}} on success
  • {:error, info} on failure

dfareporting_reports_patch(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.Report.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing report. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • report_id (type: String.t) - The ID of the report.
  • 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.DFAReporting.V4.Model.Report.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.Report{}} on success
  • {:error, info} on failure

dfareporting_reports_run(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_run(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Runs a report.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • report_id (type: String.t) - The ID of the report.
  • 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").
    • :synchronous (type: boolean()) - If set and true, tries to run the report synchronously.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.File{}} on success
  • {:error, info} on failure

dfareporting_reports_update(connection, profile_id, report_id, optional_params \\ [], opts \\ [])

@spec dfareporting_reports_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V4.Model.Report.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a report.

Parameters

  • connection (type: GoogleApi.DFAReporting.V4.Connection.t) - Connection to server
  • profile_id (type: String.t) - The Campaign Manager 360 user profile ID.
  • report_id (type: String.t) - The ID of the report.
  • 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.DFAReporting.V4.Model.Report.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V4.Model.Report{}} on success
  • {:error, info} on failure