| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="authorizedbuyersmarketplace_v1.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1.buyers.auctionPackages.html">auctionPackages</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets an auction package given its name.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List the auction packages subscribed by a buyer and its clients.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#subscribe">subscribe(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.</p> |
| <p class="toc_element"> |
| <code><a href="#subscribeClients">subscribeClients(auctionPackage, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.</p> |
| <p class="toc_element"> |
| <code><a href="#unsubscribe">unsubscribe(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.</p> |
| <p class="toc_element"> |
| <code><a href="#unsubscribeClients">unsubscribeClients(auctionPackage, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets an auction package given its name. |
| |
| Args: |
| name: string, Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. |
| "createTime": "A String", # Output only. Time the auction package was created. |
| "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` |
| "description": "A String", # Output only. A description of the auction package. |
| "displayName": "A String", # The display_name assigned to the auction package. |
| "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse. |
| "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>List the auction packages subscribed by a buyer and its clients. |
| |
| Args: |
| parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}` (required) |
| pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500. |
| pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for listing auction packages. |
| "auctionPackages": [ # The list of auction packages. |
| { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. |
| "createTime": "A String", # Output only. Time the auction package was created. |
| "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` |
| "description": "A String", # Output only. A description of the auction package. |
| "displayName": "A String", # The display_name assigned to the auction package. |
| "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse. |
| "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed. |
| }, |
| ], |
| "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="subscribe">subscribe(name, body=None, x__xgafv=None)</code> |
| <pre>Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer. |
| |
| Args: |
| name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for SubscribeAuctionPackage. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. |
| "createTime": "A String", # Output only. Time the auction package was created. |
| "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` |
| "description": "A String", # Output only. A description of the auction package. |
| "displayName": "A String", # The display_name assigned to the auction package. |
| "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse. |
| "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="subscribeClients">subscribeClients(auctionPackage, body=None, x__xgafv=None)</code> |
| <pre>Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect. |
| |
| Args: |
| auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for SubscribeAuctionPackageClients. |
| "clients": [ # Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. |
| "createTime": "A String", # Output only. Time the auction package was created. |
| "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` |
| "description": "A String", # Output only. A description of the auction package. |
| "displayName": "A String", # The display_name assigned to the auction package. |
| "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse. |
| "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="unsubscribe">unsubscribe(name, body=None, x__xgafv=None)</code> |
| <pre>Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer. |
| |
| Args: |
| name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for UnsubscribeAuctionPackage. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. |
| "createTime": "A String", # Output only. Time the auction package was created. |
| "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` |
| "description": "A String", # Output only. A description of the auction package. |
| "displayName": "A String", # The display_name assigned to the auction package. |
| "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse. |
| "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="unsubscribeClients">unsubscribeClients(auctionPackage, body=None, x__xgafv=None)</code> |
| <pre>Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect. |
| |
| Args: |
| auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for UnsubscribeAuctionPackage. |
| "clients": [ # Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. |
| "createTime": "A String", # Output only. Time the auction package was created. |
| "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` |
| "description": "A String", # Output only. A description of the auction package. |
| "displayName": "A String", # The display_name assigned to the auction package. |
| "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse. |
| "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` |
| "A String", |
| ], |
| "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed. |
| }</pre> |
| </div> |
| |
| </body></html> |
