Skip to content

Commit

Permalink
feat(authorizedbuyersmarketplace): update the api
Browse files Browse the repository at this point in the history
#### authorizedbuyersmarketplace:v1

The following keys were added:
- resources.bidders.resources.auctionPackages.methods.list.parameters.orderBy (Total Keys: 2)
- resources.buyers.resources.auctionPackages.methods.list.parameters.orderBy (Total Keys: 2)
- schemas.MarketplaceTargeting.properties.excludedSensitiveCategoryIds (Total Keys: 4)
- schemas.MarketplaceTargeting.properties.verticalTargeting (Total Keys: 2)
  • Loading branch information
yoshi-automation committed May 10, 2024
1 parent eb4803b commit 0abbdbf
Show file tree
Hide file tree
Showing 6 changed files with 192 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h2>Instance Methods</h2>
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the auction packages. Buyers can use the URL path "/v1/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
Expand All @@ -90,12 +90,13 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List the auction packages. Buyers can use the URL path &quot;/v1/buyers/{accountId}/auctionPackages&quot; to list auction packages for the current buyer and its clients. Bidders can use the URL path &quot;/v1/bidders/{accountId}/auctionPackages&quot; to list auction packages for the bidder, its media planners, its buyers, and all their clients.

Args:
parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h3>Method Details</h3>
Args:
parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required)
filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth Example: &#x27;deal.displayName, deal.updateTime desc&#x27;
orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
pageToken: string, The page token as returned from ListFinalizedDealsResponse.
x__xgafv: string, V1 error format.
Expand Down Expand Up @@ -195,7 +195,7 @@ <h3>Method Details</h3>
&quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone, e.g. &quot;America/New_York&quot;.
&quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number, e.g. &quot;2019a&quot;.
},
&quot;targeting&quot;: { # Targeting represents different criteria that can be used to target inventory. 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. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
&quot;targeting&quot;: { # 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. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
&quot;daypartTargeting&quot;: { # Represents Daypart targeting. # Daypart targeting information.
&quot;dayParts&quot;: [ # The targeted weekdays and times
{ # Defines targeting for a period of time on a specific week day.
Expand All @@ -216,6 +216,9 @@ <h3>Method Details</h3>
],
&quot;timeZoneType&quot;: &quot;A String&quot;, # The time zone type of the day parts
},
&quot;excludedSensitiveCategoryIds&quot;: [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
&quot;A String&quot;,
],
&quot;geoTargeting&quot;: { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
&quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
&quot;A String&quot;,
Expand Down Expand Up @@ -309,6 +312,14 @@ <h3>Method Details</h3>
&quot;A String&quot;,
],
},
&quot;verticalTargeting&quot;: { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
&quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
&quot;A String&quot;,
],
&quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
&quot;A String&quot;,
],
},
&quot;videoTargeting&quot;: { # Represents targeting information about video. # Output only. Video targeting information.
&quot;excludedPositionTypes&quot;: [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
&quot;A String&quot;,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h2>Instance Methods</h2>
<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, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the auction packages. Buyers can use the URL path "/v1/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
Expand Down Expand Up @@ -143,12 +143,13 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List the auction packages. Buyers can use the URL path &quot;/v1/buyers/{accountId}/auctionPackages&quot; to list auction packages for the current buyer and its clients. Bidders can use the URL path &quot;/v1/bidders/{accountId}/auctionPackages&quot; to list auction packages for the bidder, its media planners, its buyers, and all their clients.

Args:
parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
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.
Expand Down
Loading

0 comments on commit 0abbdbf

Please sign in to comment.