View Source GoogleApi.AdExchangeBuyer.V2beta1.Api.Buyers (google_api_ad_exchange_buyer v0.41.0)

API calls for all endpoints tagged Buyers.

Summary

Functions

List all errors that occurred in bid responses, with the number of bid responses affected for each reason.

List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.

Creates the specified filter set for the account with the given account ID.

Deletes the requested filter set from the account with the given account ID.

List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.

List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.

List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.

List all reasons for which bids were filtered, with the number of bids filtered for each reason.

Retrieves the requested filter set for the account with the given account ID.

Lists all filter sets for the account with the given account ID.

List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.

List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.

Functions

Link to this function

adexchangebuyer2_buyers_filter_sets_bid_metrics_list(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_bid_metrics_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListBidMetricsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all metrics that are measured in terms of number of bids.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListBidMetricsResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_bid_response_errors_list(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_bid_response_errors_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListBidResponseErrorsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all errors that occurred in bid responses, with the number of bid responses affected for each reason.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListBidResponseErrorsResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_bid_responses_without_bids_list(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_bid_responses_without_bids_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListBidResponsesWithoutBidsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListBidResponsesWithoutBidsResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_create(connection, buyers_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.FilterSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates the specified filter set for the account with the given account ID.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of ownerName. Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456
  • 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").
    • :isTransient (type: boolean()) - Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.
    • :body (type: GoogleApi.AdExchangeBuyer.V2beta1.Model.FilterSet.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.FilterSet{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_delete(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes the requested filter set from the account with the given account ID.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of name. Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of name. See documentation of buyersId.
  • 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.AdExchangeBuyer.V2beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_filtered_bid_requests_list(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_filtered_bid_requests_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListFilteredBidRequestsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListFilteredBidRequestsResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_filtered_bids_creatives_list(connection, buyers_id, filter_sets_id, creative_status_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_filtered_bids_creatives_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  integer(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListCreativeStatusBreakdownByCreativeResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • creative_status_id (type: integer()) - The ID of the creative status for which to retrieve a breakdown by creative. See creative-status-codes.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListCreativeStatusBreakdownByCreativeResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_filtered_bids_details_list(connection, buyers_id, filter_sets_id, creative_status_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_filtered_bids_details_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  integer(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListCreativeStatusBreakdownByDetailResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • creative_status_id (type: integer()) - The ID of the creative status for which to retrieve a breakdown by detail. See creative-status-codes. Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListCreativeStatusBreakdownByDetailResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_filtered_bids_list(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_filtered_bids_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListFilteredBidsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all reasons for which bids were filtered, with the number of bids filtered for each reason.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListFilteredBidsResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_get(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.FilterSet.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the requested filter set for the account with the given account ID.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of name. Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of name. See documentation of buyersId.
  • 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.AdExchangeBuyer.V2beta1.Model.FilterSet{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_impression_metrics_list(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_impression_metrics_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListImpressionMetricsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all metrics that are measured in terms of number of impressions.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListImpressionMetricsResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_list(connection, buyers_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListFilterSetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all filter sets for the account with the given account ID.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of ownerName. Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: bidders/123 - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123 - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListFilterSetsResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_losing_bids_list(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_losing_bids_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListLosingBidsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListLosingBidsResponse{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_buyers_filter_sets_non_billable_winning_bids_list(connection, buyers_id, filter_sets_id, optional_params \\ [], opts \\ [])

View Source
@spec adexchangebuyer2_buyers_filter_sets_non_billable_winning_bids_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListNonBillableWinningBidsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • buyers_id (type: String.t) - Part of filterSetName. Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: bidders/123/filterSets/abc - For an account-level filter set for the buyer account representing bidder 123: bidders/123/accounts/123/filterSets/abc - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: bidders/123/accounts/456/filterSets/abc
  • filter_sets_id (type: String.t) - Part of filterSetName. See documentation of buyersId.
  • 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()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V2beta1.Model.ListNonBillableWinningBidsResponse{}} on success
  • {:error, info} on failure