View Source GoogleApi.AdExchangeBuyer.V14.Api.Proposals (google_api_ad_exchange_buyer v0.41.0)

API calls for all endpoints tagged Proposals.

Summary

Functions

adexchangebuyer_proposals_get(connection, proposal_id, optional_params \\ [], opts \\ [])

Get a proposal given its id

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

Create the given list of proposals

adexchangebuyer_proposals_patch(connection, proposal_id, revision_number, update_action, optional_params \\ [], opts \\ [])

Update the given proposal. This method supports patch semantics.

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

Search for proposals using pql query

adexchangebuyer_proposals_setupcomplete(connection, proposal_id, optional_params \\ [], opts \\ [])

Update the given proposal to indicate that setup has been completed.

adexchangebuyer_proposals_update(connection, proposal_id, revision_number, update_action, optional_params \\ [], opts \\ [])

Update the given proposal

Functions

adexchangebuyer_proposals_get(connection, proposal_id, optional_params \\ [], opts \\ [])

@spec adexchangebuyer_proposals_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get a proposal given its id

Parameters

connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
proposal_id (type: String.t) - Id of the proposal to retrieve.
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.AdExchangeBuyer.V14.Model.Proposal{}} on success
{:error, info} on failure

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

@spec adexchangebuyer_proposals_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.CreateOrdersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create the given list of proposals

Parameters

connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
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.
- :body (type: GoogleApi.AdExchangeBuyer.V14.Model.CreateOrdersRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.CreateOrdersResponse{}} on success
{:error, info} on failure

adexchangebuyer_proposals_patch(connection, proposal_id, revision_number, update_action, optional_params \\ [], opts \\ [])

@spec adexchangebuyer_proposals_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update the given proposal. This method supports patch semantics.

Parameters

connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
proposal_id (type: String.t) - The proposal id to update.
revision_number (type: String.t) - The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.
update_action (type: String.t) - The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
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.
- :body (type: GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.Proposal{}} on success
{:error, info} on failure

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

@spec adexchangebuyer_proposals_search(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.GetOrdersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Search for proposals using pql query

Parameters

connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
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.
- :pqlQuery (type: String.t) - Query string to retrieve specific proposals.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.GetOrdersResponse{}} on success
{:error, info} on failure

adexchangebuyer_proposals_setupcomplete(connection, proposal_id, optional_params \\ [], opts \\ [])

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

Update the given proposal to indicate that setup has been completed.

Parameters

connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
proposal_id (type: String.t) - The proposal id for which the setup is complete
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, %{}} on success
{:error, info} on failure

adexchangebuyer_proposals_update(connection, proposal_id, revision_number, update_action, optional_params \\ [], opts \\ [])

@spec adexchangebuyer_proposals_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update the given proposal

Parameters

connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
proposal_id (type: String.t) - The proposal id to update.
revision_number (type: String.t) - The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.
update_action (type: String.t) - The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.
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.
- :body (type: GoogleApi.AdExchangeBuyer.V14.Model.Proposal.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.AdExchangeBuyer.V14.Model.Proposal{}} on success
{:error, info} on failure