google_api_dfa_reporting v0.8.0 GoogleApi.DFAReporting.V33.Api.Files View Source

API calls for all endpoints tagged Files.

Link to this section Summary

Functions

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

Link to this section Functions

Link to this function

dfareporting_files_get(connection, report_id, file_id, optional_params \\ [], opts \\ [])

View Source
dfareporting_files_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.DFAReporting.V33.Model.File.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • 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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V33.Model.File{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
dfareporting_files_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.FileList.t()} | {:error, Tesla.Env.t()}

Lists files for a user profile.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.Connection.t) - Connection to server
  • profile_id (type: String.t) - The DFA profile ID.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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.V33.Model.FileList{}} on success
  • {:error, info} on failure