View Source GoogleApi.DoubleClickBidManager.V11.Api.Queries (google_api_double_click_bid_manager v0.25.1)

API calls for all endpoints tagged Queries.

Summary

Functions

doubleclickbidmanager_queries_createquery(connection, optional_params \\ [], opts \\ [])

Creates a query.

doubleclickbidmanager_queries_deletequery(connection, query_id, optional_params \\ [], opts \\ [])

Deletes a stored query as well as the associated stored reports.

doubleclickbidmanager_queries_getquery(connection, query_id, optional_params \\ [], opts \\ [])

Retrieves a stored query.

doubleclickbidmanager_queries_listqueries(connection, optional_params \\ [], opts \\ [])

Retrieves stored queries.

doubleclickbidmanager_queries_runquery(connection, query_id, optional_params \\ [], opts \\ [])

Runs a stored query to generate a report.

Functions

Link to this function

doubleclickbidmanager_queries_createquery(connection, optional_params \\ [], opts \\ [])

View Source 
@spec doubleclickbidmanager_queries_createquery(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DoubleClickBidManager.V11.Model.Query.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a query.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V11.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").
    • :asynchronous (type: boolean()) - If true, tries to run the query asynchronously. Only applicable when the frequency is ONE_TIME.
    • :body (type: GoogleApi.DoubleClickBidManager.V11.Model.Query.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DoubleClickBidManager.V11.Model.Query{}} on success
  • {:error, info} on failure
Link to this function

doubleclickbidmanager_queries_deletequery(connection, query_id, optional_params \\ [], opts \\ [])

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

Deletes a stored query as well as the associated stored reports.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V11.Connection.t) - Connection to server
  • query_id (type: String.t) - Query ID 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

doubleclickbidmanager_queries_getquery(connection, query_id, optional_params \\ [], opts \\ [])

View Source 
@spec doubleclickbidmanager_queries_getquery(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DoubleClickBidManager.V11.Model.Query.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a stored query.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V11.Connection.t) - Connection to server
  • query_id (type: String.t) - Query ID 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DoubleClickBidManager.V11.Model.Query{}} on success
  • {:error, info} on failure
Link to this function

doubleclickbidmanager_queries_listqueries(connection, optional_params \\ [], opts \\ [])

View Source 
@spec doubleclickbidmanager_queries_listqueries(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DoubleClickBidManager.V11.Model.ListQueriesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves stored queries.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V11.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").
    • :pageSize (type: integer()) - Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
    • :pageToken (type: String.t) - Optional pagination token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DoubleClickBidManager.V11.Model.ListQueriesResponse{}} on success
  • {:error, info} on failure
Link to this function

doubleclickbidmanager_queries_runquery(connection, query_id, optional_params \\ [], opts \\ [])

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

Runs a stored query to generate a report.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V11.Connection.t) - Connection to server
  • query_id (type: String.t) - Query ID to run.
  • 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").
    • :asynchronous (type: boolean()) - If true, tries to run the query asynchronously.
    • :body (type: GoogleApi.DoubleClickBidManager.V11.Model.RunQueryRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure