Returns the webDataStreams Resource.
+
+ acknowledgeUserDataCollection(property, body=None, x__xgafv=None)
Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
Close httplib2 connections.
@@ -163,6 +166,31 @@updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates Google Signals settings for a property.
acknowledgeUserDataCollection(property, body=None, x__xgafv=None)
+ Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
+
+Args:
+ property: string, Required. The property for which to acknowledge user data collection. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for AcknowledgeUserDataCollection RPC.
+ "acknowledgement": "A String", # Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."
+}
+
+ 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 AcknowledgeUserDataCollection RPC.
+}
+close()
Close httplib2 connections.diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index 46807ec35ee..2248dd2fd21 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -136,7 +136,7 @@
- applications()
-
Returns the applications Resource.
- @@ -94,6 +89,11 @@Returns the internalappsharingartifacts Resource.
+
+ monetization()
+
Returns the monetization Resource.
+ diff --git a/docs/dyn/androidpublisher_v3.monetization.html b/docs/dyn/androidpublisher_v3.monetization.html new file mode 100644 index 00000000000..79b21213698 --- /dev/null +++ b/docs/dyn/androidpublisher_v3.monetization.html @@ -0,0 +1,145 @@ + + + +
+ close()
Close httplib2 connections.
+
+ convertRegionPrices(packageName, body=None, x__xgafv=None)
Calculates the region prices, using today's exchange rate and country-specific pricing patterns, based on the price in the request for a set of regions.
+close()
+ Close httplib2 connections.+
convertRegionPrices(packageName, body=None, x__xgafv=None)
+ Calculates the region prices, using today's exchange rate and country-specific pricing patterns, based on the price in the request for a set of regions.
+
+Args:
+ packageName: string, Required. The app package name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ConvertRegionPrices.
+ "price": { # Represents an amount of money with its currency type. # The intital price to convert other regions from. Tax exclusive.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+}
+
+ 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 ConvertRegionPrices.
+ "convertedOtherRegionsPrice": { # Converted other regions prices. # Converted other regions prices in USD and EUR, to use for countries where Play doesn't support a country's local currency.
+ "eurPrice": { # Represents an amount of money with its currency type. # Price in EUR to use for the "Other regions" location exclusive of taxes.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "usdPrice": { # Represents an amount of money with its currency type. # Price in USD to use for the "Other regions" location exclusive of taxes.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ "convertedRegionPrices": { # Map from region code to converted region price.
+ "a_key": { # A converted region price.
+ "price": { # Represents an amount of money with its currency type. # The converted price tax inclusive.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "regionCode": "A String", # The region code of the region.
+ "taxAmount": { # Represents an amount of money with its currency type. # The tax amount of the converted price.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+ },
+}
+
+ close()
Close httplib2 connections.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+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/v2/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * 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: 'deal.displayName, deal.updateTime desc'
+ 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for listing finalized deals.
+ "finalizedDeals": [ # The list of finalized deals.
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved via this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, etc.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizeddeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ finalizedDeals()
+
Returns the finalizedDeals Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+ +Gets an auction package given its name.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List the auction packages subscribed by a buyer and its clients.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ subscribe(name, body=None, x__xgafv=None)
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.
+
+ subscribeClients(auctionPackage, body=None, x__xgafv=None)
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.
+
+ unsubscribe(name, body=None, x__xgafv=None)
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.
+
+ unsubscribeClients(auctionPackage, body=None, x__xgafv=None)
Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ 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.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ 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.
+}
+list_next(previous_request, previous_response)
+ 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. ++
subscribe(name, body=None, x__xgafv=None)
+ 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.
+}
+subscribeClients(auctionPackage, body=None, x__xgafv=None)
+ 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.
+}
+unsubscribe(name, body=None, x__xgafv=None)
+ 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.
+}
+unsubscribeClients(auctionPackage, body=None, x__xgafv=None)
+ 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.
+}
+
+ users()
+
Returns the users Resource.
+ +
+ activate(name, body=None, x__xgafv=None)
Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a new client.
+
+ deactivate(name, body=None, x__xgafv=None)
Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
+ +Gets a client with a given resource name.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the clients for the current buyer.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an existing client.
+activate(name, body=None, x__xgafv=None)
+ Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for activating a client.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A 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": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a new client.
+
+Args:
+ parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A 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": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A 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": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+deactivate(name, body=None, x__xgafv=None)
+ Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for disabling a client.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A 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": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+get(name, x__xgafv=None)
+ Gets a client with a given resource name.
+
+Args:
+ name: string, Required. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A 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": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all the clients for the current buyer.
+
+Args:
+ parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
+ filter: string, Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be `partnerClientId = "1234"`, in order to get only the client whose partnerClientId is "1234" in the response.
+ pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
+ pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.
+ 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 the list method.
+ "clients": [ # The returned list of clients.
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A 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": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
+}
+list_next(previous_request, previous_response)
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates an existing client.
+
+Args:
+ name: string, Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A 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": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+ updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, e.g. false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A 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": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+ activate(name, body=None, x__xgafv=None)
Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.
+
+ deactivate(name, body=None, x__xgafv=None)
Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.
+ +Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.
+ +Retrieves an existing client user.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all client users for a specified client.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+activate(name, body=None, x__xgafv=None)
+ Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for activating a client user.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.
+
+Args:
+ parent: string, Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+deactivate(name, body=None, x__xgafv=None)
+ Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for deactivating a client user.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+delete(name, x__xgafv=None)
+ Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
+}
+get(name, x__xgafv=None)
+ Retrieves an existing client user.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all client users for a specified client.
+
+Args:
+ parent: string, Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+ pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
+ pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.
+ 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 the list method.
+ "clientUsers": [ # The returned list of client users.
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ addCreative(deal, body=None, x__xgafv=None)
Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.
+
+ close()
Close httplib2 connections.
+ +Gets a finalized deal given its name.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ pause(name, body=None, x__xgafv=None)
Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals.
+
+ resume(name, body=None, x__xgafv=None)
Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals.
+
+ setReadyToServe(deal, body=None, x__xgafv=None)
Sets the given finalized deal as ready to serve. By default, deals are ready to serve as soon as they're finalized. A bidder can opt out of this feature by asking to be included in an allowlist. Once opted out, finalized deals belonging to the bidder and its child seats will not start serving until this method is called. This method is useful to the bidders who prefer to not receive bid requests before the creative is ready. This method only applies to programmatic guaranteed deals.
+addCreative(deal, body=None, x__xgafv=None)
+ Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.
+
+Args:
+ deal: string, Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for adding creative to be used in the bidding process for the finalized deal.
+ "creative": "A String", # Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved via this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, etc.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizeddeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets a finalized deal given its name.
+
+Args:
+ name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved via this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, etc.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizeddeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+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/v2/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * 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: 'deal.displayName, deal.updateTime desc'
+ 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for listing finalized deals.
+ "finalizedDeals": [ # The list of finalized deals.
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved via this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, etc.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizeddeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+list_next(previous_request, previous_response)
+ 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. ++
pause(name, body=None, x__xgafv=None)
+ Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals.
+
+Args:
+ name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for pausing a finalized deal.
+ "reason": "A String", # The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved via this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, etc.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizeddeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+resume(name, body=None, x__xgafv=None)
+ Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals.
+
+Args:
+ name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for resuming a finalized deal.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved via this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, etc.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizeddeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+setReadyToServe(deal, body=None, x__xgafv=None)
+ Sets the given finalized deal as ready to serve. By default, deals are ready to serve as soon as they're finalized. A bidder can opt out of this feature by asking to be included in an allowlist. Once opted out, finalized deals belonging to the bidder and its child seats will not start serving until this method is called. This method is useful to the bidders who prefer to not receive bid requests before the creative is ready. This method only applies to programmatic guaranteed deals.
+
+Args:
+ deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for setting ready to serve for a finalized deal.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved via this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, etc.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizeddeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+Returns the auctionPackages Resource.
+ +
+ clients()
+
Returns the clients Resource.
+ +
+ finalizedDeals()
+
Returns the finalizedDeals Resource.
+ +
+ proposals()
+
Returns the proposals Resource.
+ + +Returns the publisherProfiles Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ batchUpdate(parent, body=None, x__xgafv=None)
Batch updates multiple deals in the same proposal.
+
+ close()
Close httplib2 connections.
+ +Gets a deal given its name. The deal is returned at its head revision.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (e.g., seller making new updates), then the server can detect conflicts and reject the proposed changes.
+batchUpdate(parent, body=None, x__xgafv=None)
+ Batch updates multiple deals in the same proposal.
+
+Args:
+ parent: string, Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for batch updating deals.
+ "requests": [ # Required. List of request messages to update deals.
+ { # Request message for updating the deal at the given revision number.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "updateMask": "A String", # List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, e.g. false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ },
+ ],
+}
+
+ 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 batch updating deals.
+ "deals": [ # Deals updated.
+ { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ ],
+}
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets a deal given its name. The deal is returned at its head revision.
+
+Args:
+ name: string, Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
+
+Args:
+ parent: string, Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId} (required)
+ 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 ListDealsResponse.
+ 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 deals in a proposal.
+ "deals": [ # The list of deals.
+ { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+list_next(previous_request, previous_response)
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (e.g., seller making new updates), then the server can detect conflicts and reject the proposed changes.
+
+Args:
+ 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} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+ updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, e.g. false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a master companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A 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.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A 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": "A 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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.
+ "name": "A 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": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A 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": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # 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.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "geoTargeting": { # 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.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, e.g., URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, e.g., operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded via https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+ deals()
+
Returns the deals Resource.
+ +
+ accept(name, body=None, x__xgafv=None)
Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.
+
+ addNote(proposal, body=None, x__xgafv=None)
Creates a note for this proposal and sends to the seller.
+
+ cancelNegotiation(proposal, body=None, x__xgafv=None)
Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
+
+ close()
Close httplib2 connections.
+ +Gets a proposal using its name. The proposal is returned at most recent revision. revision.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists proposals. A filter expression (list filter syntax) may be specified to filter the results. This will not list finalized versions of proposals that are being renegotiated; to retrieve these use the finalizedProposals resource.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
+
+ sendRfp(buyer, body=None, x__xgafv=None)
Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
+accept(name, body=None, x__xgafv=None)
+ Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.
+
+Args:
+ name: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.
+ "proposalRevision": "A String", # The last known client revision number of the proposal.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A 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": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A 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": "A 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": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A 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": "A String", # Output only. The time when the proposal was last revised.
+}
+addNote(proposal, body=None, x__xgafv=None)
+ Creates a note for this proposal and sends to the seller.
+
+Args:
+ proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to add a note.
+ "note": { # A text note attached to the proposal to facilitate the communication between buyers and sellers. # The note to add.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A 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": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A 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": "A 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": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A 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": "A String", # Output only. The time when the proposal was last revised.
+}
+cancelNegotiation(proposal, body=None, x__xgafv=None)
+ Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
+
+Args:
+ proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to cancel an ongoing negotiation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A 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": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A 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": "A 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": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A 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": "A String", # Output only. The time when the proposal was last revised.
+}
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets a proposal using its name. The proposal is returned at most recent revision. revision.
+
+Args:
+ name: string, Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A 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": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A 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": "A 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": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A 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": "A String", # Output only. The time when the proposal was last revised.
+}
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists proposals. A filter expression (list filter syntax) may be specified to filter the results. This will not list finalized versions of proposals that are being renegotiated; to retrieve these use the finalizedProposals resource.
+
+Args:
+ parent: string, Required. Parent that owns the collection of proposals Format: `buyers/{accountId}` (required)
+ filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state
+ pageSize: integer, Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.
+ pageToken: string, The page token as returned from ListProposalsResponse.
+ 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 proposals.
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+ "proposals": [ # The list of proposals.
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A 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": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A 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": "A 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": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A 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": "A String", # Output only. The time when the proposal was last revised.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
+
+Args:
+ name: string, Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A 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": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A 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": "A 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": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A 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": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, e.g. false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A 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": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A 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": "A 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": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A 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": "A String", # Output only. The time when the proposal was last revised.
+}
+sendRfp(buyer, body=None, x__xgafv=None)
+ Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
+
+Args:
+ buyer: string, Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation.
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "client": "A String", # If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`.
+ "displayName": "A String", # Required. The display name of the proposal being created by this RFP.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
+ "flightStartTime": "A String", # Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Geo criteria IDs to be targeted. Refer to Geo tables.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Inventory sizes to be targeted.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "note": "A String", # A message that is sent to the publisher. Maximum length is 1024 characters.
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "publisherProfile": "A String", # Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A 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": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A 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": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A 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": "A 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": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A 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": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ close()
Close httplib2 connections.
+ +Gets the requested publisher profile by name.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists publisher profiles
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets the requested publisher profile by name.
+
+Args:
+ name: string, Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
+ "audienceDescription": "A String", # Description on the publisher's audience.
+ "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+ "displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
+ "domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
+ "A String",
+ ],
+ "isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true".
+ "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
+ "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
+ "mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
+ { # A mobile application that contains a external app ID, name, and app store.
+ "appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
+ "externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
+ "name": "A String", # The name of the app.
+ },
+ ],
+ "name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
+ "overview": "A String", # Overview of the publisher.
+ "pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
+ "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+ "publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
+ "samplePageUrl": "A String", # URL to a sample content page.
+ "topHeadlines": [ # Up to three key metrics and rankings. For example "#1 Mobile News Site for 20 Straight Months".
+ "A String",
+ ],
+}
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists publisher profiles
+
+Args:
+ parent: string, Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}` (required)
+ filter: string, Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) syntax.
+ 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 a previous ListPublisherProfilesResponse.
+ 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 profiles visible to the buyer.
+ "nextPageToken": "A String", # Token to fetch the next page of results.
+ "publisherProfiles": [ # The list of matching publisher profiles.
+ { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
+ "audienceDescription": "A String", # Description on the publisher's audience.
+ "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+ "displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
+ "domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
+ "A String",
+ ],
+ "isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true".
+ "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
+ "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
+ "mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
+ { # A mobile application that contains a external app ID, name, and app store.
+ "appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
+ "externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
+ "name": "A String", # The name of the app.
+ },
+ ],
+ "name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
+ "overview": "A String", # Overview of the publisher.
+ "pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
+ "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+ "publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
+ "samplePageUrl": "A String", # URL to a sample content page.
+ "topHeadlines": [ # Up to three key metrics and rankings. For example "#1 Mobile News Site for 20 Straight Months".
+ "A String",
+ ],
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ bidders()
+
Returns the bidders Resource.
+ +
+ buyers()
+
Returns the buyers Resource.
+ +
+ close()
Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+close()
+ Close httplib2 connections.+
new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
close()
Close httplib2 connections.
- create(parent, body=None, projectId=None, x__xgafv=None)
create(parent, body=None, gheConfigId=None, projectId=None, x__xgafv=None)
Create an association between a GCP project and a GitHub Enterprise server.
delete(name, configId=None, projectId=None, x__xgafv=None)
create(parent, body=None, projectId=None, x__xgafv=None)
+ create(parent, body=None, gheConfigId=None, projectId=None, x__xgafv=None)
Create an association between a GCP project and a GitHub Enterprise server. Args: @@ -128,6 +128,7 @@Method Details
"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint. } + gheConfigId: string, Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig’s resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character projectId: string, ID of the project. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudbuild_v1.projects.locations.githubEnterpriseConfigs.html b/docs/dyn/cloudbuild_v1.projects.locations.githubEnterpriseConfigs.html index 97a423be714..b962b73515c 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.githubEnterpriseConfigs.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.githubEnterpriseConfigs.html @@ -78,7 +78,7 @@Instance Methods
close()Close httplib2 connections.
-
+create(parent, body=None, projectId=None, x__xgafv=None)create(parent, body=None, gheConfigId=None, projectId=None, x__xgafv=None)Create an association between a GCP project and a GitHub Enterprise server.
@@ -99,7 +99,7 @@
delete(name, configId=None, projectId=None, x__xgafv=None)Method Details
create(parent, body=None, projectId=None, x__xgafv=None)
+ create(parent, body=None, gheConfigId=None, projectId=None, x__xgafv=None)
Create an association between a GCP project and a GitHub Enterprise server. Args: @@ -128,6 +128,7 @@@@ -1514,11 +1606,12 @@Method Details
"webhookKey": "A String", # The key that should be attached to webhook calls to the ReceiveWebhook endpoint. } + gheConfigId: string, Optional. The ID to use for the GithubEnterpriseConfig, which will become the final component of the GithubEnterpriseConfig’s resource name. ghe_config_id must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character projectId: string, ID of the project. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html index 9abbb950e35..a5f442f6617 100644 --- a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html @@ -459,7 +459,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -724,7 +724,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -766,7 +766,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v1.organizations.html b/docs/dyn/cloudresourcemanager_v1.organizations.html index 23a528a69fd..226480c2ce4 100644 --- a/docs/dyn/cloudresourcemanager_v1.organizations.html +++ b/docs/dyn/cloudresourcemanager_v1.organizations.html @@ -258,7 +258,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -519,7 +519,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -561,7 +561,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v1.projects.html b/docs/dyn/cloudresourcemanager_v1.projects.html index ea6c85f69b9..d3f8a51c341 100644 --- a/docs/dyn/cloudresourcemanager_v1.projects.html +++ b/docs/dyn/cloudresourcemanager_v1.projects.html @@ -380,7 +380,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -640,7 +640,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -682,7 +682,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v1beta1.organizations.html b/docs/dyn/cloudresourcemanager_v1beta1.organizations.html index 5f904fd2730..043dbcc58af 100644 --- a/docs/dyn/cloudresourcemanager_v1beta1.organizations.html +++ b/docs/dyn/cloudresourcemanager_v1beta1.organizations.html @@ -168,7 +168,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -258,7 +258,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -300,7 +300,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html index 41a80cf8bff..d828f1bacf8 100644 --- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html +++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html @@ -281,7 +281,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -375,7 +375,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -417,7 +417,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v2.folders.html b/docs/dyn/cloudresourcemanager_v2.folders.html index 8cf9018df7e..46fa411070c 100644 --- a/docs/dyn/cloudresourcemanager_v2.folders.html +++ b/docs/dyn/cloudresourcemanager_v2.folders.html @@ -251,7 +251,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -466,7 +466,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -508,7 +508,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v2beta1.folders.html b/docs/dyn/cloudresourcemanager_v2beta1.folders.html index d58ed67c7e5..68f26c236e1 100644 --- a/docs/dyn/cloudresourcemanager_v2beta1.folders.html +++ b/docs/dyn/cloudresourcemanager_v2beta1.folders.html @@ -251,7 +251,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -466,7 +466,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -508,7 +508,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v3.folders.html b/docs/dyn/cloudresourcemanager_v3.folders.html index 4b5eebec525..9bf4fd41674 100644 --- a/docs/dyn/cloudresourcemanager_v3.folders.html +++ b/docs/dyn/cloudresourcemanager_v3.folders.html @@ -268,7 +268,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -498,7 +498,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -540,7 +540,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v3.organizations.html b/docs/dyn/cloudresourcemanager_v3.organizations.html index f0f030a7e33..d95b4cfb924 100644 --- a/docs/dyn/cloudresourcemanager_v3.organizations.html +++ b/docs/dyn/cloudresourcemanager_v3.organizations.html @@ -164,7 +164,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -254,7 +254,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -296,7 +296,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v3.projects.html b/docs/dyn/cloudresourcemanager_v3.projects.html index 76c34b4e7d8..6dae34f3480 100644 --- a/docs/dyn/cloudresourcemanager_v3.projects.html +++ b/docs/dyn/cloudresourcemanager_v3.projects.html @@ -97,7 +97,7 @@Instance Methods
Retrieves the next page of results.
-
move(name, body=None, x__xgafv=None)Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.update` permission on the project and have `resourcemanager.projects.move` permission on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project.
+Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project.
patch(name, body=None, updateMask=None, x__xgafv=None)Updates the `display_name` and labels of the project identified by the specified `name` (for example, `projects/415104041262`). Deleting all labels requires an update mask for labels field. The caller must have `resourcemanager.projects.update` permission for this project.
@@ -276,7 +276,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -349,7 +349,7 @@Method Details
@@ -1202,11 +1271,12 @@move(name, body=None, x__xgafv=None)-Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.update` permission on the project and have `resourcemanager.projects.move` permission on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project. +Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project. Args: name: string, Required. The name of the project to move. (required) @@ -518,7 +518,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -560,7 +560,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v3.tagKeys.html b/docs/dyn/cloudresourcemanager_v3.tagKeys.html index b3e2b9d983b..3ccf85117b6 100644 --- a/docs/dyn/cloudresourcemanager_v3.tagKeys.html +++ b/docs/dyn/cloudresourcemanager_v3.tagKeys.html @@ -259,7 +259,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -400,7 +400,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -442,7 +442,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudresourcemanager_v3.tagValues.html b/docs/dyn/cloudresourcemanager_v3.tagValues.html index 275821c756a..7df44c95cf4 100644 --- a/docs/dyn/cloudresourcemanager_v3.tagValues.html +++ b/docs/dyn/cloudresourcemanager_v3.tagValues.html @@ -259,7 +259,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -400,7 +400,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -442,7 +442,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. diff --git a/docs/dyn/cloudsearch_v1.html b/docs/dyn/cloudsearch_v1.html index b9d678480ac..b63e1fff046 100644 --- a/docs/dyn/cloudsearch_v1.html +++ b/docs/dyn/cloudsearch_v1.html @@ -109,6 +109,11 @@Instance Methods
Returns the stats Resource.
++
+v1()+Returns the v1 Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/cloudsearch_v1.stats.query.searchapplications.html b/docs/dyn/cloudsearch_v1.stats.query.searchapplications.html index 51f56b90646..63650dced68 100644 --- a/docs/dyn/cloudsearch_v1.stats.query.searchapplications.html +++ b/docs/dyn/cloudsearch_v1.stats.query.searchapplications.html @@ -106,9 +106,9 @@Method Details
Returns: An object of the form: - { - "stats": [ - { + { # Response format for getting query stats at a search application level between given dates. + "stats": [ # Search application level query stats per date + { # Search application level query stats per date "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999. # Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned. "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month. "month": 42, # Month of date. Must be from 1 to 12. diff --git a/docs/dyn/cloudsearch_v1.v1.html b/docs/dyn/cloudsearch_v1.v1.html new file mode 100644 index 00000000000..783ab9b34c9 --- /dev/null +++ b/docs/dyn/cloudsearch_v1.v1.html @@ -0,0 +1,129 @@ + + + +Cloud Search API . v1
+Instance Methods
++
+close()Close httplib2 connections.
++
+initializeCustomer(body=None, x__xgafv=None)Initializes the customer. **Note:** This API requires an admin account to execute.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index 7591b8213bf..f18d5814e52 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -279,7 +279,7 @@initializeCustomer(body=None, x__xgafv=None)+Initializes the customer. **Note:** This API requires an admin account to execute. + +Args: + body: object, The request body. + The object takes the form of: + +{ # Request message for `InitializeCustomer` method. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}+Method Details
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. }, - "medium": "A String", # Immutable. The conversation medium. + "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. @@ -509,7 +509,7 @@Method Details
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. }, - "medium": "A String", # Immutable. The conversation medium. + "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. @@ -769,7 +769,7 @@Method Details
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. }, - "medium": "A String", # Immutable. The conversation medium. + "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. @@ -1015,7 +1015,7 @@Method Details
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. }, - "medium": "A String", # Immutable. The conversation medium. + "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. @@ -1263,7 +1263,7 @@Method Details
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. }, - "medium": "A String", # Immutable. The conversation medium. + "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. @@ -1493,7 +1493,7 @@Method Details
"name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. }, - "medium": "A String", # Immutable. The conversation medium. + "medium": "A String", # Immutable. The conversation medium, if unspecified will default to PHONE_CALL. "name": "A String", # Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} "runtimeAnnotations": [ # Output only. The annotations that were generated during the customer and agent interaction. { # An annotation that was generated during the customer and agent interaction. diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 91dab9006d3..d8dab3bb670 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -421,6 +421,8 @@Method Details
], "enabled": True or False, # Whether or not master authorized networks is enabled. }, + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -1022,6 +1024,8 @@Method Details
], "enabled": True or False, # Whether or not master authorized networks is enabled. }, + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -1526,6 +1530,8 @@Method Details
], "enabled": True or False, # Whether or not master authorized networks is enabled. }, + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -2773,6 +2779,8 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version + "desiredMeshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + }, "desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 00bbe854122..67d17bce5c8 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -525,6 +525,8 @@Method Details
], "enabled": True or False, # Whether or not master authorized networks is enabled. }, + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -1126,6 +1128,8 @@Method Details
], "enabled": True or False, # Whether or not master authorized networks is enabled. }, + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -1674,6 +1678,8 @@Method Details
], "enabled": True or False, # Whether or not master authorized networks is enabled. }, + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -2834,6 +2840,8 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version + "desiredMeshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + }, "desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index af83aefd0ee..8994e0181ef 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -438,6 +438,9 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -529,6 +532,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -622,6 +626,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1092,6 +1097,9 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -1183,6 +1191,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1276,6 +1285,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1649,6 +1659,9 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -1740,6 +1753,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1833,6 +1847,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2959,6 +2974,9 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version + "desiredMeshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index cebc1557200..9dac0eade56 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -193,6 +193,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -469,6 +470,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -611,6 +613,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index ca561f033fb..eebf3373806 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -549,6 +549,9 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -640,6 +643,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -733,6 +737,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1203,6 +1208,9 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -1294,6 +1302,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1387,6 +1396,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1804,6 +1814,9 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead. + "meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. @@ -1895,6 +1908,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1988,6 +2002,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -3020,6 +3035,9 @@Method Details
"enabled": True or False, # Whether or not master authorized networks is enabled. }, "desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version + "desiredMeshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. + "enableCertificates": True or False, # enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty). + }, "desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration. "componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration "enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 7335d2a60c0..0d8b4bcdccc 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -282,6 +282,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -558,6 +559,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -700,6 +702,7 @@Method Details
"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. }, + "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], diff --git a/docs/dyn/content_v2.shippingsettings.html b/docs/dyn/content_v2.shippingsettings.html index 55616ac6c54..3fb1524e798 100644 --- a/docs/dyn/content_v2.shippingsettings.html +++ b/docs/dyn/content_v2.shippingsettings.html @@ -192,11 +192,12 @@Method Details
{ "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. - "originAdministrativeArea": "A String", # Required. Shipping origin's state. - "originCity": "A String", # Required. Shipping origin's city. - "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). - "originPostalCode": "A String", # Required. Shipping origin. + "originAdministrativeArea": "A String", # Shipping origin's state. + "originCity": "A String", # Shipping origin's city. + "originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Shipping origin. "originStreetAddress": "A String", # Shipping origin's street address + "warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse. }, ], }, @@ -405,6 +406,28 @@Method Details
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`" }, ], + "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`. + { # A fulfillment warehouse, which stores and handles inventory. + "businessDayConfig": { # Business days of the warehouse. If not set, will be Monday to Friday by default. + "businessDays": [ # Regular business days, such as '"monday"'. May not be empty. + "A String", + ], + }, + "cutoffTime": { # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. + "hour": 42, # Required. Hour (24-hour clock) of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse. + "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse. + }, + "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item. + "name": "A String", # Required. The name of the warehouse. Must be unique within account. + "shippingAddress": { # Required. Shipping address of the warehouse. + "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). + "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). + "country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US"). + "postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required. + "streetAddress": "A String", # Street-level part of the address. + }, + }, + ], }, }, ], @@ -505,11 +528,12 @@Method Details
{ "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. - "originAdministrativeArea": "A String", # Required. Shipping origin's state. - "originCity": "A String", # Required. Shipping origin's city. - "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). - "originPostalCode": "A String", # Required. Shipping origin. + "originAdministrativeArea": "A String", # Shipping origin's state. + "originCity": "A String", # Shipping origin's city. + "originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Shipping origin. "originStreetAddress": "A String", # Shipping origin's street address + "warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse. }, ], }, @@ -718,6 +742,28 @@Method Details
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`" }, ], + "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`. + { # A fulfillment warehouse, which stores and handles inventory. + "businessDayConfig": { # Business days of the warehouse. If not set, will be Monday to Friday by default. + "businessDays": [ # Regular business days, such as '"monday"'. May not be empty. + "A String", + ], + }, + "cutoffTime": { # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. + "hour": 42, # Required. Hour (24-hour clock) of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse. + "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse. + }, + "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item. + "name": "A String", # Required. The name of the warehouse. Must be unique within account. + "shippingAddress": { # Required. Shipping address of the warehouse. + "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). + "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). + "country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US"). + "postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required. + "streetAddress": "A String", # Street-level part of the address. + }, + }, + ], }, }, ], @@ -810,11 +856,12 @@Method Details
{ "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. - "originAdministrativeArea": "A String", # Required. Shipping origin's state. - "originCity": "A String", # Required. Shipping origin's city. - "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). - "originPostalCode": "A String", # Required. Shipping origin. + "originAdministrativeArea": "A String", # Shipping origin's state. + "originCity": "A String", # Shipping origin's city. + "originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Shipping origin. "originStreetAddress": "A String", # Shipping origin's street address + "warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse. }, ], }, @@ -1023,6 +1070,28 @@Method Details
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`" }, ], + "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`. + { # A fulfillment warehouse, which stores and handles inventory. + "businessDayConfig": { # Business days of the warehouse. If not set, will be Monday to Friday by default. + "businessDays": [ # Regular business days, such as '"monday"'. May not be empty. + "A String", + ], + }, + "cutoffTime": { # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. + "hour": 42, # Required. Hour (24-hour clock) of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse. + "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse. + }, + "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item. + "name": "A String", # Required. The name of the warehouse. Must be unique within account. + "shippingAddress": { # Required. Shipping address of the warehouse. + "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). + "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). + "country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US"). + "postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required. + "streetAddress": "A String", # Street-level part of the address. + }, + }, + ], }Method Details
{ "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method. "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list. - "originAdministrativeArea": "A String", # Required. Shipping origin's state. - "originCity": "A String", # Required. Shipping origin's city. - "originCountry": "A String", # Required. Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). - "originPostalCode": "A String", # Required. Shipping origin. + "originAdministrativeArea": "A String", # Shipping origin's state. + "originCity": "A String", # Shipping origin's city. + "originCountry": "A String", # Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + "originPostalCode": "A String", # Shipping origin. "originStreetAddress": "A String", # Shipping origin's street address + "warehouseName": "A String", # The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse. }, ], }, @@ -1415,6 +1485,28 @@Method Details
"shipmentType": "A String", # Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`" }, ], + "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`. + { # A fulfillment warehouse, which stores and handles inventory. + "businessDayConfig": { # Business days of the warehouse. If not set, will be Monday to Friday by default. + "businessDays": [ # Regular business days, such as '"monday"'. May not be empty. + "A String", + ], + }, + "cutoffTime": { # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. + "hour": 42, # Required. Hour (24-hour clock) of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse. + "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse. + }, + "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item. + "name": "A String", # Required. The name of the warehouse. Must be unique within account. + "shippingAddress": { # Required. Shipping address of the warehouse. + "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC"). + "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs). + "country": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)(e.g. "US"). + "postalCode": "A String", # Required. Postal code or ZIP (e.g. "94043"). Required. + "streetAddress": "A String", # Street-level part of the address. + }, + }, + ], }, ], }
Updates a `Registration`'s management settings.
-Deletes a `Registration` resource. For `Registration` resources , this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` When an active domain is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain will not renew automatically unless the new owner sets up billing in Google Domains.
+Deletes a `Registration` resource. For `Registration` resources using usage billing, this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` This method works on any `Registration` resource using subscription billing, provided that the resource was created at least 1 day in the past. When an active domain is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain will not renew automatically unless the new owner sets up billing in Google Domains.
export(name, body=None, x__xgafv=None)
Exports a `Registration` resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain will not renew automatically unless the new owner sets up billing in Google Domains.
@@ -119,6 +119,9 @@
retrieveRegisterParameters(location, domainName=None, x__xgafv=None)
Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call `RegisterDomain`.
+
+ retrieveTransferParameters(location, domainName=None, x__xgafv=None)
Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not yet supported. Use the returned values to call `TransferDomain`.
searchDomains(location, query=None, x__xgafv=None)
Searches for available domain names similar to the provided query. Availability results from this method are approximate; call `RetrieveRegisterParameters` on a domain before registering to confirm availability.
@@ -128,6 +131,9 @@
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+ transfer(parent, body=None, x__xgafv=None)
Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not yet supported. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.
close()
@@ -380,7 +386,7 @@ delete(name, x__xgafv=None)
- Deletes a `Registration` resource. For `Registration` resources , this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` When an active domain is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain will not renew automatically unless the new owner sets up billing in Google Domains. +Deletes a `Registration` resource. For `Registration` resources using usage billing, this method works if: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED` * `state` is `TRANSFER_FAILED` This method works on any `Registration` resource using subscription billing, provided that the resource was created at least 1 day in the past. When an active domain is successfully deleted, you can continue to use the domain in [Google Domains](https://domains.google/) until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain will not renew automatically unless the new owner sets up billing in Google Domains. Args: name: string, Required. The name of the `Registration` to delete, in the format `projects/*/locations/*/registrations/*`. (required) @@ -468,7 +474,7 @@Method Details
Returns: An object of the form: - { # The `Registration` resource facilitates managing and configuring domain name registrations. To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. + { # The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar. First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. "contactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Required. Settings for contact information linked to the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureContactSettings` method. "adminContact": { # Details required for a contact associated with a `Registration`. # Required. The administrative contact for the `Registration`. "email": "A String", # Required. Email address of the contact. @@ -697,7 +703,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -736,7 +742,7 @@Method Details
{ # Response for the `ListRegistrations` method. "nextPageToken": "A String", # When present, there are more results to retrieve. Set `page_token` to this value on a subsequent call to get the next page of results. "registrations": [ # A list of `Registration`s. - { # The `Registration` resource facilitates managing and configuring domain name registrations. To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. + { # The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar. First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. "contactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Required. Settings for contact information linked to the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureContactSettings` method. "adminContact": { # Details required for a contact associated with a `Registration`. # Required. The administrative contact for the `Registration`. "email": "A String", # Required. Email address of the contact. @@ -961,7 +967,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # The `Registration` resource facilitates managing and configuring domain name registrations. To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. +{ # The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar. First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. "contactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Required. Settings for contact information linked to the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureContactSettings` method. "adminContact": { # Details required for a contact associated with a `Registration`. # Required. The administrative contact for the `Registration`. "email": "A String", # Required. Email address of the contact. @@ -1206,7 +1212,7 @@Method Details
"domainNotices": [ # The list of domain notices that you acknowledge. Call `RetrieveRegisterParameters` to see the notices that need acknowledgement. "A String", ], - "registration": { # The `Registration` resource facilitates managing and configuring domain name registrations. To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. # Required. The complete `Registration` resource to be created. + "registration": { # The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar. First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. # Required. The complete `Registration` resource to be created. "contactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Required. Settings for contact information linked to the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureContactSettings` method. "adminContact": { # Details required for a contact associated with a `Registration`. # Required. The administrative contact for the `Registration`. "email": "A String", # Required. Email address of the contact. @@ -1519,6 +1525,41 @@Method Details
}
retrieveTransferParameters(location, domainName=None, x__xgafv=None)
+ Gets parameters needed to transfer a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not yet supported. Use the returned values to call `TransferDomain`.
+
+Args:
+ location: string, Required. The location. Must be in the format `projects/*/locations/*`. (required)
+ domainName: string, Required. The domain name. Unicode domain names must be expressed in Punycode format.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for the `RetrieveTransferParameters` method.
+ "transferParameters": { # Parameters required to transfer a domain from another registrar. # Parameters to use when calling the `TransferDomain` method.
+ "currentRegistrar": "A String", # The registrar that currently manages the domain.
+ "domainName": "A String", # The domain name. Unicode domain names are expressed in Punycode format.
+ "nameServers": [ # The name servers that currently store the configuration of the domain.
+ "A String",
+ ],
+ "supportedPrivacy": [ # Contact privacy options that the domain supports.
+ "A String",
+ ],
+ "transferLockState": "A String", # Indicates whether the domain is protected by a transfer lock. For a transfer to succeed, this must show `UNLOCKED`. To unlock a domain, go to its current registrar.
+ "yearlyPrice": { # Represents an amount of money with its currency type. # Price to transfer or renew the domain for one year.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ },
+}
+searchDomains(location, query=None, x__xgafv=None)
Searches for available domain names similar to the provided query. Availability results from this method are approximate; call `RetrieveRegisterParameters` on a domain before registering to confirm availability. @@ -1579,7 +1620,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -1621,7 +1662,7 @@Method Details
"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. }, ], - "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. The `bindings` in a `Policy` can refer to up to 1,500 members; up to 250 of these members can be Google groups. Each occurrence of a member counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other member, then you can add another 1,450 members to the `bindings` in the `Policy`. { # Associates `members` with a `role`. "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. @@ -1670,4 +1711,255 @@Method Details
}
transfer(parent, body=None, x__xgafv=None)
+ Transfers a domain name from another registrar to Cloud Domains. For domains managed by Google Domains, transferring to Cloud Domains is not yet supported. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a `Registration` resource in state `TRANSFER_PENDING`. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state `ACTIVE`, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete the resource and retry the transfer.
+
+Args:
+ parent: string, Required. The parent resource of the `Registration`. Must be in the format `projects/*/locations/*`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for the `TransferDomain` method.
+ "authorizationCode": { # Defines an authorization code. # The domain's transfer authorization code. You can obtain this from the domain's current registrar.
+ "code": "A String", # The Authorization Code in ASCII. It can be used to transfer the domain to or from another registrar.
+ },
+ "contactNotices": [ # The list of contact notices that you acknowledge. The notices needed here depend on the values specified in `registration.contact_settings`.
+ "A String",
+ ],
+ "registration": { # The `Registration` resource facilitates managing and configuring domain name registrations. There are several ways to create a new `Registration` resource: To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. Another way to create a new `Registration` is to transfer an existing domain from another registrar. First, go to the current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call `RetrieveTransferParameters` to confirm that the domain is unlocked and to get values needed to build a call to `TransferDomain`. # Required. The complete `Registration` resource to be created. You can leave `registration.dns_settings` unset to import the domain's current DNS configuration from its current registrar. Use this option only if you are sure that the domain's current DNS service will not cease upon transfer, as is often the case for DNS services provided for free by the registrar.
+ "contactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Required. Settings for contact information linked to the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureContactSettings` method.
+ "adminContact": { # Details required for a contact associated with a `Registration`. # Required. The administrative contact for the `Registration`.
+ "email": "A String", # Required. Email address of the contact.
+ "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
+ "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+ "A String",
+ ],
+ "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+ "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+ "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+ "organization": "A String", # Optional. The name of the organization at the address.
+ "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+ "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+ "A String",
+ ],
+ "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+ "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+ "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+ "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+ },
+ },
+ "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
+ "registrantContact": { # Details required for a contact associated with a `Registration`. # Required. The registrant contact for the `Registration`. *Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain.* *Warning: For new `Registration`s, the registrant will receive an email confirmation that they must complete within 15 days to avoid domain suspension.*
+ "email": "A String", # Required. Email address of the contact.
+ "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
+ "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+ "A String",
+ ],
+ "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+ "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+ "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+ "organization": "A String", # Optional. The name of the organization at the address.
+ "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+ "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+ "A String",
+ ],
+ "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+ "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+ "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+ "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+ },
+ },
+ "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
+ "email": "A String", # Required. Email address of the contact.
+ "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
+ "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+ "A String",
+ ],
+ "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+ "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+ "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+ "organization": "A String", # Optional. The name of the organization at the address.
+ "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+ "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+ "A String",
+ ],
+ "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+ "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+ "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+ "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+ },
+ },
+ },
+ "createTime": "A String", # Output only. The creation timestamp of the `Registration` resource.
+ "dnsSettings": { # Defines the DNS configuration of a `Registration`, including name servers, DNSSEC, and glue records. # Settings controlling the DNS configuration of the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureDnsSettings` method.
+ "customDns": { # Configuration for an arbitrary DNS provider. # An arbitrary DNS provider identified by its name servers.
+ "dsRecords": [ # The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.
+ { # Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.
+ "algorithm": "A String", # The algorithm used to generate the referenced DNSKEY.
+ "digest": "A String", # The digest generated from the referenced DNSKEY.
+ "digestType": "A String", # The hash function used to generate the digest of the referenced DNSKEY.
+ "keyTag": 42, # The key tag of the record. Must be set in range 0 -- 65535.
+ },
+ ],
+ "nameServers": [ # Required. A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.
+ "A String",
+ ],
+ },
+ "glueRecords": [ # The list of glue records for this `Registration`. Commonly empty.
+ { # Defines a host on your domain that is a DNS name server for your domain and/or other domains. Glue records are a way of making the IP address of a name server known, even when it serves DNS queries for its parent domain. For example, when `ns.example.com` is a name server for `example.com`, the host `ns.example.com` must have a glue record to break the circular DNS reference.
+ "hostName": "A String", # Required. Domain name of the host in Punycode format.
+ "ipv4Addresses": [ # List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. `198.51.100.1`). At least one of `ipv4_address` and `ipv6_address` must be set.
+ "A String",
+ ],
+ "ipv6Addresses": [ # List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. `2001:db8::`). At least one of `ipv4_address` and `ipv6_address` must be set.
+ "A String",
+ ],
+ },
+ ],
+ "googleDomainsDns": { # Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/). # The free DNS zone provided by [Google Domains](https://domains.google/).
+ "dsRecords": [ # Output only. The list of DS records published for this domain. The list is automatically populated when `ds_state` is `DS_RECORDS_PUBLISHED`, otherwise it remains empty.
+ { # Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.
+ "algorithm": "A String", # The algorithm used to generate the referenced DNSKEY.
+ "digest": "A String", # The digest generated from the referenced DNSKEY.
+ "digestType": "A String", # The hash function used to generate the digest of the referenced DNSKEY.
+ "keyTag": 42, # The key tag of the record. Must be set in range 0 -- 65535.
+ },
+ ],
+ "dsState": "A String", # Required. The state of DS records for this domain. Used to enable or disable automatic DNSSEC.
+ "nameServers": [ # Output only. A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.
+ "A String",
+ ],
+ },
+ },
+ "domainName": "A String", # Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
+ "expireTime": "A String", # Output only. The expiration timestamp of the `Registration`.
+ "issues": [ # Output only. The set of issues with the `Registration` that require attention.
+ "A String",
+ ],
+ "labels": { # Set of labels associated with the `Registration`.
+ "a_key": "A String",
+ },
+ "managementSettings": { # Defines renewal, billing, and transfer settings for a `Registration`. # Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method.
+ "renewalMethod": "A String", # Output only. The renewal method for this `Registration`.
+ "transferLockState": "A String", # Controls whether the domain can be transferred to another registrar.
+ },
+ "name": "A String", # Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`.
+ "pendingContactSettings": { # Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. # Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not yet been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive.
+ "adminContact": { # Details required for a contact associated with a `Registration`. # Required. The administrative contact for the `Registration`.
+ "email": "A String", # Required. Email address of the contact.
+ "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
+ "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+ "A String",
+ ],
+ "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+ "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+ "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+ "organization": "A String", # Optional. The name of the organization at the address.
+ "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+ "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+ "A String",
+ ],
+ "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+ "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+ "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+ "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+ },
+ },
+ "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
+ "registrantContact": { # Details required for a contact associated with a `Registration`. # Required. The registrant contact for the `Registration`. *Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain.* *Warning: For new `Registration`s, the registrant will receive an email confirmation that they must complete within 15 days to avoid domain suspension.*
+ "email": "A String", # Required. Email address of the contact.
+ "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
+ "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+ "A String",
+ ],
+ "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+ "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+ "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+ "organization": "A String", # Optional. The name of the organization at the address.
+ "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+ "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+ "A String",
+ ],
+ "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+ "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+ "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+ "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+ },
+ },
+ "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
+ "email": "A String", # Required. Email address of the contact.
+ "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
+ "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
+ "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+ "A String",
+ ],
+ "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+ "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+ "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+ "organization": "A String", # Optional. The name of the organization at the address.
+ "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+ "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+ "A String",
+ ],
+ "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+ "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+ "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+ "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+ },
+ },
+ },
+ "state": "A String", # Output only. The state of the `Registration`
+ "supportedPrivacy": [ # Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports.
+ "A String",
+ ],
+ },
+ "validateOnly": True or False, # Validate the request without actually transferring the domain.
+ "yearlyPrice": { # Represents an amount of money with its currency type. # Required. Acknowledgement of the price to transfer or renew the domain for one year. Call `RetrieveTransferParameters` to obtain the price, which you must acknowledge.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+