• Home
• com.google.apis
• google-api-services-adexchangebuyer2
• v2beta1-rev20230502-2.0.0
• source code
• AdExchangeBuyerII.Accounts.Proposals.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.adexchangebuyer2.v2beta1.AdExchangeBuyerII.Accounts.Proposals.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.adexchangebuyer2.v2beta1
Class AdExchangeBuyerII.Accounts.Proposals



java.lang.Object


com.google.api.services.adexchangebuyer2.v2beta1.AdExchangeBuyerII.Accounts.Proposals







Enclosing class:
AdExchangeBuyerII.Accounts




public class AdExchangeBuyerII.Accounts.Proposals
extends Object
The "proposals" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
AdExchangeBuyerII.Accounts.Proposals.Accept 


class 
AdExchangeBuyerII.Accounts.Proposals.AddNote 


class 
AdExchangeBuyerII.Accounts.Proposals.CancelNegotiation 


class 
AdExchangeBuyerII.Accounts.Proposals.CompleteSetup 


class 
AdExchangeBuyerII.Accounts.Proposals.Create 


class 
AdExchangeBuyerII.Accounts.Proposals.Get 


class 
AdExchangeBuyerII.Accounts.Proposals.List 


class 
AdExchangeBuyerII.Accounts.Proposals.Pause 


class 
AdExchangeBuyerII.Accounts.Proposals.Resume 


class 
AdExchangeBuyerII.Accounts.Proposals.Update 









Constructor Summary

Constructors 

Constructor and Description


Proposals() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AdExchangeBuyerII.Accounts.Proposals.Accept
accept(String accountId,
      String proposalId,
      AcceptProposalRequest content)
Mark the proposal as accepted at the given revision number.



AdExchangeBuyerII.Accounts.Proposals.AddNote
addNote(String accountId,
       String proposalId,
       AddNoteRequest content)
Create a new note and attach it to the proposal.



AdExchangeBuyerII.Accounts.Proposals.CancelNegotiation
cancelNegotiation(String accountId,
                 String proposalId,
                 CancelNegotiationRequest content)
Cancel an ongoing negotiation on a proposal.



AdExchangeBuyerII.Accounts.Proposals.CompleteSetup
completeSetup(String accountId,
             String proposalId,
             CompleteSetupRequest content)
You can opt-in to manually update proposals to indicate that setup is complete.



AdExchangeBuyerII.Accounts.Proposals.Create
create(String accountId,
      Proposal content)
Create the given proposal.



AdExchangeBuyerII.Accounts.Proposals.Get
get(String accountId,
   String proposalId)
Gets a proposal given its ID.



AdExchangeBuyerII.Accounts.Proposals.List
list(String accountId)
List proposals.



AdExchangeBuyerII.Accounts.Proposals.Pause
pause(String accountId,
     String proposalId,
     PauseProposalRequest content)
Update the given proposal to pause serving.



AdExchangeBuyerII.Accounts.Proposals.Resume
resume(String accountId,
      String proposalId,
      ResumeProposalRequest content)
Update the given proposal to resume serving.



AdExchangeBuyerII.Accounts.Proposals.Update
update(String accountId,
      String proposalId,
      Proposal content)
Update the given proposal at the client known revision number.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Proposals
public Proposals()









Method Detail





accept
public AdExchangeBuyerII.Accounts.Proposals.Accept accept(String accountId,
                                                          String proposalId,
                                                          AcceptProposalRequest content)
                                                   throws IOException
Mark the proposal as accepted at the given revision number. If the number does not match the
 server's revision number an `ABORTED` error message will be returned. This call updates the
 proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.
 Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally
 set within the proposal by the publisher.

 Create a request for the method "proposals.accept".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
accountId - Account ID of the buyer.
proposalId - The ID of the proposal to accept.
content - the AcceptProposalRequest
Returns:
the request
Throws:
IOException








addNote
public AdExchangeBuyerII.Accounts.Proposals.AddNote addNote(String accountId,
                                                            String proposalId,
                                                            AddNoteRequest content)
                                                     throws IOException
Create a new note and attach it to the proposal. The note is assigned a unique ID by the server.
 The proposal revision number will not increase when associated with a new note.

 Create a request for the method "proposals.addNote".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
accountId - Account ID of the buyer.
proposalId - The ID of the proposal to attach the note to.
content - the AddNoteRequest
Returns:
the request
Throws:
IOException








cancelNegotiation
public AdExchangeBuyerII.Accounts.Proposals.CancelNegotiation cancelNegotiation(String accountId,
                                                                                String proposalId,
                                                                                CancelNegotiationRequest content)
                                                                         throws IOException
Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if
 the proposal has been finalized, but only cancels a negotiation unilaterally.

 Create a request for the method "proposals.cancelNegotiation".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
accountId - Account ID of the buyer.
proposalId - The ID of the proposal to cancel negotiation for.
content - the CancelNegotiationRequest
Returns:
the request
Throws:
IOException








completeSetup
public AdExchangeBuyerII.Accounts.Proposals.CompleteSetup completeSetup(String accountId,
                                                                        String proposalId,
                                                                        CompleteSetupRequest content)
                                                                 throws IOException
You can opt-in to manually update proposals to indicate that setup is complete. By default,
 proposal setup is automatically completed after their deals are finalized. Contact your Technical
 Account Manager to opt in. Buyers can call this method when the proposal has been finalized, and
 all the required creatives have been uploaded using the Creatives API. This call updates the
 `is_setup_completed` field on the deals in the proposal, and notifies the seller. The server then
 advances the revision number of the most recent proposal. To mark an individual deal as ready to
 serve, call `buyers.finalizedDeals.setReadyToServe` in the Marketplace API.

 Create a request for the method "proposals.completeSetup".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
accountId - Account ID of the buyer.
proposalId - The ID of the proposal to mark as setup completed.
content - the CompleteSetupRequest
Returns:
the request
Throws:
IOException








create
public AdExchangeBuyerII.Accounts.Proposals.Create create(String accountId,
                                                          Proposal content)
                                                   throws IOException
Create the given proposal. Each created proposal and any deals it contains are assigned a unique
 ID by the server.

 Create a request for the method "proposals.create".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
accountId - Account ID of the buyer.
content - the Proposal
Returns:
the request
Throws:
IOException








get
public AdExchangeBuyerII.Accounts.Proposals.Get get(String accountId,
                                                    String proposalId)
                                             throws IOException
Gets a proposal given its ID. The proposal is returned at its head revision.

 Create a request for the method "proposals.get".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
accountId - Account ID of the buyer.
proposalId - The unique ID of the proposal
Returns:
the request
Throws:
IOException








list
public AdExchangeBuyerII.Accounts.Proposals.List list(String accountId)
                                               throws IOException
List proposals. A filter expression (PQL query) may be specified to filter the results. To
 retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the
 FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual
 behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's
 accountId in the request path.

 Create a request for the method "proposals.list".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
accountId - Account ID of the buyer.
Returns:
the request
Throws:
IOException








pause
public AdExchangeBuyerII.Accounts.Proposals.Pause pause(String accountId,
                                                        String proposalId,
                                                        PauseProposalRequest content)
                                                 throws IOException
Update the given proposal to pause serving. This method will set the
 `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal.
 It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a
 proposal that is not finalized or renegotiating.

 Create a request for the method "proposals.pause".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
accountId - Account ID of the buyer.
proposalId - The ID of the proposal to pause.
content - the PauseProposalRequest
Returns:
the request
Throws:
IOException








resume
public AdExchangeBuyerII.Accounts.Proposals.Resume resume(String accountId,
                                                          String proposalId,
                                                          ResumeProposalRequest content)
                                                   throws IOException
Update the given proposal to resume serving. This method will set the
 `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the
 proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the
 seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call
 ResumeProposal for a proposal that is not finalized or renegotiating.

 Create a request for the method "proposals.resume".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
accountId - Account ID of the buyer.
proposalId - The ID of the proposal to resume.
content - the ResumeProposalRequest
Returns:
the request
Throws:
IOException








update
public AdExchangeBuyerII.Accounts.Proposals.Update update(String accountId,
                                                          String proposalId,
                                                          Proposal content)
                                                   throws IOException
Update the given proposal at the client known revision number. If the server revision has
 advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be
 returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals
 in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a
 `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a
 `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the
 passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present
 at head.

 Create a request for the method "proposals.update".

 This request holds the parameters needed by the adexchangebuyer2 server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
accountId - Account ID of the buyer.
proposalId - The unique ID of the proposal.
content - the Proposal
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.