happygapi.adexchangebuyer2.accounts — happygapi 0.4.8

Ad Exchange Buyer API II: accounts. Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals. See: https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts

clients-create$ clj

(clients-create$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/create

Required parameters: accountId

Optional parameters: none

Body:

{:role string, :entityName string, :partnerClientId string, :clientAccountId string, :visibleToSeller boolean, :status string, :entityId string, :entityType string, :clientName string}

Creates a new client buyer.

clients-get$ clj

(clients-get$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/get

Required parameters: clientAccountId, accountId

Optional parameters: none

Gets a client buyer with a given client account ID.

clients-invitations-create$ clj

(clients-invitations-create$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/invitations/create

Required parameters: accountId, clientAccountId

Optional parameters: none

Body:

{:email string, :clientAccountId string, :invitationId string}

Creates and sends out an email invitation to access an Ad Exchange client buyer account.

clients-invitations-get$ clj

(clients-invitations-get$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/invitations/get

Required parameters: clientAccountId, accountId, invitationId

Optional parameters: none

Retrieves an existing client user invitation.

clients-invitations-list$ clj

(clients-invitations-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/invitations/list

Required parameters: accountId, clientAccountId

Optional parameters: pageSize, pageToken

Lists all the client users invitations for a client with a given account ID.

clients-list$ clj

(clients-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/list

Required parameters: accountId

Optional parameters: pageSize, pageToken, partnerClientId

Lists all the clients for the current sponsor buyer.

clients-update$ clj

(clients-update$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/update

Required parameters: accountId, clientAccountId

Optional parameters: none

Body:

{:role string, :entityName string, :partnerClientId string, :clientAccountId string, :visibleToSeller boolean, :status string, :entityId string, :entityType string, :clientName string}

Updates an existing client buyer.

clients-users-get$ clj

(clients-users-get$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/users/get

Required parameters: userId, accountId, clientAccountId

Optional parameters: none

Retrieves an existing client user.

clients-users-list$ clj

(clients-users-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/users/list

Required parameters: accountId, clientAccountId

Optional parameters: pageToken, pageSize

Lists all the known client users for a specified sponsor buyer account ID.

clients-users-update$ clj

(clients-users-update$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/clients/users/update

Required parameters: accountId, clientAccountId, userId

Optional parameters: none

Body:

{:clientAccountId string, :status string, :userId string, :email string}

Updates an existing client user. Only the user status can be changed on update.

creatives-create$ clj

(creatives-create$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/create

Required parameters: accountId

Optional parameters: duplicateIdMode

Body:

{:video {:videoVastXml string, :videoUrl string}, :detectedProductCategories [integer], :servingRestrictions [{:status string, :disapprovalReasons [Disapproval], :contexts [ServingContext], :disapproval Disapproval}], :declaredClickThroughUrls [string], :advertiserName string, :adTechnologyProviders {:detectedProviderIds [string], :hasUnidentifiedProvider boolean}, :adChoicesDestinationUrl string, :impressionTrackingUrls [string], :dealsStatus string, :apiUpdateTime string, :detectedSensitiveCategories [integer], :openAuctionStatus string, :restrictedCategories [string], :corrections [{:type string, :details [string], :contexts [ServingContext]}], :detectedDomains [string], :detectedLanguages [string], :creativeId string, :native {:clickLinkUrl string, :headline string, :starRating number, :storeUrl string, :logo Image, :advertiserName string, :appIcon Image, :priceDisplayText string, :callToAction string, :clickTrackingUrl string, :videoUrl string, :image Image, :body string}, :detectedAdvertiserIds [string], :vendorIds [integer], :agencyId string, :version integer, :attributes [string], :accountId string, :clickThroughUrls [string], :html {:width integer, :snippet string, :height integer}}

Creates a creative.

creatives-dealAssociations-add$ clj

(creatives-dealAssociations-add$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/dealAssociations/add

Required parameters: accountId, creativeId

Optional parameters: none

Body:

{:association {:accountId string, :creativeId string, :dealsId string}}

Associate an existing deal with a creative.

creatives-dealAssociations-list$ clj

(creatives-dealAssociations-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/dealAssociations/list

Required parameters: accountId, creativeId

Optional parameters: query, pageSize, pageToken

List all creative-deal associations.

creatives-dealAssociations-remove$ clj

(creatives-dealAssociations-remove$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/dealAssociations/remove

Required parameters: creativeId, accountId

Optional parameters: none

Body:

{:association {:accountId string, :creativeId string, :dealsId string}}

Remove the association between a deal and a creative.

creatives-get$ clj

(creatives-get$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/get

Required parameters: creativeId, accountId

Optional parameters: none

Gets a creative.

creatives-list$ clj

(creatives-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/list

Required parameters: accountId

Optional parameters: pageToken, query, pageSize

Lists creatives.

creatives-stopWatching$ clj

(creatives-stopWatching$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/stopWatching

Required parameters: accountId, creativeId

Optional parameters: none

Body:

{}

Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.

creatives-update$ clj

(creatives-update$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/update

Required parameters: creativeId, accountId

Optional parameters: none

Body:

{:video {:videoVastXml string, :videoUrl string}, :detectedProductCategories [integer], :servingRestrictions [{:status string, :disapprovalReasons [Disapproval], :contexts [ServingContext], :disapproval Disapproval}], :declaredClickThroughUrls [string], :advertiserName string, :adTechnologyProviders {:detectedProviderIds [string], :hasUnidentifiedProvider boolean}, :adChoicesDestinationUrl string, :impressionTrackingUrls [string], :dealsStatus string, :apiUpdateTime string, :detectedSensitiveCategories [integer], :openAuctionStatus string, :restrictedCategories [string], :corrections [{:type string, :details [string], :contexts [ServingContext]}], :detectedDomains [string], :detectedLanguages [string], :creativeId string, :native {:clickLinkUrl string, :headline string, :starRating number, :storeUrl string, :logo Image, :advertiserName string, :appIcon Image, :priceDisplayText string, :callToAction string, :clickTrackingUrl string, :videoUrl string, :image Image, :body string}, :detectedAdvertiserIds [string], :vendorIds [integer], :agencyId string, :version integer, :attributes [string], :accountId string, :clickThroughUrls [string], :html {:width integer, :snippet string, :height integer}}

Updates a creative.

creatives-watch$ clj

(creatives-watch$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/creatives/watch

Required parameters: creativeId, accountId

Optional parameters: none

Body:

{:topic string}

Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.

finalizedProposals-list$ clj

(finalizedProposals-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/finalizedProposals/list

Required parameters: accountId

Optional parameters: pageToken, filterSyntax, pageSize, filter

List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.

finalizedProposals-pause$ clj

(finalizedProposals-pause$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/finalizedProposals/pause

Required parameters: accountId, proposalId

Optional parameters: none

Body:

{:reason string, :externalDealIds [string]}

Update given deals to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

finalizedProposals-resume$ clj

(finalizedProposals-resume$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/finalizedProposals/resume

Required parameters: accountId, proposalId

Optional parameters: none

Body:

{:externalDealIds [string]}

Update given deals to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

products-get$ clj

(products-get$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/products/get

Required parameters: productId, accountId

Optional parameters: none

Gets the requested product by ID.

products-list$ clj

(products-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/products/list

Required parameters: accountId

Optional parameters: pageToken, pageSize, filter

List all products visible to the buyer (optionally filtered by the specified PQL query).

proposals-accept$ clj

(proposals-accept$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/accept

Required parameters: accountId, proposalId

Optional parameters: none

Body:

{:proposalRevision string}

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.

proposals-addNote$ clj

(proposals-addNote$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/addNote

Required parameters: proposalId, accountId

Optional parameters: none

Body:

{:note {:createTime string, :noteId string, :creatorRole string, :proposalRevision string, :note string}}

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.

proposals-cancelNegotiation$ clj

(proposals-cancelNegotiation$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/cancelNegotiation

Required parameters: accountId, proposalId

Optional parameters: none

Body:

{}

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.

proposals-completeSetup$ clj

(proposals-completeSetup$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/completeSetup

Required parameters: proposalId, accountId

Optional parameters: none

Body:

{}

Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the is_setup_completed bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal.

proposals-create$ clj

(proposals-create$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/create

Required parameters: accountId

Optional parameters: none

Body:

{:isSetupComplete boolean, :displayName string, :billedBuyer {:accountId string}, :proposalRevision string, :originatorRole string, :updateTime string, :proposalState string, :notes [{:createTime string, :noteId string, :creatorRole string, :proposalRevision string, :note string}], :termsAndConditions string, :lastUpdaterOrCommentorRole string, :deals [{:syndicationProduct string, :description string, :createProductRevision string, :isSetupComplete boolean, :displayName string, :creativePreApprovalPolicy string, :createTime string, :targetingCriterion [TargetingCriteria], :dealServingMetadata DealServingMetadata, :updateTime string, :creativeSafeFrameCompatibility string, :programmaticCreativeSource string, :webPropertyCode string, :createProductId string, :buyerPrivateData PrivateData, :externalDealId string, :creativeRestrictions CreativeRestrictions, :proposalId string, :deliveryControl DeliveryControl, :availableStartTime string, :sellerContacts [ContactInformation], :dealTerms DealTerms, :dealId string, :targeting MarketplaceTargeting, :availableEndTime string}], :buyerPrivateData {:referenceId string}, :buyerContacts [{:email string, :name string}], :proposalId string, :buyer {:accountId string}, :sellerContacts [{:email string, :name string}], :privateAuctionId string, :seller {:subAccountId string, :accountId string}, :isRenegotiating boolean}

Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.

proposals-get$ clj

(proposals-get$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/get

Required parameters: accountId, proposalId

Optional parameters: none

Gets a proposal given its ID. The proposal is returned at its head revision.

proposals-list$ clj

(proposals-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/list

Required parameters: accountId

Optional parameters: filter, pageToken, pageSize, filterSyntax

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.

proposals-pause$ clj

(proposals-pause$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/pause

Required parameters: proposalId, accountId

Optional parameters: none

Body:

{:reason string}

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.

proposals-resume$ clj

(proposals-resume$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/resume

Required parameters: accountId, proposalId

Optional parameters: none

Body:

{}

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.

proposals-update$ clj

(proposals-update$ auth parameters body)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/proposals/update

Required parameters: proposalId, accountId

Optional parameters: none

Body:

{:isSetupComplete boolean, :displayName string, :billedBuyer {:accountId string}, :proposalRevision string, :originatorRole string, :updateTime string, :proposalState string, :notes [{:createTime string, :noteId string, :creatorRole string, :proposalRevision string, :note string}], :termsAndConditions string, :lastUpdaterOrCommentorRole string, :deals [{:syndicationProduct string, :description string, :createProductRevision string, :isSetupComplete boolean, :displayName string, :creativePreApprovalPolicy string, :createTime string, :targetingCriterion [TargetingCriteria], :dealServingMetadata DealServingMetadata, :updateTime string, :creativeSafeFrameCompatibility string, :programmaticCreativeSource string, :webPropertyCode string, :createProductId string, :buyerPrivateData PrivateData, :externalDealId string, :creativeRestrictions CreativeRestrictions, :proposalId string, :deliveryControl DeliveryControl, :availableStartTime string, :sellerContacts [ContactInformation], :dealTerms DealTerms, :dealId string, :targeting MarketplaceTargeting, :availableEndTime string}], :buyerPrivateData {:referenceId string}, :buyerContacts [{:email string, :name string}], :proposalId string, :buyer {:accountId string}, :sellerContacts [{:email string, :name string}], :privateAuctionId string, :seller {:subAccountId string, :accountId string}, :isRenegotiating boolean}

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.

publisherProfiles-get$ clj

(publisherProfiles-get$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/publisherProfiles/get

Required parameters: publisherProfileId, accountId

Optional parameters: none

Gets the requested publisher profile by id.

publisherProfiles-list$ clj

(publisherProfiles-list$ auth parameters)

https://developers.google.com/authorized-buyers/apis/reference/rest/api/reference/rest/v2beta1/accounts/publisherProfiles/list

Required parameters: accountId

Optional parameters: pageToken, pageSize

List all publisher profiles visible to the buyer