googleapis
Version:
Google APIs Client Library for Node.js
1,111 lines • 487 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace adexchangebuyer2_v2beta1 {
export interface Options extends GlobalOptions {
version: 'v2beta1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Ad Exchange Buyer API II
*
* Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.
*
* @example
* ```js
* const {google} = require('googleapis');
* const adexchangebuyer2 = google.adexchangebuyer2('v2beta1');
* ```
*/
export class Adexchangebuyer2 {
context: APIRequestContext;
accounts: Resource$Accounts;
bidders: Resource$Bidders;
buyers: Resource$Buyers;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An absolute date range, specified by its start date and end date. The supported range of dates begins 30 days before today and ends today. Validity checked upon filter set creation. If a filter set with an absolute date range is run at a later date more than 30 days after start_date, it will fail.
*/
export interface Schema$AbsoluteDateRange {
/**
* The end date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or after start_date.
*/
endDate?: Schema$Date;
/**
* The start date of the range (inclusive). Must be within the 30 days leading up to current date, and must be equal to or before end_date.
*/
startDate?: Schema$Date;
}
/**
* Request to accept a proposal.
*/
export interface Schema$AcceptProposalRequest {
/**
* The last known client revision number of the proposal.
*/
proposalRevision?: string | null;
}
/**
* A request for associating a deal and a creative.
*/
export interface Schema$AddDealAssociationRequest {
/**
* The association between a creative and a deal that should be added.
*/
association?: Schema$CreativeDealAssociation;
}
/**
* Request message for adding a note to a given proposal.
*/
export interface Schema$AddNoteRequest {
/**
* Details of the note to add.
*/
note?: Schema$Note;
}
/**
* Represents size of a single ad slot, or a creative.
*/
export interface Schema$AdSize {
/**
* The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
*/
height?: string | null;
/**
* The size type of the ad slot.
*/
sizeType?: string | null;
/**
* The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
*/
width?: string | null;
}
/**
* Detected ad technology provider information.
*/
export interface Schema$AdTechnologyProviders {
/**
* The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction.
*/
detectedProviderIds?: string[] | null;
/**
* Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction.
*/
hasUnidentifiedProvider?: boolean | null;
}
/**
* Output only. The app type the restriction applies to for mobile device.
*/
export interface Schema$AppContext {
/**
* The app types this restriction applies to.
*/
appTypes?: string[] | null;
}
/**
* Output only. The auction type the restriction applies to.
*/
export interface Schema$AuctionContext {
/**
* The auction types this restriction applies to.
*/
auctionTypes?: string[] | null;
}
/**
* The set of metrics that are measured in numbers of bids, representing how many bids with the specified dimension values were considered eligible at each stage of the bidding funnel;
*/
export interface Schema$BidMetricsRow {
/**
* The number of bids that Ad Exchange received from the buyer.
*/
bids?: Schema$MetricValue;
/**
* The number of bids that were permitted to compete in the auction.
*/
bidsInAuction?: Schema$MetricValue;
/**
* The number of bids for which the buyer was billed. Also called valid impressions as invalid impressions are not billed.
*/
billedImpressions?: Schema$MetricValue;
/**
* The number of bids that won the auction.
*/
impressionsWon?: Schema$MetricValue;
/**
* The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View).
*/
measurableImpressions?: Schema$MetricValue;
/**
* The number of bids that won the auction and also won the mediation waterfall (if any).
*/
reachedQueries?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The number of bids for which the corresponding impression was viewable (as defined by Active View).
*/
viewableImpressions?: Schema$MetricValue;
}
/**
* The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status.
*/
export interface Schema$BidResponseWithoutBidsStatusRow {
/**
* The number of impressions for which there was a bid response with the specified status.
*/
impressionCount?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The status specifying why the bid responses were considered to have no applicable bids.
*/
status?: string | null;
}
/**
* Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID.
*/
export interface Schema$Buyer {
/**
* Authorized Buyers account ID of the buyer.
*/
accountId?: string | null;
}
/**
* The number of impressions with the specified dimension values where the corresponding bid request or bid response was not successful, as described by the specified callout status.
*/
export interface Schema$CalloutStatusRow {
/**
* The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes).
*/
calloutStatusId?: number | null;
/**
* The number of impressions for which there was a bid request or bid response with the specified callout status.
*/
impressionCount?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* Request to cancel an ongoing negotiation.
*/
export interface Schema$CancelNegotiationRequest {
}
/**
* A client resource represents a client buyer—an agency, a brand, or an advertiser customer of the sponsor buyer. Users associated with the client buyer have restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the client buyer. All fields are required unless otherwise specified.
*/
export interface Schema$Client {
/**
* The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.
*/
clientAccountId?: string | null;
/**
* Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty. Maximum length of 255 characters is allowed.
*/
clientName?: string | null;
/**
* Numerical identifier of the client entity. The entity can be an advertiser, a brand, or an agency. This identifier is unique among all the entities with the same type. The value of this field is ignored if the entity type is not provided. A list of all known advertisers with their identifiers is available in the [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt) file. A list of all known brands with their identifiers is available in the [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt) file. A list of all known agencies with their identifiers is available in the [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt) file.
*/
entityId?: string | null;
/**
* The name of the entity. This field is automatically fetched based on the type and ID. The value of this field is ignored in create and update operations.
*/
entityName?: string | null;
/**
* An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
*/
entityType?: string | null;
/**
* Optional arbitrary unique identifier of this client buyer from the standpoint of its Ad Exchange sponsor buyer. This field can be used to associate a client buyer with the identifier in the namespace of its sponsor buyer, lookup client buyers by that identifier and verify whether an Ad Exchange counterpart of a given client buyer already exists. If present, must be unique among all the client buyers for its Ad Exchange sponsor buyer.
*/
partnerClientId?: string | null;
/**
* The role which is assigned to the client buyer. Each role implies a set of permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
*/
role?: string | null;
/**
* The status of the client buyer.
*/
status?: string | null;
/**
* Whether the client buyer will be visible to sellers.
*/
visibleToSeller?: boolean | null;
}
/**
* A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer. The only way a new client user can be created is through accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified.
*/
export interface Schema$ClientUser {
/**
* Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation.
*/
clientAccountId?: string | null;
/**
* User's email address. The value of this field is ignored in an update operation.
*/
email?: string | null;
/**
* The status of the client user.
*/
status?: string | null;
/**
* The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation.
*/
userId?: string | null;
}
/**
* An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.
*/
export interface Schema$ClientUserInvitation {
/**
* Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.
*/
clientAccountId?: string | null;
/**
* The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.
*/
email?: string | null;
/**
* The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.
*/
invitationId?: string | null;
}
/**
* Request message for indicating that the proposal's setup step is complete.
*/
export interface Schema$CompleteSetupRequest {
}
/**
* Contains information on how a buyer or seller can be reached.
*/
export interface Schema$ContactInformation {
/**
* Email address for the contact.
*/
email?: string | null;
/**
* The name of the contact.
*/
name?: string | null;
}
/**
* Output only. Shows any corrections that were applied to this creative.
*/
export interface Schema$Correction {
/**
* The contexts for the correction.
*/
contexts?: Schema$ServingContext[];
/**
* Additional details about what was corrected.
*/
details?: string[] | null;
/**
* The type of correction that was applied to the creative.
*/
type?: string | null;
}
/**
* A creative and its classification data.
*/
export interface Schema$Creative {
/**
* The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
*/
accountId?: string | null;
/**
* The link to AdChoices destination page.
*/
adChoicesDestinationUrl?: string | null;
/**
* Output only. The detected ad technology providers.
*/
adTechnologyProviders?: Schema$AdTechnologyProviders;
/**
* The name of the company being advertised in the creative.
*/
advertiserName?: string | null;
/**
* The agency ID for this creative.
*/
agencyId?: string | null;
/**
* Output only. The last update timestamp of the creative through the API.
*/
apiUpdateTime?: string | null;
/**
* All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
*/
attributes?: string[] | null;
/**
* The set of destination URLs for the creative.
*/
clickThroughUrls?: string[] | null;
/**
* Output only. Shows any corrections that were applied to this creative.
*/
corrections?: Schema$Correction[];
/**
* The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
*/
creativeId?: string | null;
/**
* Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
*/
dealsStatus?: string | null;
/**
* The set of declared destination URLs for the creative.
*/
declaredClickThroughUrls?: string[] | null;
/**
* Output only. Detected advertiser IDs, if any.
*/
detectedAdvertiserIds?: string[] | null;
/**
* Output only. The detected domains for this creative.
*/
detectedDomains?: string[] | null;
/**
* Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes.
*/
detectedLanguages?: string[] | null;
/**
* Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.
*/
detectedProductCategories?: number[] | null;
/**
* Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
*/
detectedSensitiveCategories?: number[] | null;
/**
* An HTML creative.
*/
html?: Schema$HtmlContent;
/**
* The set of URLs to be called to record an impression.
*/
impressionTrackingUrls?: string[] | null;
/**
* A native creative.
*/
native?: Schema$NativeContent;
/**
* Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method.
*/
openAuctionStatus?: string | null;
/**
* All restricted categories for the ads that may be shown from this creative.
*/
restrictedCategories?: string[] | null;
/**
* Output only. The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS versus HTTP request, or the type of auction).
*/
servingRestrictions?: Schema$ServingRestriction[];
/**
* All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values.
*/
vendorIds?: number[] | null;
/**
* Output only. The version of this creative.
*/
version?: number | null;
/**
* A video creative.
*/
video?: Schema$VideoContent;
}
/**
* The association between a creative and a deal.
*/
export interface Schema$CreativeDealAssociation {
/**
* The account the creative belongs to.
*/
accountId?: string | null;
/**
* The ID of the creative associated with the deal.
*/
creativeId?: string | null;
/**
* The externalDealId for the deal associated with the creative.
*/
dealsId?: string | null;
}
/**
* Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals.
*/
export interface Schema$CreativeRestrictions {
/**
* The format of the environment that the creatives will be displayed in.
*/
creativeFormat?: string | null;
creativeSpecifications?: Schema$CreativeSpecification[];
/**
* Skippable video ads allow viewers to skip ads after 5 seconds.
*/
skippableAdType?: string | null;
}
/**
* Specifies the size of the creative.
*/
export interface Schema$CreativeSize {
/**
* What formats are allowed by the publisher. If this repeated field is empty then all formats are allowed. For example, if this field contains AllowedFormatType.AUDIO then the publisher only allows an audio ad (without any video).
*/
allowedFormats?: string[] | null;
/**
* For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO
*/
companionSizes?: Schema$Size[];
/**
* The creative size type.
*/
creativeSizeType?: string | null;
/**
* Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE.
*/
nativeTemplate?: string | null;
/**
* For regular or video creative size type, specifies the size of the creative
*/
size?: Schema$Size;
/**
* The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO.
*/
skippableAdType?: string | null;
}
/**
* Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager.
*/
export interface Schema$CreativeSpecification {
/**
* Companion sizes may be filled in only when this is a video creative.
*/
creativeCompanionSizes?: Schema$AdSize[];
/**
* The size of the creative.
*/
creativeSize?: Schema$AdSize;
}
/**
* The number of bids with the specified dimension values that did not win the auction (either were filtered pre-auction or lost the auction), as described by the specified creative status.
*/
export interface Schema$CreativeStatusRow {
/**
* The number of bids with the specified status.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).
*/
creativeStatusId?: number | null;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs.
*/
export interface Schema$CriteriaTargeting {
/**
* A list of numeric IDs to be excluded.
*/
excludedCriteriaIds?: string[] | null;
/**
* A list of numeric IDs to be included.
*/
targetedCriteriaIds?: string[] | null;
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week.
*/
export interface Schema$DayPart {
/**
* The day of the week to target. If unspecified, applicable to all days.
*/
dayOfWeek?: string | null;
/**
* The ending time of the day for the ad to show (minute level granularity). The end time is exclusive. This field is not available for filtering in PQL queries.
*/
endTime?: Schema$TimeOfDay;
/**
* The starting time of day for the ad to show (minute level granularity). The start time is inclusive. This field is not available for filtering in PQL queries.
*/
startTime?: Schema$TimeOfDay;
}
/**
* Specifies the day part targeting criteria.
*/
export interface Schema$DayPartTargeting {
/**
* A list of day part targeting criterion.
*/
dayParts?: Schema$DayPart[];
/**
* The timezone to use for interpreting the day part targeting.
*/
timeZoneType?: string | null;
}
/**
* A deal represents a segment of inventory for displaying ads on. A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.
*/
export interface Schema$Deal {
/**
* Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not required for Private Auction deals or Preferred Deals.
*/
availableEndTime?: string | null;
/**
* Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
*/
availableStartTime?: string | null;
/**
* Buyer private data (hidden from seller).
*/
buyerPrivateData?: Schema$PrivateData;
/**
* The product ID from which this deal was created. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
createProductId?: string | null;
/**
* Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
createProductRevision?: string | null;
/**
* Output only. The time of the deal creation.
*/
createTime?: string | null;
/**
* Output only. Specifies the creative pre-approval policy.
*/
creativePreApprovalPolicy?: string | null;
/**
* Output only. Restricitions about the creatives associated with the deal (for example, size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.
*/
creativeRestrictions?: Schema$CreativeRestrictions;
/**
* Output only. Specifies whether the creative is safeFrame compatible.
*/
creativeSafeFrameCompatibility?: string | null;
/**
* Output only. A unique deal ID for the deal (server-assigned).
*/
dealId?: string | null;
/**
* Output only. Metadata about the serving status of this deal.
*/
dealServingMetadata?: Schema$DealServingMetadata;
/**
* The negotiable terms of the deal.
*/
dealTerms?: Schema$DealTerms;
/**
* The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher.
*/
deliveryControl?: Schema$DeliveryControl;
/**
* Description for the deal terms.
*/
description?: string | null;
/**
* The name of the deal.
*/
displayName?: string | null;
/**
* Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc.
*/
externalDealId?: string | null;
/**
* Output only. True, if the buyside inventory setup is complete for this deal.
*/
isSetupComplete?: boolean | null;
/**
* Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer.
*/
programmaticCreativeSource?: string | null;
/**
* Output only. ID of the proposal that this deal is part of.
*/
proposalId?: string | null;
/**
* Output only. Seller contact information for the deal.
*/
sellerContacts?: Schema$ContactInformation[];
/**
* The syndication product associated with the deal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
*/
syndicationProduct?: string | null;
/**
* Output only. Specifies the subset of inventory targeted by the deal.
*/
targeting?: Schema$MarketplaceTargeting;
/**
* The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.
*/
targetingCriterion?: Schema$TargetingCriteria[];
/**
* Output only. The time when the deal was last updated.
*/
updateTime?: string | null;
/**
* The web property code for the seller copied over from the product.
*/
webPropertyCode?: string | null;
}
/**
* Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true.
*/
export interface Schema$DealPauseStatus {
/**
* The buyer's reason for pausing, if the buyer paused the deal.
*/
buyerPauseReason?: string | null;
/**
* The role of the person who first paused this deal.
*/
firstPausedBy?: string | null;
/**
* True, if the buyer has paused the deal unilaterally.
*/
hasBuyerPaused?: boolean | null;
/**
* True, if the seller has paused the deal unilaterally.
*/
hasSellerPaused?: boolean | null;
/**
* The seller's reason for pausing, if the seller paused the deal.
*/
sellerPauseReason?: string | null;
}
/**
* Message captures metadata about the serving status of a deal.
*/
export interface Schema$DealServingMetadata {
/**
* Output only. Tracks which parties (if any) have paused a deal.
*/
dealPauseStatus?: Schema$DealPauseStatus;
}
/**
* The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (for example, fixed price, auction) and expected impressions from the publisher.
*/
export interface Schema$DealTerms {
/**
* Visibility of the URL in bid requests. (default: BRANDED)
*/
brandingType?: string | null;
/**
* Publisher provided description for the terms.
*/
description?: string | null;
/**
* Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller.
*/
estimatedGrossSpend?: Schema$Price;
/**
* Non-binding estimate of the impressions served per day. Can be set by buyer or seller.
*/
estimatedImpressionsPerDay?: string | null;
/**
* The terms for guaranteed fixed price deals.
*/
guaranteedFixedPriceTerms?: Schema$GuaranteedFixedPriceTerms;
/**
* The terms for non-guaranteed auction deals.
*/
nonGuaranteedAuctionTerms?: Schema$NonGuaranteedAuctionTerms;
/**
* The terms for non-guaranteed fixed price deals.
*/
nonGuaranteedFixedPriceTerms?: Schema$NonGuaranteedFixedPriceTerms;
/**
* The time zone name. For deals with Cost Per Day billing, defines the time zone used to mark the boundaries of a day. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
*/
sellerTimeZone?: string | null;
}
/**
* Message contains details about how the deals will be paced.
*/
export interface Schema$DeliveryControl {
/**
* Output only. Specified the creative blocking levels to be applied.
*/
creativeBlockingLevel?: string | null;
/**
* Output only. Specifies how the impression delivery will be paced.
*/
deliveryRateType?: string | null;
/**
* Output only. Specifies any frequency caps.
*/
frequencyCaps?: Schema$FrequencyCap[];
}
/**
* Output only. The reason and details for a disapproval.
*/
export interface Schema$Disapproval {
/**
* Additional details about the reason for disapproval.
*/
details?: string[] | null;
/**
* The categorized reason for disapproval.
*/
reason?: string | null;
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* The number of filtered bids with the specified dimension values that have the specified creative.
*/
export interface Schema$FilteredBidCreativeRow {
/**
* The number of bids with the specified creative.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the creative.
*/
creativeId?: string | null;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (for example, creative status), that have the specified detail.
*/
export interface Schema$FilteredBidDetailRow {
/**
* The number of bids with the specified detail.
*/
bidCount?: Schema$MetricValue;
/**
* The ID of the detail, can be numeric or text. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.
*/
detail?: string | null;
/**
* Note: this field will be deprecated, use "detail" field instead. When "detail" field represents an integer value, this field is populated as the same integer value "detail" field represents, otherwise this field will be 0. The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.
*/
detailId?: number | null;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
}
/**
* A set of filters that is applied to a request for data. Within a filter set, an AND operation is performed across the filters represented by each field. An OR operation is performed across the filters represented by the multiple values of a repeated field, for example, "format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)".
*/
export interface Schema$FilterSet {
/**
* An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone.
*/
absoluteDateRange?: Schema$AbsoluteDateRange;
/**
* The set of dimensions along which to break down the response; may be empty. If multiple dimensions are requested, the breakdown is along the Cartesian product of the requested dimensions.
*/
breakdownDimensions?: string[] | null;
/**
* The ID of the creative on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/x/accounts/x/filterSets/x` pattern.
*/
creativeId?: string | null;
/**
* The ID of the deal on which to filter; optional. This field may be set only for a filter set that accesses account-level troubleshooting data, for example, one whose name matches the `bidders/x/accounts/x/filterSets/x` pattern.
*/
dealId?: string | null;
/**
* The environment on which to filter; optional.
*/
environment?: string | null;
/**
* Creative format bidded on or allowed to bid on, can be empty.
*/
format?: string | null;
/**
* Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.
*/
formats?: string[] | null;
/**
* A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/x/filterSets/x` (for accessing bidder-level troubleshooting data) - `bidders/x/accounts/x/filterSets/x` (for accessing account-level troubleshooting data) This field is required in create operations.
*/
name?: string | null;
/**
* The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (for example, if non-empty, results must match any one of the platforms).
*/
platforms?: string[] | null;
/**
* For Open Bidding partners only. The list of publisher identifiers on which to filter; may be empty. The filters represented by multiple publisher identifiers are ORed together.
*/
publisherIdentifiers?: string[] | null;
/**
* An open-ended realtime time range, defined by the aggregation start timestamp.
*/
realtimeTimeRange?: Schema$RealtimeTimeRange;
/**
* A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone.
*/
relativeDateRange?: Schema$RelativeDateRange;
/**
* For Authorized Buyers only. The list of IDs of the seller (publisher) networks on which to filter; may be empty. The filters represented by multiple seller network IDs are ORed together (for example, if non-empty, results must match any one of the publisher networks). See [seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids) file for the set of existing seller network IDs.
*/
sellerNetworkIds?: number[] | null;
/**
* The granularity of time intervals if a time series breakdown is preferred; optional.
*/
timeSeriesGranularity?: string | null;
}
/**
* Represents a list of targeted and excluded mobile application IDs that publishers own. Mobile application IDs are from App Store and Google Play Store. 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.
*/
export interface Schema$FirstPartyMobileApplicationTargeting {
/**
* A list of application IDs to be excluded.
*/
excludedAppIds?: string[] | null;
/**
* A list of application IDs to be included.
*/
targetedAppIds?: string[] | null;
}
/**
* Frequency cap.
*/
export interface Schema$FrequencyCap {
/**
* The maximum number of impressions that can be served to a user within the specified time period.
*/
maxImpressions?: number | null;
/**
* 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.
*/
numTimeUnits?: number | null;
/**
* The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
*/
timeUnitType?: string | null;
}
/**
* Terms for Programmatic Guaranteed Deals.
*/
export interface Schema$GuaranteedFixedPriceTerms {
/**
* Fixed price for the specified buyer.
*/
fixedPrices?: Schema$PricePerBuyer[];
/**
* Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.
*/
guaranteedImpressions?: string | null;
/**
* Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.
*/
guaranteedLooks?: string | null;
/**
* The lifetime impression cap for CPM sponsorship deals. The deal will stop serving when the cap is reached.
*/
impressionCap?: string | null;
/**
* Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
*/
minimumDailyLooks?: string | null;
/**
* For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached.
*/
percentShareOfVoice?: string | null;
/**
* 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.
*/
reservationType?: string | null;
}
/**
* HTML content for a creative.
*/
export interface Schema$HtmlContent {
/**
* The height of the HTML snippet in pixels.
*/
height?: number | null;
/**
* The HTML snippet that displays the ad when inserted in the web page.
*/
snippet?: string | null;
/**
* The width of the HTML snippet in pixels.
*/
width?: number | null;
}
/**
* An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved.
*/
export interface Schema$Image {
/**
* Image height in pixels.
*/
height?: number | null;
/**
* The URL of the image.
*/
url?: string | null;
/**
* Image width in pixels.
*/
width?: number | null;
}
/**
* The set of metrics that are measured in numbers of impressions, representing how many impressions with the specified dimension values were considered eligible at each stage of the bidding funnel.
*/
export interface Schema$ImpressionMetricsRow {
/**
* The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable.
*/
availableImpressions?: Schema$MetricValue;
/**
* The number of impressions for which Ad Exchange sent the buyer a bid request.
*/
bidRequests?: Schema$MetricValue;
/**
* The number of impressions that match the buyer's inventory pretargeting.
*/
inventoryMatches?: Schema$MetricValue;
/**
* The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid.
*/
responsesWithBids?: Schema$MetricValue;
/**
* The values of all dimensions associated with metric values in this row.
*/
rowDimensions?: Schema$RowDimensions;
/**
* The number of impressions for which the buyer successfully sent a response to Ad Exchange.
*/
successfulResponses?: Schema$MetricValue;
}
/**
* Represents the size of an ad unit that can be targeted on an ad request. It only applies to Private Auction, AdX Preferred Deals and Auction Packages. This targeting does not apply to Programmatic Guaranteed and Preferred Deals in Ad Manager.
*/
export interface Schema$InventorySizeTargeting {
/**
* A list of inventory sizes to be excluded.
*/
excludedInventorySizes?: Schema$AdSize[];
/**
* A list of inventory sizes to be included.
*/
targetedInventorySizes?: Schema$AdSize[];
}
/**
* Response message for listing the metrics that are measured in number of bids.
*/
export interface Schema$ListBidMetricsResponse {
/**
* List of rows, each containing a set of bid metrics.
*/
bidMetricsRows?: Schema$BidMetricsRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListBidMetricsRequest.pageToken field in the subsequent call to the bidMetrics.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all reasons that bid responses resulted in an error.
*/
export interface Schema$ListBidResponseErrorsResponse {
/**
* List of rows, with counts of bid responses aggregated by callout status.
*/
calloutStatusRows?: Schema$CalloutStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListBidResponseErrorsRequest.pageToken field in the subsequent call to the bidResponseErrors.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Response message for listing all reasons that bid responses were considered to have no applicable bids.
*/
export interface Schema$ListBidResponsesWithoutBidsResponse {
/**
* List of rows, with counts of bid responses without bids aggregated by status.
*/
bidResponseWithoutBidsStatusRows?: Schema$BidResponseWithoutBidsStatusRow[];
/**
* A token to retrieve the next page of results. Pass this value in the ListBidResponsesWithoutBidsRequest.pageToken field in the subsequent call to the bidResponsesWithoutBids.list method to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
export interface Schema$ListClientsResponse {
/**
* The returned