01README
Google Cloud authorizedbuyersmarketplace infrastructure models
02Models
@swamp/gcp/authorizedbuyersmarketplace/bidders-auctionpackagesv2026.04.23.1bidders_auctionpackages.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a auctionPackages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the auctionPackages |
fn sync()
Sync auctionPackages state from GCP
Resources
state(infinite)— Defines a segment of inventory that buyer wants to buy. It's created by buyer...
@swamp/gcp/authorizedbuyersmarketplace/bidders-finalizeddealsv2026.04.23.1bidders_finalizeddeals.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a finalizedDeals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the finalizedDeals |
fn sync()
Sync finalizedDeals state from GCP
fn set_ready_to_serve()
set ready to serve
Resources
state(infinite)— A finalized deal is a snapshot of the deal when both buyer and seller accept ...
@swamp/gcp/authorizedbuyersmarketplace/buyers-auctionpackagesv2026.04.23.1buyers_auctionpackages.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a auctionPackages
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the auctionPackages |
fn sync()
Sync auctionPackages state from GCP
fn subscribe()
subscribe
fn subscribe_clients(clients?: any)
subscribe clients
| Argument | Type | Description |
|---|---|---|
| clients? | any |
fn unsubscribe()
unsubscribe
fn unsubscribe_clients(clients?: any)
unsubscribe clients
| Argument | Type | Description |
|---|---|---|
| clients? | any |
Resources
state(infinite)— Defines a segment of inventory that buyer wants to buy. It's created by buyer...
@swamp/gcp/authorizedbuyersmarketplace/buyers-clientsv2026.04.23.1buyers_clients.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| displayName? | string | Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. |
| partnerClientId? | string | Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. |
| role? | enum | Required. The role assigned to the client. Each role implies a set of permissions granted to the client. |
| sellerVisible? | boolean | Whether the client will be visible to sellers. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a clients
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a clients
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the clients |
fn update(waitForReady?: boolean)
Update clients attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync()
Sync clients state from GCP
fn activate()
activate
fn deactivate()
deactivate
Resources
state(infinite)— A client represents an agency, a brand, or an advertiser customer of the buye...
@swamp/gcp/authorizedbuyersmarketplace/buyers-clients-usersv2026.04.23.1buyers_clients_users.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| email? | string | Required. The client user's email address that has to be unique across all users for the same client. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a users
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn delete(identifier: string)
Delete the users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn sync()
Sync users state from GCP
fn activate()
activate
fn deactivate()
deactivate
Resources
state(infinite)— A user of a client who has restricted access to the Marketplace and certain o...
@swamp/gcp/authorizedbuyersmarketplace/buyers-finalizeddealsv2026.04.23.1buyers_finalizeddeals.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a finalizedDeals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the finalizedDeals |
fn sync()
Sync finalizedDeals state from GCP
fn add_creative(creative?: any)
add creative
| Argument | Type | Description |
|---|---|---|
| creative? | any |
fn pause(reason?: any)
pause
| Argument | Type | Description |
|---|---|---|
| reason? | any |
fn resume()
resume
fn set_ready_to_serve()
set ready to serve
Resources
state(infinite)— A finalized deal is a snapshot of the deal when both buyer and seller accept ...
@swamp/gcp/authorizedbuyersmarketplace/buyers-proposalsv2026.04.23.1buyers_proposals.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| billedBuyer? | string | Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format: `buyers/{buyerAccountId}` |
| buyer? | string | Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}` |
| buyerContacts? | array | Contact information for the buyer. |
| buyerPrivateData? | object | Buyers are allowed to store certain types of private data in a proposal. |
| client? | string | Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` |
| dealType? | enum | Output only. Type of deal the proposal contains. |
| displayName? | string | Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. |
| isRenegotiating? | boolean | Output only. True if the proposal was previously finalized and is now being renegotiated. |
| lastUpdaterOrCommentorRole? | enum | Output only. The role of the last user that either updated the proposal or left a comment. |
| name? | string | Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} |
| notes? | array | A list of notes from the buyer and the seller attached to this proposal. |
| originatorRole? | enum | Output only. Indicates whether the buyer/seller created the proposal. |
| pausingConsented? | boolean | Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. |
| proposalRevision? | string | Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| publisherProfile? | string | Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. |
| sellerContacts? | array | Output only. Contact information for the seller. |
| state? | enum | Output only. Indicates the state of the proposal. |
| termsAndConditions? | string | Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. |
| updateTime? | string | Output only. The time when the proposal was last revised. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a proposals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the proposals |
fn update()
Update proposals attributes
fn sync()
Sync proposals state from GCP
fn accept(proposalRevision?: any)
accept
| Argument | Type | Description |
|---|---|---|
| proposalRevision? | any |
fn add_note(note?: any)
add note
| Argument | Type | Description |
|---|---|---|
| note? | any |
fn cancel_negotiation()
cancel negotiation
fn send_rfp(buyerContacts?: any, client?: any, displayName?: any, estimatedGrossSpend?: any, flightEndTime?: any, flightStartTime?: any, geoTargeting?: any, inventorySizeTargeting?: any, note?: any, preferredDealTerms?: any, programmaticGuaranteedTerms?: any, publisherProfile?: any)
send rfp
| Argument | Type | Description |
|---|---|---|
| buyerContacts? | any | |
| client? | any | |
| displayName? | any | |
| estimatedGrossSpend? | any | |
| flightEndTime? | any | |
| flightStartTime? | any | |
| geoTargeting? | any | |
| inventorySizeTargeting? | any | |
| note? | any | |
| preferredDealTerms? | any | |
| programmaticGuaranteedTerms? | any | |
| publisherProfile? | any |
Resources
state(infinite)— Represents a proposal in the Marketplace. A proposal is the unit of negotiati...
@swamp/gcp/authorizedbuyersmarketplace/buyers-proposals-dealsv2026.04.23.1buyers_proposals_deals.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| billedBuyer? | string | Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format: `buyers/{buyerAccountId}` |
| buyer? | string | Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}` |
| buyerPermissionType? | enum | Output only. The buyer permission type of the deal. |
| client? | string | Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}` |
| createTime? | string | Output only. The time of the deal creation. |
| creativeRequirements? | object | Message captures data about the creatives in the deal. |
| dealType? | enum | Output only. Type of deal. |
| deliveryControl? | object | Message contains details about how the deal will be paced. |
| description? | string | Output only. Free text description for the deal terms. |
| displayName? | string | Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal. |
| eligibleSeatIds? | array | Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace. |
| estimatedGrossSpend? | object | Represents an amount of money with its currency type. |
| flightEndTime? | string | Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals. |
| flightStartTime? | string | Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. |
| mediaPlanner? | object | Represents a media planner account. |
| name? | string | Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} |
| preferredDealTerms? | object | Pricing terms for Preferred Deals. |
| privateAuctionTerms? | object | Pricing terms for Private Auctions. |
| programmaticGuaranteedTerms? | object | Pricing terms for Programmatic Guaranteed Deals. |
| proposalRevision? | string | Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. |
| publisherProfile? | string | Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` |
| sellerTimeZone? | object | Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). |
| targeting? | object | Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. |
| updateTime? | string | Output only. The time when the deal was last updated. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a deals
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deals |
fn update()
Update deals attributes
fn sync()
Sync deals state from GCP
fn batch_update(requests?: any)
batch update
| Argument | Type | Description |
|---|---|---|
| requests? | any |
Resources
state(infinite)— A deal represents a segment of inventory for displaying ads that contains the...
@swamp/gcp/authorizedbuyersmarketplace/buyers-publisherprofilesv2026.04.23.1buyers_publisherprofiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a publisherProfiles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the publisherProfiles |
fn sync()
Sync publisherProfiles state from GCP
Resources
state(infinite)— The values in the publisher profile are supplied by the publisher. All fields...
03Previous Versions
2026.04.04.1Apr 4, 2026
- Updated: bidders_finalizeddeals, buyers_finalizeddeals, buyers_proposals_deals
2026.04.03.3Apr 3, 2026
- Updated: bidders_auctionpackages, bidders_finalizeddeals, buyers_auctionpackages, buyers_clients, buyers_clients_users, buyers_finalizeddeals, buyers_proposals, buyers_proposals_deals, buyers_publisherprofiles
2026.04.03.1Apr 3, 2026
- Updated: bidders_auctionpackages, bidders_finalizeddeals, buyers_auctionpackages, buyers_clients, buyers_clients_users, buyers_finalizeddeals, buyers_proposals, buyers_proposals_deals, buyers_publisherprofiles
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: bidders_auctionpackages, bidders_finalizeddeals, buyers_auctionpackages, buyers_clients, buyers_clients_users, buyers_finalizeddeals, buyers_proposals, buyers_proposals_deals, buyers_publisherprofiles
04Stats
A
100 / 100
Downloads
0
Archive size
49.5 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels