API Workflows
Stay organized with collections
Save and categorize content based on your preferences.
Get a list of Auction Packages
Call LIST API. Supports filtering by external_deal_id
Create a new Auction Package
- external_deal_id must be unique. Call LIST with external_deal_id to see if the id has already been used.
- Call Create API. A unique name will be assigned, and can be used to Get the created package.
- Call Get API to see details of the created Auction Package.
- Optionally, Upload a logo for the created package.
Update Auction Package
- If you do not store the created Auction Package name, call the LIST API filter by external_deal_id to get the Auction Package you want to update.
- Update the fields based on results from LIST API.
- Call Patch API to update the Auction Package. The “updateMask” is required, it indicates which fields you want the update to be applied to. Only fields that are allowed to be updated can be set in the “updateMask”.
Beta Process
The only difference between Beta VS GA is during beta, Auction Packages created need to have status set to “DISCOVERY_OBJECT_STATUS_PAUSED”, and status cannot be updated. PAUSED packages are not visible in DV3 UI. This is to provide exchanges a way to test out API integration without showing the test packages.
It is common to create all the “real” packages in beta as PAUSED and then “active” them once GAed.
Quota
1000 active packages per exchange.
1000 paused packages per exchange.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-13 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-13 UTC."],[[["Use the provided APIs to list, create, and update auction packages, ensuring the `external_deal_id` is unique for each package."],["During the beta phase, auction packages should be created with the status \"DISCOVERY_OBJECT_STATUS_PAUSED\" and cannot be updated or seen in the DV3 UI."],["When updating an auction package, use the `updateMask` field in the Patch API to specify the fields to be updated."],["There's a quota of 100 active and 100 paused auction packages per exchange."],["Once the feature is generally available, you can update the paused packages to activate them."]]],["Auction package management involves listing, creating, and updating. To list packages, use the LIST API, filtering by `external_deal_id`. Creation requires a unique `external_deal_id` and uses the Create API; retrieve package details with the Get API. Updating involves using the LIST API to retrieve the package, modifying fields, and using the Patch API with an `updateMask`. During beta, created packages must be \"PAUSED\" and cannot have their status changed. Each exchange has a quota of 1000 active and 1000 paused packages.\n"]]
