/accounts

Retrieves the authenticated user's list of accounts.

/accounts/{id}

Gets one account by ID.

• id (path, required) — The account id

/accounts/{id}

Updates an existing account. This method supports patch semantics.

• id (path, required) — The account id
• confirmUnsafeAccountChange (query) — Confirmation for erasing bidder and cookie matching urls.

/accounts/{id}

Updates an existing account.

• id (path, required) — The account id
• confirmUnsafeAccountChange (query) — Confirmation for erasing bidder and cookie matching urls.

/billinginfo

Retrieves a list of billing information for all accounts of the authenticated user.

/billinginfo/{accountId}

Returns the billing information for one account specified by account ID.

• accountId (path, required) — The account id.

/billinginfo/{accountId}/{billingId}

Returns the budget information for the adgroup specified by the accountId and billingId.

• accountId (path, required) — The account id to get the budget information for.
• billingId (path, required) — The billing id to get the budget information for.

/billinginfo/{accountId}/{billingId}

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.

• accountId (path, required) — The account id associated with the budget being updated.
• billingId (path, required) — The billing id associated with the budget being updated.

/billinginfo/{accountId}/{billingId}

Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.

• accountId (path, required) — The account id associated with the budget being updated.
• billingId (path, required) — The billing id associated with the budget being updated.

/creatives

Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.

• accountId (query) — When specified, only creatives for the given account ids are returned.
• buyerCreativeId (query) — When specified, only creatives for the given buyer creative ids are returned.
• dealsStatusFilter (query) — When specified, only creatives having the given deals status are returned.
• maxResults (query, limit) — Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
• openAuctionStatusFilter (query) — When specified, only creatives having the given open auction status are returned.
• pageToken (query) — A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.

/creatives

Submit a new creative.

/creatives/{accountId}/{buyerCreativeId}

Gets the status for a single creative. A creative will be available 30-40 minutes after submission.

• accountId (path, required) — The id for the account that will serve this creative.
• buyerCreativeId (path, required) — The buyer-specific id for this creative.

/creatives/{accountId}/{buyerCreativeId}/addDeal/{dealId}

Add a deal id association for the creative.

• accountId (path, required) — The id for the account that will serve this creative.
• buyerCreativeId (path, required) — The buyer-specific id for this creative.
• dealId (path, required) — The id of the deal id to associate with this creative.

/creatives/{accountId}/{buyerCreativeId}/listDeals

Lists the external deal ids associated with the creative.

• accountId (path, required) — The id for the account that will serve this creative.
• buyerCreativeId (path, required) — The buyer-specific id for this creative.

/creatives/{accountId}/{buyerCreativeId}/removeDeal/{dealId}

Remove a deal id associated with the creative.

• accountId (path, required) — The id for the account that will serve this creative.
• buyerCreativeId (path, required) — The buyer-specific id for this creative.
• dealId (path, required) — The id of the deal id to disassociate with this creative.

/performancereport

Retrieves the authenticated user's list of performance metrics.

• accountId (query, required) — The account id to get the reports.
• endDateTime (query, required) — The end time of the report in ISO 8601 timestamp format using UTC.
• startDateTime (query, required) — The start time of the report in ISO 8601 timestamp format using UTC.
• maxResults (query, limit) — Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
• pageToken (query) — A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.

/pretargetingconfigs/{accountId}

Retrieves a list of the authenticated user's pretargeting configurations.

• accountId (path, required) — The account id to get the pretargeting configs for.

/pretargetingconfigs/{accountId}

Inserts a new pretargeting configuration.

• accountId (path, required) — The account id to insert the pretargeting config for.

/pretargetingconfigs/{accountId}/{configId}

Deletes an existing pretargeting config.

• accountId (path, required) — The account id to delete the pretargeting config for.
• configId (path, required) — The specific id of the configuration to delete.

/pretargetingconfigs/{accountId}/{configId}

Gets a specific pretargeting configuration

• accountId (path, required) — The account id to get the pretargeting config for.
• configId (path, required) — The specific id of the configuration to retrieve.

/pretargetingconfigs/{accountId}/{configId}

Updates an existing pretargeting config. This method supports patch semantics.

• accountId (path, required) — The account id to update the pretargeting config for.
• configId (path, required) — The specific id of the configuration to update.

/pretargetingconfigs/{accountId}/{configId}

Updates an existing pretargeting config.

• accountId (path, required) — The account id to update the pretargeting config for.
• configId (path, required) — The specific id of the configuration to update.

/privateauction/{privateAuctionId}/updateproposal

Update a given private auction proposal

• privateAuctionId (path, required) — The private auction id to be updated.

/products/search

Gets the requested product.

• pqlQuery (query) — The pql query used to query for products.

/products/{productId}

Gets the requested product by id.

• productId (path, required) — The id for the product to get the head revision for.

/proposals/insert

Create the given list of proposals

/proposals/search

Search for proposals using pql query

• pqlQuery (query) — Query string to retrieve specific proposals.

/proposals/{proposalId}

Get a proposal given its id

• proposalId (path, required) — Id of the proposal to retrieve.

/proposals/{proposalId}/deals

List all the deals for a given proposal

• proposalId (path, required) — The proposalId to get deals for. To search across all proposals specify order_id = '-' as part of the URL.
• pqlQuery (query) — Query string to retrieve specific deals.

/proposals/{proposalId}/deals/delete

Delete the specified deals from the proposal

• proposalId (path, required) — The proposalId to delete deals from.

/proposals/{proposalId}/deals/insert

Add new deals for the specified proposal

• proposalId (path, required) — proposalId for which deals need to be added.

/proposals/{proposalId}/deals/update

Replaces all the deals in the proposal with the passed in deals

• proposalId (path, required) — The proposalId to edit deals on.

/proposals/{proposalId}/notes

Get all the notes associated with a proposal

• proposalId (path, required) — The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.
• pqlQuery (query) — Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%"

/proposals/{proposalId}/notes/insert

Add notes to the proposal

• proposalId (path, required) — The proposalId to add notes for.

/proposals/{proposalId}/setupcomplete

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

• proposalId (path, required) — The proposal id for which the setup is complete

/proposals/{proposalId}/{revisionNumber}/{updateAction}

Update the given proposal. This method supports patch semantics.

• proposalId (path, required) — The proposal id to update.
• revisionNumber (path, required) — 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.
• updateAction (path, required) — The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.

/proposals/{proposalId}/{revisionNumber}/{updateAction}

Update the given proposal

• proposalId (path, required) — The proposal id to update.
• revisionNumber (path, required) — 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.
• updateAction (path, required) — The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.

/publisher/{accountId}/profiles

Gets the requested publisher profile(s) by publisher accountId.

• accountId (path, required) — The accountId of the publisher to get profiles for.