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

API calls for all endpoints tagged Queries.

Summary

Functions

Link to this function

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

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

Creates a new query.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V2.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").
    • :body (type: GoogleApi.DoubleClickBidManager.V2.Model.Query.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

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

Deletes an existing query as well as its generated reports.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V2.Connection.t) - Connection to server
  • query_id (type: String.t) - Required. The ID of the query 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_get(connection, query_id, optional_params \\ [], opts \\ [])

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

Retrieves a query.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V2.Connection.t) - Connection to server
  • query_id (type: String.t) - Required. The ID of the query 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.V2.Model.Query{}} on success
  • {:error, info} on failure
Link to this function

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

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

Lists queries created by the current user.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V2.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").
    • :orderBy (type: String.t) - Field to sort the list by. Accepts the following values: queryId (default) metadata.title The default sorting order is ascending. To specify descending order for a field, add the suffix desc to the field name. For example, queryId desc.
    • :pageSize (type: integer()) - Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
    • :pageToken (type: String.t) - A token identifying which page of results the server should return. Typically, this is the value of nextPageToken, returned from the previous call to the queries.list method. If unspecified, the first page of results is returned.
  • opts (type: keyword()) - Call options

Returns

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

doubleclickbidmanager_queries_reports_get(connection, query_id, report_id, optional_params \\ [], opts \\ [])

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

Retrieves a report.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V2.Connection.t) - Connection to server
  • query_id (type: String.t) - Required. The ID of the query that generated the report.
  • report_id (type: String.t) - Required. The ID of the query 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.V2.Model.Report{}} on success
  • {:error, info} on failure
Link to this function

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

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

Lists reports generated by the provided query.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V2.Connection.t) - Connection to server
  • query_id (type: String.t) - Required. The ID of the query that generated the reports.
  • 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").
    • :orderBy (type: String.t) - Field to sort the list by. Accepts the following values: * key.reportId (default) The default sorting order is ascending. To specify descending order for a field, add the suffix desc to the field name. For example, key.reportId desc.
    • :pageSize (type: integer()) - Maximum number of results per page. Must be between 1 and 100. Defaults to 100 if unspecified.
    • :pageToken (type: String.t) - A token identifying which page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to the queries.reports.list method. If unspecified, the first page of results is returned.
  • opts (type: keyword()) - Call options

Returns

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

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

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

Runs an existing query to generate a report.

Parameters

  • connection (type: GoogleApi.DoubleClickBidManager.V2.Connection.t) - Connection to server
  • query_id (type: String.t) - Required. The ID of the query 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").
    • :synchronous (type: boolean()) - Whether the query should be run synchronously. When true, the request won't return until the resulting report has finished running. This parameter is false by default. Setting this parameter to true is not recommended.
    • :body (type: GoogleApi.DoubleClickBidManager.V2.Model.RunQueryRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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