From 330dee0bd2d15626f6bba5c489ec97cb35462cf3 Mon Sep 17 00:00:00 2001 From: yoshi-automation Date: Tue, 4 Aug 2020 04:27:59 -0700 Subject: [PATCH] feat(adexchangebuyer2): update the API #### adexchangebuyer2:v2beta1 The following keys were added: - resources.accounts.resources.creatives.methods.create.parameters.duplicateIdMode.enumDescriptions - resources.accounts.resources.finalizedProposals.methods.list.parameters.filterSyntax.enumDescriptions - resources.accounts.resources.proposals.methods.list.parameters.filterSyntax.enumDescriptions - schemas.AppContext.properties.appTypes.items.enumDescriptions - schemas.AuctionContext.properties.auctionTypes.items.enumDescriptions - schemas.Creative.properties.attributes.items.enumDescriptions - schemas.Creative.properties.restrictedCategories.items.enumDescriptions - schemas.CreativeSize.properties.allowedFormats.items.enumDescriptions - schemas.FilterSet.properties.breakdownDimensions.items.enumDescriptions - schemas.FilterSet.properties.formats.items.enumDescriptions - schemas.FilterSet.properties.platforms.items.enumDescriptions - schemas.PlatformContext.properties.platforms.items.enumDescriptions - schemas.SecurityContext.properties.securities.items.enumDescriptions - schemas.VideoTargeting.properties.excludedPositionTypes.items.enumDescriptions - schemas.VideoTargeting.properties.targetedPositionTypes.items.enumDescriptions The following keys were changed: - resources.accounts.resources.clients.methods.create.parameters.accountId.description - resources.accounts.resources.clients.methods.list.parameters.pageSize.description - resources.accounts.resources.clients.methods.list.parameters.pageToken.description - resources.accounts.resources.clients.methods.list.parameters.partnerClientId.description - resources.accounts.resources.clients.methods.update.parameters.accountId.description - resources.accounts.resources.clients.resources.invitations.methods.create.description - resources.accounts.resources.clients.resources.invitations.methods.create.parameters.clientAccountId.description - resources.accounts.resources.clients.resources.invitations.methods.get.parameters.clientAccountId.description - resources.accounts.resources.clients.resources.invitations.methods.list.description - resources.accounts.resources.clients.resources.invitations.methods.list.parameters.clientAccountId.description - resources.accounts.resources.clients.resources.invitations.methods.list.parameters.pageSize.description - resources.accounts.resources.clients.resources.invitations.methods.list.parameters.pageToken.description - resources.accounts.resources.clients.resources.users.methods.get.parameters.clientAccountId.description - resources.accounts.resources.clients.resources.users.methods.list.description - resources.accounts.resources.clients.resources.users.methods.list.parameters.accountId.description - resources.accounts.resources.clients.resources.users.methods.list.parameters.clientAccountId.description - resources.accounts.resources.clients.resources.users.methods.list.parameters.pageSize.description - resources.accounts.resources.clients.resources.users.methods.list.parameters.pageToken.description - resources.accounts.resources.clients.resources.users.methods.update.description - resources.accounts.resources.clients.resources.users.methods.update.parameters.clientAccountId.description - resources.accounts.resources.creatives.methods.create.parameters.accountId.description - resources.accounts.resources.creatives.methods.create.parameters.duplicateIdMode.description - resources.accounts.resources.creatives.methods.list.parameters.accountId.description - resources.accounts.resources.creatives.methods.list.parameters.pageSize.description - resources.accounts.resources.creatives.methods.list.parameters.pageToken.description - resources.accounts.resources.creatives.methods.list.parameters.query.description - resources.accounts.resources.creatives.methods.stopWatching.description - resources.accounts.resources.creatives.methods.stopWatching.parameters.creativeId.description - resources.accounts.resources.creatives.methods.update.parameters.accountId.description - resources.accounts.resources.creatives.methods.update.parameters.creativeId.description - resources.accounts.resources.creatives.methods.watch.description - resources.accounts.resources.creatives.methods.watch.parameters.creativeId.description - resources.accounts.resources.creatives.resources.dealAssociations.methods.list.parameters.accountId.description - resources.accounts.resources.creatives.resources.dealAssociations.methods.list.parameters.creativeId.description - resources.accounts.resources.creatives.resources.dealAssociations.methods.list.parameters.pageSize.description - resources.accounts.resources.creatives.resources.dealAssociations.methods.list.parameters.pageToken.description - resources.accounts.resources.creatives.resources.dealAssociations.methods.list.parameters.query.description - resources.accounts.resources.finalizedProposals.methods.list.description - resources.accounts.resources.finalizedProposals.methods.list.parameters.filter.description - resources.accounts.resources.finalizedProposals.methods.list.parameters.filterSyntax.description - resources.accounts.resources.finalizedProposals.methods.list.parameters.pageSize.description - resources.accounts.resources.products.methods.list.description - resources.accounts.resources.products.methods.list.parameters.filter.description - resources.accounts.resources.products.methods.list.parameters.pageSize.description - resources.accounts.resources.proposals.methods.accept.description - resources.accounts.resources.proposals.methods.addNote.description - resources.accounts.resources.proposals.methods.cancelNegotiation.description - resources.accounts.resources.proposals.methods.completeSetup.description - resources.accounts.resources.proposals.methods.create.description - resources.accounts.resources.proposals.methods.get.description - resources.accounts.resources.proposals.methods.list.description - resources.accounts.resources.proposals.methods.list.parameters.filter.description - resources.accounts.resources.proposals.methods.list.parameters.filterSyntax.description - resources.accounts.resources.proposals.methods.list.parameters.pageSize.description - resources.accounts.resources.proposals.methods.pause.description - resources.accounts.resources.proposals.methods.resume.description - resources.accounts.resources.proposals.methods.update.description - resources.bidders.resources.accounts.resources.filterSets.methods.create.parameters.isTransient.description - resources.bidders.resources.accounts.resources.filterSets.methods.create.parameters.ownerName.description - resources.bidders.resources.accounts.resources.filterSets.methods.delete.description - resources.bidders.resources.accounts.resources.filterSets.methods.delete.parameters.name.description - resources.bidders.resources.accounts.resources.filterSets.methods.get.description - resources.bidders.resources.accounts.resources.filterSets.methods.get.parameters.name.description - resources.bidders.resources.accounts.resources.filterSets.methods.list.parameters.ownerName.description - resources.bidders.resources.accounts.resources.filterSets.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidMetrics.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidMetrics.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidMetrics.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidResponseErrors.methods.list.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidResponseErrors.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidResponseErrors.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidResponseErrors.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidResponsesWithoutBids.methods.list.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidResponsesWithoutBids.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidResponsesWithoutBids.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.bidResponsesWithoutBids.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBidRequests.methods.list.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBidRequests.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBidRequests.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBidRequests.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.methods.list.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.parameters.creativeStatusId.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.details.methods.list.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.details.methods.list.parameters.creativeStatusId.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.details.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.details.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.filteredBids.resources.details.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.impressionMetrics.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.impressionMetrics.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.impressionMetrics.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.losingBids.methods.list.description - resources.bidders.resources.accounts.resources.filterSets.resources.losingBids.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.losingBids.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.losingBids.methods.list.parameters.pageToken.description - resources.bidders.resources.accounts.resources.filterSets.resources.nonBillableWinningBids.methods.list.description - resources.bidders.resources.accounts.resources.filterSets.resources.nonBillableWinningBids.methods.list.parameters.filterSetName.description - resources.bidders.resources.accounts.resources.filterSets.resources.nonBillableWinningBids.methods.list.parameters.pageSize.description - resources.bidders.resources.accounts.resources.filterSets.resources.nonBillableWinningBids.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.methods.create.parameters.isTransient.description - resources.bidders.resources.filterSets.methods.create.parameters.ownerName.description - resources.bidders.resources.filterSets.methods.delete.description - resources.bidders.resources.filterSets.methods.delete.parameters.name.description - resources.bidders.resources.filterSets.methods.get.description - resources.bidders.resources.filterSets.methods.get.parameters.name.description - resources.bidders.resources.filterSets.methods.list.parameters.ownerName.description - resources.bidders.resources.filterSets.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.bidMetrics.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.bidMetrics.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.bidMetrics.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.bidResponseErrors.methods.list.description - resources.bidders.resources.filterSets.resources.bidResponseErrors.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.bidResponseErrors.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.bidResponseErrors.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.bidResponsesWithoutBids.methods.list.description - resources.bidders.resources.filterSets.resources.bidResponsesWithoutBids.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.bidResponsesWithoutBids.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.bidResponsesWithoutBids.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.filteredBidRequests.methods.list.description - resources.bidders.resources.filterSets.resources.filteredBidRequests.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.filteredBidRequests.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.filteredBidRequests.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.filteredBids.methods.list.description - resources.bidders.resources.filterSets.resources.filteredBids.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.filteredBids.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.filteredBids.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.parameters.creativeStatusId.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.creatives.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.details.methods.list.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.details.methods.list.parameters.creativeStatusId.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.details.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.details.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.filteredBids.resources.details.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.impressionMetrics.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.impressionMetrics.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.impressionMetrics.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.losingBids.methods.list.description - resources.bidders.resources.filterSets.resources.losingBids.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.losingBids.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.losingBids.methods.list.parameters.pageToken.description - resources.bidders.resources.filterSets.resources.nonBillableWinningBids.methods.list.description - resources.bidders.resources.filterSets.resources.nonBillableWinningBids.methods.list.parameters.filterSetName.description - resources.bidders.resources.filterSets.resources.nonBillableWinningBids.methods.list.parameters.pageSize.description - resources.bidders.resources.filterSets.resources.nonBillableWinningBids.methods.list.parameters.pageToken.description - schemas.AbsoluteDateRange.description - schemas.AbsoluteDateRange.properties.endDate.description - schemas.AbsoluteDateRange.properties.startDate.description - schemas.AdSize.properties.height.description - schemas.AdSize.properties.sizeType.enumDescriptions - schemas.AdSize.properties.width.description - schemas.AdTechnologyProviders.properties.detectedProviderIds.description - schemas.AdTechnologyProviders.properties.hasUnidentifiedProvider.description - schemas.BidMetricsRow.description - schemas.BidMetricsRow.properties.measurableImpressions.description - schemas.BidMetricsRow.properties.reachedQueries.description - schemas.BidMetricsRow.properties.viewableImpressions.description - schemas.BidResponseWithoutBidsStatusRow.description - schemas.BidResponseWithoutBidsStatusRow.properties.impressionCount.description - schemas.BidResponseWithoutBidsStatusRow.properties.status.description - schemas.BidResponseWithoutBidsStatusRow.properties.status.enumDescriptions - schemas.Buyer.description - schemas.CalloutStatusRow.description - schemas.CalloutStatusRow.properties.calloutStatusId.description - schemas.CalloutStatusRow.properties.impressionCount.description - schemas.Client.description - schemas.Client.properties.clientAccountId.description - schemas.Client.properties.clientName.description - schemas.Client.properties.entityId.description - schemas.Client.properties.entityName.description - schemas.Client.properties.entityType.description - schemas.Client.properties.entityType.enumDescriptions - schemas.Client.properties.partnerClientId.description - schemas.Client.properties.role.description - schemas.Client.properties.role.enumDescriptions - schemas.ClientUser.description - schemas.ClientUser.properties.clientAccountId.description - schemas.ClientUser.properties.email.description - schemas.ClientUser.properties.userId.description - schemas.ClientUserInvitation.description - schemas.ClientUserInvitation.properties.clientAccountId.description - schemas.ClientUserInvitation.properties.email.description - schemas.ClientUserInvitation.properties.invitationId.description - schemas.Correction.properties.type.enumDescriptions - schemas.Creative.properties.accountId.description - schemas.Creative.properties.attributes.description - schemas.Creative.properties.attributes.enumDescriptions - schemas.Creative.properties.creativeId.description - schemas.Creative.properties.dealsStatus.description - schemas.Creative.properties.dealsStatus.enumDescriptions - schemas.Creative.properties.detectedLanguages.description - schemas.Creative.properties.detectedProductCategories.description - schemas.Creative.properties.detectedSensitiveCategories.description - schemas.Creative.properties.openAuctionStatus.description - schemas.Creative.properties.openAuctionStatus.enumDescriptions - schemas.Creative.properties.servingRestrictions.description - schemas.Creative.properties.vendorIds.description - schemas.CreativeRestrictions.description - schemas.CreativeRestrictions.properties.creativeFormat.enumDescriptions - schemas.CreativeRestrictions.properties.skippableAdType.enumDescriptions - schemas.CreativeSize.properties.allowedFormats.description - schemas.CreativeSize.properties.companionSizes.description - schemas.CreativeSize.properties.nativeTemplate.description - schemas.CreativeSize.properties.size.description - schemas.CreativeSize.properties.skippableAdType.description - schemas.CreativeSize.properties.skippableAdType.enumDescriptions - schemas.CreativeSpecification.description - schemas.CreativeStatusRow.description - schemas.CreativeStatusRow.properties.creativeStatusId.description - schemas.CriteriaTargeting.description - schemas.Date.description - schemas.Date.properties.day.description - schemas.Date.properties.month.description - schemas.Date.properties.year.description - schemas.DayPart.description - schemas.DayPart.properties.endTime.description - schemas.DayPart.properties.startTime.description - schemas.Deal.description - schemas.Deal.properties.availableEndTime.description - schemas.Deal.properties.availableStartTime.description - schemas.Deal.properties.createProductId.description - schemas.Deal.properties.createProductRevision.description - schemas.Deal.properties.creativeRestrictions.description - schemas.Deal.properties.deliveryControl.description - schemas.Deal.properties.externalDealId.description - schemas.Deal.properties.isSetupComplete.description - schemas.Deal.properties.programmaticCreativeSource.description - schemas.Deal.properties.syndicationProduct.description - schemas.Deal.properties.targetingCriterion.description - schemas.DealPauseStatus.description - schemas.DealTerms.description - schemas.DealTerms.properties.brandingType.enumDescriptions - schemas.DealTerms.properties.estimatedGrossSpend.description - schemas.DealTerms.properties.estimatedImpressionsPerDay.description - schemas.DealTerms.properties.sellerTimeZone.description - schemas.Disapproval.properties.reason.enumDescriptions - schemas.Empty.description - schemas.FilterSet.description - schemas.FilterSet.properties.absoluteDateRange.description - schemas.FilterSet.properties.breakdownDimensions.description - schemas.FilterSet.properties.breakdownDimensions.enumDescriptions - schemas.FilterSet.properties.creativeId.description - schemas.FilterSet.properties.dealId.description - schemas.FilterSet.properties.environment.enumDescriptions - schemas.FilterSet.properties.format.enumDescriptions - schemas.FilterSet.properties.formats.description - schemas.FilterSet.properties.formats.enumDescriptions - schemas.FilterSet.properties.name.description - schemas.FilterSet.properties.platforms.description - schemas.FilterSet.properties.platforms.enumDescriptions - schemas.FilterSet.properties.publisherIdentifiers.description - schemas.FilterSet.properties.realtimeTimeRange.description - schemas.FilterSet.properties.relativeDateRange.description - schemas.FilterSet.properties.sellerNetworkIds.description - schemas.FilterSet.properties.timeSeriesGranularity.description - schemas.FilterSet.properties.timeSeriesGranularity.enumDescriptions - schemas.FilteredBidCreativeRow.description - schemas.FilteredBidDetailRow.description - schemas.FilteredBidDetailRow.properties.detailId.description - schemas.FirstPartyMobileApplicationTargeting.description - schemas.FrequencyCap.properties.maxImpressions.description - schemas.FrequencyCap.properties.numTimeUnits.description - schemas.FrequencyCap.properties.timeUnitType.description - schemas.FrequencyCap.properties.timeUnitType.enumDescriptions - schemas.GuaranteedFixedPriceTerms.properties.guaranteedImpressions.description - schemas.Image.description - schemas.ImpressionMetricsRow.description - schemas.ImpressionMetricsRow.properties.availableImpressions.description - schemas.ImpressionMetricsRow.properties.bidRequests.description - schemas.ImpressionMetricsRow.properties.responsesWithBids.description - schemas.ImpressionMetricsRow.properties.successfulResponses.description - schemas.InventorySizeTargeting.description - schemas.ListBidMetricsResponse.properties.nextPageToken.description - schemas.ListBidResponseErrorsResponse.description - schemas.ListBidResponseErrorsResponse.properties.nextPageToken.description - schemas.ListBidResponsesWithoutBidsResponse.description - schemas.ListBidResponsesWithoutBidsResponse.properties.bidResponseWithoutBidsStatusRows.description - schemas.ListBidResponsesWithoutBidsResponse.properties.nextPageToken.description - schemas.ListClientUserInvitationsResponse.properties.nextPageToken.description - schemas.ListClientUsersResponse.properties.nextPageToken.description - schemas.ListClientsResponse.properties.nextPageToken.description - schemas.ListCreativeStatusBreakdownByCreativeResponse.description - schemas.ListCreativeStatusBreakdownByCreativeResponse.properties.filteredBidCreativeRows.description - schemas.ListCreativeStatusBreakdownByCreativeResponse.properties.nextPageToken.description - schemas.ListCreativeStatusBreakdownByDetailResponse.description - schemas.ListCreativeStatusBreakdownByDetailResponse.properties.detailType.enumDescriptions - schemas.ListCreativeStatusBreakdownByDetailResponse.properties.filteredBidDetailRows.description - schemas.ListCreativeStatusBreakdownByDetailResponse.properties.nextPageToken.description - schemas.ListCreativesResponse.properties.nextPageToken.description - schemas.ListDealAssociationsResponse.properties.nextPageToken.description - schemas.ListFilterSetsResponse.properties.nextPageToken.description - schemas.ListFilteredBidRequestsResponse.description - schemas.ListFilteredBidRequestsResponse.properties.calloutStatusRows.description - schemas.ListFilteredBidRequestsResponse.properties.nextPageToken.description - schemas.ListFilteredBidsResponse.description - schemas.ListFilteredBidsResponse.properties.creativeStatusRows.description - schemas.ListFilteredBidsResponse.properties.nextPageToken.description - schemas.ListImpressionMetricsResponse.description - schemas.ListImpressionMetricsResponse.properties.nextPageToken.description - schemas.ListLosingBidsResponse.properties.creativeStatusRows.description - schemas.ListLosingBidsResponse.properties.nextPageToken.description - schemas.ListNonBillableWinningBidsResponse.description - schemas.ListNonBillableWinningBidsResponse.properties.nextPageToken.description - schemas.LocationContext.properties.geoCriteriaIds.description - schemas.MarketplaceTargeting.description - schemas.MetricValue.description - schemas.MetricValue.properties.variance.description - schemas.MobileApplicationTargeting.properties.firstPartyTargeting.description - schemas.Money.properties.nanos.description - schemas.Money.properties.units.description - schemas.NonBillableWinningBidStatusRow.description - schemas.NonBillableWinningBidStatusRow.properties.status.enumDescriptions - schemas.NonGuaranteedAuctionTerms.description - schemas.NonGuaranteedAuctionTerms.properties.autoOptimizePrivateAuction.description - schemas.NonGuaranteedFixedPriceTerms.description - schemas.Note.properties.note.description - schemas.PauseProposalRequest.properties.reason.description - schemas.PlacementTargeting.description - schemas.PlacementTargeting.properties.mobileApplicationTargeting.description - schemas.Price.properties.pricingType.enumDescriptions - schemas.PricePerBuyer.description - schemas.PricePerBuyer.properties.advertiserIds.description - schemas.PricePerBuyer.properties.buyer.description - schemas.PrivateData.properties.referenceId.description - schemas.Product.description - schemas.Product.properties.availableEndTime.description - schemas.Product.properties.availableStartTime.description - schemas.Product.properties.hasCreatorSignedOff.description - schemas.Product.properties.publisherProfileId.description - schemas.Product.properties.targetingCriterion.description - schemas.Product.properties.webPropertyCode.description - schemas.Proposal.description - schemas.Proposal.properties.buyer.description - schemas.Proposal.properties.deals.description - schemas.Proposal.properties.isSetupComplete.description - schemas.Proposal.properties.lastUpdaterOrCommentorRole.description - schemas.Proposal.properties.privateAuctionId.description - schemas.Proposal.properties.proposalRevision.description - schemas.Proposal.properties.proposalState.enumDescriptions - schemas.Proposal.properties.seller.description - schemas.PublisherProfile.description - schemas.PublisherProfile.properties.buyerPitchStatement.description - schemas.PublisherProfile.properties.directDealsContact.description - schemas.PublisherProfile.properties.domains.description - schemas.PublisherProfile.properties.isParent.description - schemas.PublisherProfile.properties.logoUrl.description - schemas.PublisherProfile.properties.programmaticDealsContact.description - schemas.PublisherProfile.properties.topHeadlines.description - schemas.RealtimeTimeRange.description - schemas.RelativeDateRange.description - schemas.RelativeDateRange.properties.durationDays.description - schemas.RelativeDateRange.properties.offsetDays.description - schemas.ResumeProposalRequest.description - schemas.RowDimensions.description - schemas.RowDimensions.properties.publisherIdentifier.description - schemas.Seller.description - schemas.Seller.properties.accountId.description - schemas.ServingContext.properties.location.description - schemas.ServingRestriction.description - schemas.ServingRestriction.properties.disapproval.description - schemas.ServingRestriction.properties.disapprovalReasons.description - schemas.ServingRestriction.properties.status.description - schemas.Size.description - schemas.TargetingCriteria.description - schemas.TargetingCriteria.properties.exclusions.description - schemas.TargetingCriteria.properties.inclusions.description - schemas.TargetingCriteria.properties.key.description - schemas.TargetingValue.properties.creativeSizeValue.description - schemas.TargetingValue.properties.dayPartTargetingValue.description - schemas.TimeInterval.properties.endTime.description - schemas.TimeInterval.properties.startTime.description - schemas.TimeOfDay.description - schemas.TimeOfDay.properties.hours.description - schemas.TimeOfDay.properties.seconds.description - schemas.UrlTargeting.description - schemas.VideoContent.properties.videoVastXml.description - schemas.VideoTargeting.properties.excludedPositionTypes.description - schemas.VideoTargeting.properties.targetedPositionTypes.description - schemas.WatchCreativeRequest.properties.topic.description --- discovery/adexchangebuyer2-v2beta1.json | 950 +++++++++++++----------- src/apis/adexchangebuyer2/v2beta1.ts | 921 +++++------------------ 2 files changed, 734 insertions(+), 1137 deletions(-) diff --git a/discovery/adexchangebuyer2-v2beta1.json b/discovery/adexchangebuyer2-v2beta1.json index 72ca737965..2c6598c824 100644 --- a/discovery/adexchangebuyer2-v2beta1.json +++ b/discovery/adexchangebuyer2-v2beta1.json @@ -118,7 +118,7 @@ ], "parameters": { "accountId": { - "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)", + "description": "Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)", "format": "int64", "location": "path", "required": true, @@ -186,18 +186,18 @@ "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list\nmethod.", + "description": "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 accounts.clients.list method.", "location": "query", "type": "string" }, "partnerClientId": { - "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor\nbuyer partner) of the client to return.\nIf specified, at most one client will be returned in the response.", + "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.", "location": "query", "type": "string" } @@ -221,7 +221,7 @@ ], "parameters": { "accountId": { - "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)", + "description": "Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)", "format": "int64", "location": "path", "required": true, @@ -251,7 +251,7 @@ "invitations": { "methods": { "create": { - "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.", + "description": "Creates and sends out an email invitation to access an Ad Exchange client buyer account.", "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.clients.invitations.create", @@ -268,7 +268,7 @@ "type": "string" }, "clientAccountId": { - "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)", + "description": "Numerical account ID of the client buyer that the user should be associated with. (required)", "format": "int64", "location": "path", "required": true, @@ -305,7 +305,7 @@ "type": "string" }, "clientAccountId": { - "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)", + "description": "Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)", "format": "int64", "location": "path", "required": true, @@ -328,7 +328,7 @@ ] }, "list": { - "description": "Lists all the client users invitations for a client\nwith a given account ID.", + "description": "Lists all the client users invitations for a client with a given account ID.", "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", "httpMethod": "GET", "id": "adexchangebuyer2.accounts.clients.invitations.list", @@ -345,19 +345,19 @@ "type": "string" }, "clientAccountId": { - "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.", + "description": "Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.", + "description": "Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.", "location": "query", "type": "string" } @@ -393,7 +393,7 @@ "type": "string" }, "clientAccountId": { - "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)", + "description": "Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)", "format": "int64", "location": "path", "required": true, @@ -416,7 +416,7 @@ ] }, "list": { - "description": "Lists all the known client users for a specified\nsponsor buyer account ID.", + "description": "Lists all the known client users for a specified sponsor buyer account ID.", "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users", "httpMethod": "GET", "id": "adexchangebuyer2.accounts.clients.users.list", @@ -426,26 +426,26 @@ ], "parameters": { "accountId": { - "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)", + "description": "Numerical account ID of the sponsor buyer of the client to list users for. (required)", "format": "int64", "location": "path", "required": true, "type": "string" }, "clientAccountId": { - "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.", + "description": "The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list\nmethod.", + "description": "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 accounts.clients.users.list method.", "location": "query", "type": "string" } @@ -459,7 +459,7 @@ ] }, "update": { - "description": "Updates an existing client user.\nOnly the user status can be changed on update.", + "description": "Updates an existing client user. Only the user status can be changed on update.", "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", "httpMethod": "PUT", "id": "adexchangebuyer2.accounts.clients.users.update", @@ -477,7 +477,7 @@ "type": "string" }, "clientAccountId": { - "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)", + "description": "Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)", "format": "int64", "location": "path", "required": true, @@ -518,17 +518,21 @@ ], "parameters": { "accountId": { - "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "description": "The account that this creative belongs to. Can be used to filter the response of the creatives.list method.", "location": "path", "required": true, "type": "string" }, "duplicateIdMode": { - "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", + "description": "Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).", "enum": [ "NO_DUPLICATES", "FORCE_ENABLE_DUPLICATE_IDS" ], + "enumDescriptions": [ + "Recommended. This means that an ID will be unique to a single creative. Multiple creatives will not share an ID.", + "Not recommended. Using this option will allow multiple creatives to share the same ID. Get and Update requests will not be possible for any ID that has more than one creative associated. (List will still function.) This is only intended for backwards compatibility in cases where a single ID is already shared by multiple creatives from previous APIs." + ], "location": "query", "type": "string" } @@ -585,24 +589,24 @@ ], "parameters": { "accountId": { - "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.", + "description": "The account to list the creatives from. Specify \"-\" to list all creatives the current user has access to.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.", + "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method.", "location": "query", "type": "string" }, "query": { - "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\n

Supported queries are:\n

\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'", + "description": "An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'", "location": "query", "type": "string" } @@ -616,7 +620,7 @@ ] }, "stopWatching": { - "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.", + "description": "Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.", "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.creatives.stopWatching", @@ -632,7 +636,7 @@ "type": "string" }, "creativeId": { - "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.", + "description": "The creative ID of the creative to stop notifications for. Specify \"-\" to specify stopping account level notifications.", "location": "path", "required": true, "type": "string" @@ -660,13 +664,13 @@ ], "parameters": { "accountId": { - "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "description": "The account that this creative belongs to. Can be used to filter the response of the creatives.list method.", "location": "path", "required": true, "type": "string" }, "creativeId": { - "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "description": "The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.", "location": "path", "required": true, "type": "string" @@ -684,7 +688,7 @@ ] }, "watch": { - "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.", + "description": "Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.", "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.creatives.watch", @@ -700,7 +704,7 @@ "type": "string" }, "creativeId": { - "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.", + "description": "The creative ID to watch for status changes. Specify \"-\" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.", "location": "path", "required": true, "type": "string" @@ -766,30 +770,30 @@ ], "parameters": { "accountId": { - "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.", + "description": "The account to list the associations from. Specify \"-\" to list all creatives the current user has access to.", "location": "path", "required": true, "type": "string" }, "creativeId": { - "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.", + "description": "The creative ID to list the associations from. Specify \"-\" to list all creatives under the above account.", "location": "path", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.", + "description": "Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.", "location": "query", "type": "string" }, "query": { - "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\nExample: 'dealsId=12345 AND dealsStatus:disapproved'", + "description": "An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'", "location": "query", "type": "string" } @@ -843,7 +847,7 @@ "finalizedProposals": { "methods": { "list": { - "description": "List finalized proposals, regardless if a proposal is being renegotiated.\nA filter expression (PQL query) may be specified to filter the results.\nThe notes will not be returned.", + "description": "List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.", "flatPath": "v2beta1/accounts/{accountId}/finalizedProposals", "httpMethod": "GET", "id": "adexchangebuyer2.accounts.finalizedProposals.list", @@ -858,22 +862,27 @@ "type": "string" }, "filter": { - "description": "An optional PQL filter query used to query for proposals.\n\nNested repeated fields, such as proposal.deals.targetingCriterion,\ncannot be filtered.", + "description": "An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.", "location": "query", "type": "string" }, "filterSyntax": { - "description": "Syntax the filter is written in. Current implementation defaults to PQL\nbut in the future it will be LIST_FILTER.", + "description": "Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.", "enum": [ "FILTER_SYNTAX_UNSPECIFIED", "PQL", "LIST_FILTER" ], + "enumDescriptions": [ + "A placeholder for an undefined filter syntax.", + "PQL query syntax. Visit https://developers.google.com/ad-manager/api/pqlreference for PQL documentation and examples.", + "API list filtering syntax. Read about syntax and usage at https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters." + ], "location": "query", "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" @@ -928,7 +937,7 @@ ] }, "list": { - "description": "List all products visible to the buyer (optionally filtered by the\nspecified PQL query).", + "description": "List all products visible to the buyer (optionally filtered by the specified PQL query).", "flatPath": "v2beta1/accounts/{accountId}/products", "httpMethod": "GET", "id": "adexchangebuyer2.accounts.products.list", @@ -943,12 +952,12 @@ "type": "string" }, "filter": { - "description": "An optional PQL query used to query for products. See\nhttps://developers.google.com/ad-manager/docs/pqlreference\nfor documentation about PQL and examples.\n\nNested repeated fields, such as product.targetingCriterion.inclusions,\ncannot be filtered.", + "description": "An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered.", "location": "query", "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" @@ -972,7 +981,7 @@ "proposals": { "methods": { "accept": { - "description": "Mark the proposal as accepted at the given revision number. If the number\ndoes not match the server's revision number an `ABORTED` error message will\nbe returned. This call updates the proposal_state from `PROPOSED` to\n`BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.", + "description": "Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:accept", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.proposals.accept", @@ -1006,7 +1015,7 @@ ] }, "addNote": { - "description": "Create a new note and attach it to the proposal. The note is assigned\na unique ID by the server.\nThe proposal revision number will not increase when associated with a\nnew note.", + "description": "Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:addNote", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.proposals.addNote", @@ -1040,7 +1049,7 @@ ] }, "cancelNegotiation": { - "description": "Cancel an ongoing negotiation on a proposal. This does not cancel or end\nserving for the deals if the proposal has been finalized, but only cancels\na negotiation unilaterally.", + "description": "Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:cancelNegotiation", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.proposals.cancelNegotiation", @@ -1074,7 +1083,7 @@ ] }, "completeSetup": { - "description": "Update the given proposal to indicate that setup has been completed.\nThis method is called by the buyer when the line items have been created\non their end for a finalized proposal and all the required creatives\nhave been uploaded using the creatives API. This call updates the\n`is_setup_completed` bit on the proposal and also notifies the seller.\nThe server will advance the revision number of the most recent proposal.", + "description": "Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the `is_setup_completed` bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal.", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:completeSetup", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.proposals.completeSetup", @@ -1108,7 +1117,7 @@ ] }, "create": { - "description": "Create the given proposal. Each created proposal and any deals it contains\nare assigned a unique ID by the server.", + "description": "Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.", "flatPath": "v2beta1/accounts/{accountId}/proposals", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.proposals.create", @@ -1135,7 +1144,7 @@ ] }, "get": { - "description": "Gets a proposal given its ID. The proposal is returned at its head\nrevision.", + "description": "Gets a proposal given its ID. The proposal is returned at its head revision.", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}", "httpMethod": "GET", "id": "adexchangebuyer2.accounts.proposals.get", @@ -1166,7 +1175,7 @@ ] }, "list": { - "description": "List proposals. A filter expression (PQL query) may be specified to\nfilter the results. To retrieve all finalized proposals, regardless if a\nproposal is being renegotiated, see the FinalizedProposals resource.\nNote that Bidder/ChildSeat relationships differ from the usual behavior.\nA Bidder account can only see its child seats' proposals by specifying\nthe ChildSeat's accountId in the request path.", + "description": "List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.", "flatPath": "v2beta1/accounts/{accountId}/proposals", "httpMethod": "GET", "id": "adexchangebuyer2.accounts.proposals.list", @@ -1181,22 +1190,27 @@ "type": "string" }, "filter": { - "description": "An optional PQL filter query used to query for proposals.\n\nNested repeated fields, such as proposal.deals.targetingCriterion,\ncannot be filtered.", + "description": "An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.", "location": "query", "type": "string" }, "filterSyntax": { - "description": "Syntax the filter is written in. Current implementation defaults to PQL\nbut in the future it will be LIST_FILTER.", + "description": "Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.", "enum": [ "FILTER_SYNTAX_UNSPECIFIED", "PQL", "LIST_FILTER" ], + "enumDescriptions": [ + "A placeholder for an undefined filter syntax.", + "PQL query syntax. Visit https://developers.google.com/ad-manager/api/pqlreference for PQL documentation and examples.", + "API list filtering syntax. Read about syntax and usage at https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters." + ], "location": "query", "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" @@ -1216,7 +1230,7 @@ ] }, "pause": { - "description": "Update the given proposal to pause serving.\nThis method will set the\n`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all\ndeals in the proposal.\n\nIt is a no-op to pause an already-paused proposal.\nIt is an error to call PauseProposal for a proposal that is not\nfinalized or renegotiating.", + "description": "Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:pause", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.proposals.pause", @@ -1250,7 +1264,7 @@ ] }, "resume": { - "description": "Update the given proposal to resume serving.\nThis method will set the\n`DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all\ndeals in the proposal.\n\nNote that if the `has_seller_paused` bit is also set, serving will not\nresume until the seller also resumes.\n\nIt is a no-op to resume an already-running proposal.\nIt is an error to call ResumeProposal for a proposal that is not\nfinalized or renegotiating.", + "description": "Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}:resume", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.proposals.resume", @@ -1284,7 +1298,7 @@ ] }, "update": { - "description": "Update the given proposal at the client known revision number. If the\nserver revision has advanced since the passed-in\n`proposal.proposal_revision`, an `ABORTED` error message will be returned.\nOnly the buyer-modifiable fields of the proposal will be updated.\n\nNote that the deals in the proposal will be updated to match the passed-in\ncopy.\nIf a passed-in deal does not have a `deal_id`, the server will assign a new\nunique ID and create the deal.\nIf passed-in deal has a `deal_id`, it will be updated to match the\npassed-in copy.\nAny existing deals not present in the passed-in proposal will be deleted.\nIt is an error to pass in a deal with a `deal_id` not present at head.", + "description": "Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head.", "flatPath": "v2beta1/accounts/{accountId}/proposals/{proposalId}", "httpMethod": "PUT", "id": "adexchangebuyer2.accounts.proposals.update", @@ -1407,12 +1421,12 @@ ], "parameters": { "isTransient": { - "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.", + "description": "Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.", "location": "query", "type": "boolean" }, "ownerName": { - "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", + "description": "Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+$", "required": true, @@ -1431,7 +1445,7 @@ ] }, "delete": { - "description": "Deletes the requested filter set from the account with the given account\nID.", + "description": "Deletes the requested filter set from the account with the given account ID.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", "httpMethod": "DELETE", "id": "adexchangebuyer2.bidders.accounts.filterSets.delete", @@ -1440,7 +1454,7 @@ ], "parameters": { "name": { - "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, @@ -1456,7 +1470,7 @@ ] }, "get": { - "description": "Retrieves the requested filter set for the account with the given account\nID.", + "description": "Retrieves the requested filter set for the account with the given account ID.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.get", @@ -1465,7 +1479,7 @@ ], "parameters": { "name": { - "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, @@ -1490,20 +1504,20 @@ ], "parameters": { "ownerName": { - "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", + "description": "Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.", "location": "query", "type": "string" } @@ -1530,20 +1544,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.", "location": "query", "type": "string" } @@ -1561,7 +1575,7 @@ "bidResponseErrors": { "methods": { "list": { - "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.", + "description": "List all errors that occurred in bid responses, with the number of bid responses affected for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list", @@ -1570,20 +1584,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.", "location": "query", "type": "string" } @@ -1601,7 +1615,7 @@ "bidResponsesWithoutBids": { "methods": { "list": { - "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.", + "description": "List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list", @@ -1610,20 +1624,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.", "location": "query", "type": "string" } @@ -1641,7 +1655,7 @@ "filteredBidRequests": { "methods": { "list": { - "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.", + "description": "List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list", @@ -1650,20 +1664,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.", "location": "query", "type": "string" } @@ -1681,7 +1695,7 @@ "filteredBids": { "methods": { "list": { - "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.", + "description": "List all reasons for which bids were filtered, with the number of bids filtered for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list", @@ -1690,20 +1704,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.", "location": "query", "type": "string" } @@ -1721,7 +1735,7 @@ "creatives": { "methods": { "list": { - "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.", + "description": "List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list", @@ -1731,27 +1745,27 @@ ], "parameters": { "creativeStatusId": { - "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).", + "description": "The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).", "format": "int32", "location": "path", "required": true, "type": "integer" }, "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.", "location": "query", "type": "string" } @@ -1769,7 +1783,7 @@ "details": { "methods": { "list": { - "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.", + "description": "List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list", @@ -1779,27 +1793,27 @@ ], "parameters": { "creativeStatusId": { - "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", + "description": "The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", "format": "int32", "location": "path", "required": true, "type": "integer" }, "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.", "location": "query", "type": "string" } @@ -1828,20 +1842,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.", "location": "query", "type": "string" } @@ -1859,7 +1873,7 @@ "losingBids": { "methods": { "list": { - "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.", + "description": "List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list", @@ -1868,20 +1882,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.", "location": "query", "type": "string" } @@ -1899,7 +1913,7 @@ "nonBillableWinningBids": { "methods": { "list": { - "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.", + "description": "List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list", @@ -1908,20 +1922,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.", "location": "query", "type": "string" } @@ -1952,12 +1966,12 @@ ], "parameters": { "isTransient": { - "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.", + "description": "Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.", "location": "query", "type": "boolean" }, "ownerName": { - "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", + "description": "Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`", "location": "path", "pattern": "^bidders/[^/]+$", "required": true, @@ -1976,7 +1990,7 @@ ] }, "delete": { - "description": "Deletes the requested filter set from the account with the given account\nID.", + "description": "Deletes the requested filter set from the account with the given account ID.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", "httpMethod": "DELETE", "id": "adexchangebuyer2.bidders.filterSets.delete", @@ -1985,7 +1999,7 @@ ], "parameters": { "name": { - "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, @@ -2001,7 +2015,7 @@ ] }, "get": { - "description": "Retrieves the requested filter set for the account with the given account\nID.", + "description": "Retrieves the requested filter set for the account with the given account ID.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.get", @@ -2010,7 +2024,7 @@ ], "parameters": { "name": { - "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, @@ -2035,20 +2049,20 @@ ], "parameters": { "ownerName": { - "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", + "description": "Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`", "location": "path", "pattern": "^bidders/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.", "location": "query", "type": "string" } @@ -2075,20 +2089,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.", "location": "query", "type": "string" } @@ -2106,7 +2120,7 @@ "bidResponseErrors": { "methods": { "list": { - "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.", + "description": "List all errors that occurred in bid responses, with the number of bid responses affected for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list", @@ -2115,20 +2129,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.", "location": "query", "type": "string" } @@ -2146,7 +2160,7 @@ "bidResponsesWithoutBids": { "methods": { "list": { - "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.", + "description": "List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list", @@ -2155,20 +2169,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.", "location": "query", "type": "string" } @@ -2186,7 +2200,7 @@ "filteredBidRequests": { "methods": { "list": { - "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.", + "description": "List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list", @@ -2195,20 +2209,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.", "location": "query", "type": "string" } @@ -2226,7 +2240,7 @@ "filteredBids": { "methods": { "list": { - "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.", + "description": "List all reasons for which bids were filtered, with the number of bids filtered for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.filteredBids.list", @@ -2235,20 +2249,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.", "location": "query", "type": "string" } @@ -2266,7 +2280,7 @@ "creatives": { "methods": { "list": { - "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.", + "description": "List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list", @@ -2276,27 +2290,27 @@ ], "parameters": { "creativeStatusId": { - "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).", + "description": "The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).", "format": "int32", "location": "path", "required": true, "type": "integer" }, "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.", "location": "query", "type": "string" } @@ -2314,7 +2328,7 @@ "details": { "methods": { "list": { - "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.", + "description": "List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list", @@ -2324,27 +2338,27 @@ ], "parameters": { "creativeStatusId": { - "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", + "description": "The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", "format": "int32", "location": "path", "required": true, "type": "integer" }, "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.", "location": "query", "type": "string" } @@ -2373,20 +2387,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.", "location": "query", "type": "string" } @@ -2404,7 +2418,7 @@ "losingBids": { "methods": { "list": { - "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.", + "description": "List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.losingBids.list", @@ -2413,20 +2427,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.", "location": "query", "type": "string" } @@ -2444,7 +2458,7 @@ "nonBillableWinningBids": { "methods": { "list": { - "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.", + "description": "List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.", "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids", "httpMethod": "GET", "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list", @@ -2453,20 +2467,20 @@ ], "parameters": { "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", "location": "path", "pattern": "^bidders/[^/]+/filterSets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.", "location": "query", "type": "string" } @@ -2486,20 +2500,20 @@ } } }, - "revision": "20200601", + "revision": "20200803", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { - "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.", + "description": "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.", "id": "AbsoluteDateRange", "properties": { "endDate": { "$ref": "Date", - "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date." + "description": "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." }, "startDate": { "$ref": "Date", - "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date." + "description": "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." } }, "type": "object" @@ -2521,7 +2535,7 @@ "id": "AdSize", "properties": { "height": { - "description": "The height of the ad slot in pixels.\nThis field will be present only when size type is `PIXEL`.", + "description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", "format": "int64", "type": "string" }, @@ -2539,12 +2553,12 @@ "Ad slot with size specified by height and width in pixels.", "Special size to describe an interstitial ad slot.", "Native (mobile) ads rendered by the publisher.", - "Fluid size (i.e., responsive size) can be resized automatically with the\nchange of outside environment." + "Fluid size (i.e., responsive size) can be resized automatically with the change of outside environment." ], "type": "string" }, "width": { - "description": "The width of the ad slot in pixels.\nThis field will be present only when size type is `PIXEL`.", + "description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", "format": "int64", "type": "string" } @@ -2556,7 +2570,7 @@ "id": "AdTechnologyProviders", "properties": { "detectedProviderIds": { - "description": "The detected ad technology provider IDs for this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for\nmapping of provider ID to provided name, a privacy policy URL, and a list\nof domains which can be attributed to the provider.\n\nIf the creative contains provider IDs that are outside of those listed in\nthe `BidRequest.adslot.consented_providers_settings.consented_providers`\nfield on the (Google bid\nprotocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto]\nand the\n`BidRequest.user.ext.consented_providers_settings.consented_providers`\nfield on the (OpenRTB\nprotocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto],\nand a bid is submitted with that creative for an impression that will\nserve to an EEA user, the bid will be filtered before the auction.", + "description": "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.", "items": { "format": "int64", "type": "string" @@ -2564,7 +2578,7 @@ "type": "array" }, "hasUnidentifiedProvider": { - "description": "Whether the creative contains an unidentified ad technology provider.\n\nIf true for a given creative, any bid submitted with that creative for an\nimpression that will serve to an EEA user will be filtered before the\nauction.", + "description": "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.", "type": "boolean" } }, @@ -2607,6 +2621,10 @@ "NATIVE", "WEB" ], + "enumDescriptions": [ + "Native app context.", + "Mobile web app context." + ], "type": "string" }, "type": "array" @@ -2629,6 +2647,10 @@ "OPEN_AUCTION", "DIRECT_DEALS" ], + "enumDescriptions": [ + "The restriction applies to open auction.", + "The restriction applies to direct deals." + ], "type": "string" }, "type": "array" @@ -2637,7 +2659,7 @@ "type": "object" }, "BidMetricsRow": { - "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;", + "description": "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;", "id": "BidMetricsRow", "properties": { "bids": { @@ -2658,11 +2680,11 @@ }, "measurableImpressions": { "$ref": "MetricValue", - "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)." + "description": "The number of bids for which the corresponding impression was measurable for viewability (as defined by Active View)." }, "reachedQueries": { "$ref": "MetricValue", - "description": "The number of bids that won the auction and also won the mediation\nwaterfall (if any)." + "description": "The number of bids that won the auction and also won the mediation waterfall (if any)." }, "rowDimensions": { "$ref": "RowDimensions", @@ -2670,25 +2692,25 @@ }, "viewableImpressions": { "$ref": "MetricValue", - "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)." + "description": "The number of bids for which the corresponding impression was viewable (as defined by Active View)." } }, "type": "object" }, "BidResponseWithoutBidsStatusRow": { - "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.", + "description": "The number of impressions with the specified dimension values that were considered to have no applicable bids, as described by the specified status.", "id": "BidResponseWithoutBidsStatusRow", "properties": { "impressionCount": { "$ref": "MetricValue", - "description": "The number of impressions for which there was a bid response with the\nspecified status." + "description": "The number of impressions for which there was a bid response with the specified status." }, "rowDimensions": { "$ref": "RowDimensions", "description": "The values of all dimensions associated with metric values in this row." }, "status": { - "description": "The status specifying why the bid responses were considered to have no\napplicable bids.", + "description": "The status specifying why the bid responses were considered to have no applicable bids.", "enum": [ "STATUS_UNSPECIFIED", "RESPONSES_WITHOUT_BIDS", @@ -2696,10 +2718,10 @@ "RESPONSES_WITHOUT_BIDS_FOR_DEAL" ], "enumDescriptions": [ - "A placeholder for an undefined status.\nThis value will never be returned in responses.", + "A placeholder for an undefined status. This value will never be returned in responses.", "The response had no bids.", - "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.\nApplies if:\n1. Request is on behalf of a bidder and an account filter is present.\n2. Request is on behalf of a child seat.", - "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs. If request is on behalf of a bidder and an account filter is not\npresent, this also includes responses that have bids on behalf of\naccounts other than the account to which the deal belongs." + "The response had no bids for the specified account, though it may have included bids on behalf of other accounts. Applies if: 1. Request is on behalf of a bidder and an account filter is present. 2. Request is on behalf of a child seat.", + "The response had no bids for the specified deal, though it may have included bids on other deals on behalf of the account to which the deal belongs. If request is on behalf of a bidder and an account filter is not present, this also includes responses that have bids on behalf of accounts other than the account to which the deal belongs." ], "type": "string" } @@ -2707,7 +2729,7 @@ "type": "object" }, "Buyer": { - "description": "Represents a buyer of inventory. Each buyer is identified by a unique\nAuthorized Buyers account ID.", + "description": "Represents a buyer of inventory. Each buyer is identified by a unique Authorized Buyers account ID.", "id": "Buyer", "properties": { "accountId": { @@ -2718,17 +2740,17 @@ "type": "object" }, "CalloutStatusRow": { - "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.", + "description": "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.", "id": "CalloutStatusRow", "properties": { "calloutStatusId": { - "description": "The ID of the callout status.\nSee\n[callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes).", + "description": "The ID of the callout status. See [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes).", "format": "int32", "type": "integer" }, "impressionCount": { "$ref": "MetricValue", - "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status." + "description": "The number of impressions for which there was a bid request or bid response with the specified callout status." }, "rowDimensions": { "$ref": "RowDimensions", @@ -2744,29 +2766,29 @@ "type": "object" }, "Client": { - "description": "A client resource represents a client buyer—an agency, a brand, or an\nadvertiser customer of the sponsor buyer. Users associated with the client\nbuyer have restricted access to the Marketplace and certain other sections of\nthe Authorized Buyers UI based on the role granted to the client buyer. All\nfields are required unless otherwise specified.", + "description": "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.", "id": "Client", "properties": { "clientAccountId": { - "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.", + "description": "The globally-unique numerical ID of the client. The value of this field is ignored in create and update operations.", "format": "int64", "type": "string" }, "clientName": { - "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.", + "description": "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.", "type": "string" }, "entityId": { - "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\nThe value of this field is ignored if the entity type is not provided.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.", + "description": "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.", "format": "int64", "type": "string" }, "entityName": { - "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.", + "description": "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.", "type": "string" }, "entityType": { - "description": "An optional field for specifying the type of the client entity:\n`ADVERTISER`, `BRAND`, or `AGENCY`.", + "description": "An optional field for specifying the type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.", "enum": [ "ENTITY_TYPE_UNSPECIFIED", "ADVERTISER", @@ -2779,16 +2801,16 @@ "An advertiser.", "A brand.", "An advertising agency.", - "An explicit value for a client that was not yet classified\nas any particular entity." + "An explicit value for a client that was not yet classified as any particular entity." ], "type": "string" }, "partnerClientId": { - "description": "Optional arbitrary unique identifier of this client buyer from the\nstandpoint of its Ad Exchange sponsor buyer.\n\nThis field can be used to associate a client buyer with the identifier\nin the namespace of its sponsor buyer, lookup client buyers by that\nidentifier and verify whether an Ad Exchange counterpart of a given client\nbuyer already exists.\n\nIf present, must be unique among all the client buyers for its\nAd Exchange sponsor buyer.", + "description": "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.", "type": "string" }, "role": { - "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", + "description": "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`.", "enum": [ "CLIENT_ROLE_UNSPECIFIED", "CLIENT_DEAL_VIEWER", @@ -2797,9 +2819,9 @@ ], "enumDescriptions": [ "A placeholder for an undefined client role.", - "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.", - "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.", - "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals." + "Users associated with this client can see publisher deal offers in the Marketplace. They can neither negotiate proposals nor approve deals. If this client is visible to publishers, they can send deal proposals to this client.", + "Users associated with this client can respond to deal proposals sent to them by publishers. They can also initiate deal proposals of their own.", + "Users associated with this client can approve eligible deals on your behalf. Some deals may still explicitly require publisher finalization. If this role is not selected, the sponsor buyer will need to manually approve each of their deals." ], "type": "string" }, @@ -2825,16 +2847,16 @@ "type": "object" }, "ClientUser": { - "description": "A client user is created under a client buyer and has restricted access to\nthe Marketplace and certain other sections of the Authorized Buyers UI based\non the role granted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.", + "description": "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 via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified.", "id": "ClientUser", "properties": { "clientAccountId": { - "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.", + "description": "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.", "format": "int64", "type": "string" }, "email": { - "description": "User's email address. The value of this field\nis ignored in an update operation.", + "description": "User's email address. The value of this field is ignored in an update operation.", "type": "string" }, "status": { @@ -2854,7 +2876,7 @@ "type": "string" }, "userId": { - "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.", + "description": "The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation.", "format": "int64", "type": "string" } @@ -2862,20 +2884,20 @@ "type": "object" }, "ClientUserInvitation": { - "description": "An invitation for a new client user to get access to the Authorized Buyers\nUI. All fields are required unless otherwise specified.", + "description": "An invitation for a new client user to get access to the Authorized Buyers UI. All fields are required unless otherwise specified.", "id": "ClientUserInvitation", "properties": { "clientAccountId": { - "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.", + "description": "Numerical account ID of the client buyer that the invited user is associated with. The value of this field is ignored in create operations.", "format": "int64", "type": "string" }, "email": { - "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.", + "description": "The email address to which the invitation is sent. Email addresses should be unique among all client users under each sponsor buyer.", "type": "string" }, "invitationId": { - "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.", + "description": "The unique numerical ID of the invitation that is sent to the user. The value of this field is ignored in create operations.", "format": "int64", "type": "string" } @@ -2939,16 +2961,16 @@ ], "enumDescriptions": [ "The correction type is unknown. Refer to the details for more information.", - "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.", - "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.", - "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.", - "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.", - "The ad did not declare a required creative attribute.\nThe attribute was added.", - "The ad did not declare a required technology vendor.\nThe technology vendor was added.", - "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.", - "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.", + "The ad's declared vendors did not match the vendors that were detected. The detected vendors were added.", + "The ad had the SSL attribute declared but was not SSL-compliant. The SSL attribute was removed.", + "The ad was declared as Flash-free but contained Flash, so the Flash-free attribute was removed.", + "The ad was not declared as Flash-free but it did not reference any flash content, so the Flash-free attribute was added.", + "The ad did not declare a required creative attribute. The attribute was added.", + "The ad did not declare a required technology vendor. The technology vendor was added.", + "The ad did not declare the SSL attribute but was SSL-compliant, so the SSL attribute was added.", + "Properties consistent with In-banner video were found, so an In-Banner Video attribute was added.", "The ad makes calls to the MRAID API so the MRAID attribute was added.", - "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.", + "The ad unnecessarily declared the Flash attribute, so the Flash attribute was removed.", "The ad contains video content." ], "type": "string" @@ -2961,7 +2983,7 @@ "id": "Creative", "properties": { "accountId": { - "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "description": "The account that this creative belongs to. Can be used to filter the response of the creatives.list method.", "type": "string" }, "adChoicesDestinationUrl": { @@ -2987,7 +3009,7 @@ "type": "string" }, "attributes": { - "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "description": "All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.", "enumDescriptions": [ "Do not use. This is a placeholder value only.", "The creative is of type image/rich media. For pretargeting.", @@ -3014,16 +3036,16 @@ "The creative is MRAID.", "The creative is Flash.", "The creative is HTML5.", - "The creative has an instream VAST video type of skippable instream video.\nFor pretargeting.", + "The creative has an instream VAST video type of skippable instream video. For pretargeting.", "The creative is SSL.", "The creative is non-SSL.", "The creative is an interstitial.", - "The creative has an instream VAST video type of non-skippable instream\nvideo. For pretargeting.", + "The creative has an instream VAST video type of non-skippable instream video. For pretargeting.", "The creative is eligible for native.", - "The creative has an instream VAST video type of non-VPAID. For\npretargeting.", + "The creative has an instream VAST video type of non-VPAID. For pretargeting.", "The creative is not eligible for native.", - "The creative has an interstitial size of any interstitial. For\npretargeting.", - "The creative has an interstitial size of non interstitial. For\npretargeting.", + "The creative has an interstitial size of any interstitial. For pretargeting.", + "The creative has an interstitial size of non interstitial. For pretargeting.", "The video type is in-banner video.", "The creative can dynamically resize to fill a variety of slot sizes.", "The open measurement SDK is supported." @@ -3069,6 +3091,46 @@ "RENDERING_SIZELESS_ADX", "OMSDK_1_0" ], + "enumDescriptions": [ + "Do not use. This is a placeholder value only.", + "The creative is of type image/rich media. For pretargeting.", + "The creative is of video type Adobe Flash FLV. For pretargeting.", + "The creative is tagged.", + "The creative is cookie targeted.", + "The creative is user interest targeted.", + "The creative does not expand.", + "The creative expands up.", + "The creative expands down.", + "The creative expands left.", + "The creative expands right.", + "The creative expands up and left.", + "The creative expands up and right.", + "The creative expands down and left.", + "The creative expands down and right.", + "The creative type is HTML.", + "The creative type is VAST video.", + "The creative expands up or down.", + "The creative expands left or right.", + "The creative expands on any diagonal.", + "The creative expands when rolled over.", + "The instream vast video type is vpaid flash.", + "The creative is MRAID.", + "The creative is Flash.", + "The creative is HTML5.", + "The creative has an instream VAST video type of skippable instream video. For pretargeting.", + "The creative is SSL.", + "The creative is non-SSL.", + "The creative is an interstitial.", + "The creative has an instream VAST video type of non-skippable instream video. For pretargeting.", + "The creative is eligible for native.", + "The creative has an instream VAST video type of non-VPAID. For pretargeting.", + "The creative is not eligible for native.", + "The creative has an interstitial size of any interstitial. For pretargeting.", + "The creative has an interstitial size of non interstitial. For pretargeting.", + "The video type is in-banner video.", + "The creative can dynamically resize to fill a variety of slot sizes.", + "The open measurement SDK is supported." + ], "type": "string" }, "type": "array" @@ -3088,11 +3150,11 @@ "type": "array" }, "creativeId": { - "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "description": "The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.", "type": "string" }, "dealsStatus": { - "description": "Output only. The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "description": "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.", "enum": [ "STATUS_UNSPECIFIED", "NOT_CHECKED", @@ -3105,7 +3167,7 @@ "enumDescriptions": [ "The status is unknown.", "The creative has not been checked.", - "The creative has been conditionally approved.\nSee serving_restrictions for details.", + "The creative has been conditionally approved. See serving_restrictions for details.", "The creative has been approved.", "The creative has been disapproved.", "Placeholder for transition to v1beta1. Currently not used.", @@ -3136,14 +3198,14 @@ "type": "array" }, "detectedLanguages": { - "description": "Output only. The detected languages for this creative. The order is\narbitrary. The codes are 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.", + "description": "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.", "items": { "type": "string" }, "type": "array" }, "detectedProductCategories": { - "description": "Output only. Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.", + "description": "Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs.", "items": { "format": "int32", "type": "integer" @@ -3151,7 +3213,7 @@ "type": "array" }, "detectedSensitiveCategories": { - "description": "Output only. Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.", + "description": "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.", "items": { "format": "int32", "type": "integer" @@ -3174,7 +3236,7 @@ "description": "A native creative." }, "openAuctionStatus": { - "description": "Output only. The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "description": "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.", "enum": [ "STATUS_UNSPECIFIED", "NOT_CHECKED", @@ -3187,7 +3249,7 @@ "enumDescriptions": [ "The status is unknown.", "The creative has not been checked.", - "The creative has been conditionally approved.\nSee serving_restrictions for details.", + "The creative has been conditionally approved. See serving_restrictions for details.", "The creative has been approved.", "The creative has been disapproved.", "Placeholder for transition to v1beta1. Currently not used.", @@ -3206,19 +3268,23 @@ "NO_RESTRICTED_CATEGORIES", "ALCOHOL" ], + "enumDescriptions": [ + "The ad has no restricted categories", + "The alcohol restricted category." + ], "type": "string" }, "type": "array" }, "servingRestrictions": { - "description": "Output only. The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).", + "description": "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 vs HTTP request, or the type of auction).", "items": { "$ref": "ServingRestriction" }, "type": "array" }, "vendorIds": { - "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.", + "description": "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.", "items": { "format": "int32", "type": "integer" @@ -3257,7 +3323,7 @@ "type": "object" }, "CreativeRestrictions": { - "description": "Represents creative restrictions associated to Programmatic Guaranteed/\nPreferred Deal in Ad Manager.\nThis doesn't apply to Private Auction and AdX Preferred Deals.", + "description": "Represents creative restrictions associated to Programmatic Guaranteed/ Preferred Deal in Ad Manager. This doesn't apply to Private Auction and AdX Preferred Deals.", "id": "CreativeRestrictions", "properties": { "creativeFormat": { @@ -3270,7 +3336,7 @@ "enumDescriptions": [ "A placeholder for an undefined creative format.", "A creative that will be displayed in environments such as a browser.", - "A video creative that will be displayed in environments such as a video\nplayer." + "A video creative that will be displayed in environments such as a video player." ], "type": "string" }, @@ -3291,7 +3357,7 @@ "enumDescriptions": [ "A placeholder for an undefined skippable ad type.", "This video ad can be skipped after 5 seconds.", - "This video ad can be skipped after 5 seconds, and is counted as\nengaged view after 30 seconds. The creative is hosted on\nYouTube only, and viewcount of the YouTube video increments\nafter the engaged view.", + "This video ad can be skipped after 5 seconds, and is counted as engaged view after 30 seconds. The creative is hosted on YouTube only, and viewcount of the YouTube video increments after the engaged view.", "This video ad is not skippable." ], "type": "string" @@ -3304,7 +3370,7 @@ "id": "CreativeSize", "properties": { "allowedFormats": { - "description": "What formats are allowed by the publisher.\nIf this repeated field is empty then all formats are allowed.\nFor example, if this field contains AllowedFormatType.AUDIO then the\npublisher only allows an audio ad (without any video).", + "description": "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).", "enumDescriptions": [ "A placeholder for an undefined allowed format.", "An audio-only ad (without any video)." @@ -3314,12 +3380,16 @@ "UNKNOWN", "AUDIO" ], + "enumDescriptions": [ + "A placeholder for an undefined allowed format.", + "An audio-only ad (without any video)." + ], "type": "string" }, "type": "array" }, "companionSizes": { - "description": "For video creatives specifies the sizes of companion ads (if present).\nCompanion sizes may be filled in only when creative_size_type = VIDEO", + "description": "For video creatives specifies the sizes of companion ads (if present). Companion sizes may be filled in only when creative_size_type = VIDEO", "items": { "$ref": "Size" }, @@ -3344,7 +3414,7 @@ "type": "string" }, "nativeTemplate": { - "description": "Output only. The native template for this creative. It will have a value\nonly if creative_size_type = CreativeSizeType.NATIVE.", + "description": "Output only. The native template for this creative. It will have a value only if creative_size_type = CreativeSizeType.NATIVE.", "enum": [ "UNKNOWN_NATIVE_TEMPLATE", "NATIVE_CONTENT_AD", @@ -3363,10 +3433,10 @@ }, "size": { "$ref": "Size", - "description": "For regular or video creative size type, specifies the size\nof the creative" + "description": "For regular or video creative size type, specifies the size of the creative" }, "skippableAdType": { - "description": "The type of skippable ad for this creative. It will have a value only if\ncreative_size_type = CreativeSizeType.VIDEO.", + "description": "The type of skippable ad for this creative. It will have a value only if creative_size_type = CreativeSizeType.VIDEO.", "enum": [ "SKIPPABLE_AD_TYPE_UNSPECIFIED", "GENERIC", @@ -3376,7 +3446,7 @@ "enumDescriptions": [ "A placeholder for an undefined skippable ad type.", "This video ad can be skipped after 5 seconds.", - "This video ad can be skipped after 5 seconds, and count as\nengaged view after 30 seconds. The creative is hosted on\nYouTube only, and viewcount of the YouTube video increments\nafter the engaged view.", + "This video ad can be skipped after 5 seconds, and count as engaged view after 30 seconds. The creative is hosted on YouTube only, and viewcount of the YouTube video increments after the engaged view.", "This video ad is not skippable." ], "type": "string" @@ -3385,7 +3455,7 @@ "type": "object" }, "CreativeSpecification": { - "description": "Represents information for a creative that is associated with a Programmatic\nGuaranteed/Preferred Deal in Ad Manager.", + "description": "Represents information for a creative that is associated with a Programmatic Guaranteed/Preferred Deal in Ad Manager.", "id": "CreativeSpecification", "properties": { "creativeCompanionSizes": { @@ -3403,7 +3473,7 @@ "type": "object" }, "CreativeStatusRow": { - "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.", + "description": "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.", "id": "CreativeStatusRow", "properties": { "bidCount": { @@ -3411,7 +3481,7 @@ "description": "The number of bids with the specified status." }, "creativeStatusId": { - "description": "The ID of the creative status.\nSee\n[creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).", + "description": "The ID of the creative status. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).", "format": "int32", "type": "integer" }, @@ -3423,7 +3493,7 @@ "type": "object" }, "CriteriaTargeting": { - "description": "Generic targeting used for targeting dimensions that contains a list of\nincluded and excluded numeric IDs.", + "description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs.", "id": "CriteriaTargeting", "properties": { "excludedCriteriaIds": { @@ -3446,21 +3516,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day\nand time zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. This can represent:\n\n* A full date, with non-zero year, month and day values\n* A month and day value, with a zero year, e.g. an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, e.g. a credit card expiration date\n\nRelated types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year by itself or a year and month where the day is not\nsignificant.", + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a\nmonth and day.", + "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.", + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", "format": "int32", "type": "integer" } @@ -3468,7 +3538,7 @@ "type": "object" }, "DayPart": { - "description": "Daypart targeting message that specifies if the ad can be shown\nonly during certain parts of a day/week.", + "description": "Daypart targeting message that specifies if the ad can be shown only during certain parts of a day/week.", "id": "DayPart", "properties": { "dayOfWeek": { @@ -3497,11 +3567,11 @@ }, "endTime": { "$ref": "TimeOfDay", - "description": "The ending time of the day for the ad to show (minute level\ngranularity). The end time is exclusive. This field is not available\nfor filtering in PQL queries." + "description": "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." }, "startTime": { "$ref": "TimeOfDay", - "description": "The starting time of day for the ad to show (minute level granularity).\nThe start time is inclusive.\nThis field is not available for filtering in PQL queries." + "description": "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." } }, "type": "object" @@ -3535,16 +3605,16 @@ "type": "object" }, "Deal": { - "description": "A deal represents a segment of inventory for displaying ads on.\nA proposal can contain multiple deals. A deal contains the terms and\ntargeting information that is used for serving.", + "description": "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.", "id": "Deal", "properties": { "availableEndTime": { - "description": "Proposed flight end time of the deal.\nThis will generally be stored in a granularity of a second.\nA value is not required for Private Auction deals or Preferred Deals.", + "description": "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.", "format": "google-datetime", "type": "string" }, "availableStartTime": { - "description": "Optional proposed flight start time of the deal.\nThis will generally be stored in the granularity of one second since deal\nserving starts at seconds boundary. Any time specified with more\ngranularity (e.g., in milliseconds) will be truncated towards the start of\ntime in seconds.", + "description": "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 (e.g., in milliseconds) will be truncated towards the start of time in seconds.", "format": "google-datetime", "type": "string" }, @@ -3553,11 +3623,11 @@ "description": "Buyer private data (hidden from seller)." }, "createProductId": { - "description": "The product ID from which this deal was created.\n\nNote: This field may be set only when creating the resource. Modifying\nthis field while updating the resource will result in an error.", + "description": "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.", "type": "string" }, "createProductRevision": { - "description": "Optional revision number of the product that the deal was created from.\nIf present on create, and the server `product_revision` has advanced sinced\nthe passed-in `create_product_revision`, an `ABORTED` error will be\nreturned.\n\nNote: This field may be set only when creating the resource. Modifying\nthis field while updating the resource will result in an error.", + "description": "Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced 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.", "format": "int64", "type": "string" }, @@ -3582,7 +3652,7 @@ }, "creativeRestrictions": { "$ref": "CreativeRestrictions", - "description": "Output only. Restricitions about the creatives associated with the deal\n(i.e., size) This is available for Programmatic Guaranteed/Preferred Deals\nin Ad Manager." + "description": "Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager." }, "creativeSafeFrameCompatibility": { "description": "Output only. Specifies whether the creative is safeFrame compatible.", @@ -3612,7 +3682,7 @@ }, "deliveryControl": { "$ref": "DeliveryControl", - "description": "The set of fields around delivery control that are interesting for a buyer\nto see but are non-negotiable. These are set by the publisher." + "description": "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." }, "description": { "description": "Description for the deal terms.", @@ -3623,15 +3693,15 @@ "type": "string" }, "externalDealId": { - "description": "Output only. The external deal ID assigned to this deal once the deal is\nfinalized. This is the deal ID that shows up in serving/reporting etc.", + "description": "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.", "type": "string" }, "isSetupComplete": { - "description": "Output only. True, if the buyside inventory setup is complete for this\ndeal.", + "description": "Output only. True, if the buyside inventory setup is complete for this deal.", "type": "boolean" }, "programmaticCreativeSource": { - "description": "Output only. Specifies the creative source for programmatic deals.\nPUBLISHER means creative is provided by seller and ADVERTISER means\ncreative is provided by buyer.", + "description": "Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by buyer.", "enum": [ "PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED", "ADVERTISER", @@ -3656,7 +3726,7 @@ "type": "array" }, "syndicationProduct": { - "description": "The syndication product associated with the deal.\n\nNote: This field may be set only when creating the resource. Modifying\nthis field while updating the resource will result in an error.", + "description": "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.", "enum": [ "SYNDICATION_PRODUCT_UNSPECIFIED", "CONTENT", @@ -3678,7 +3748,7 @@ "description": "Output only. Specifies the subset of inventory targeted by the deal." }, "targetingCriterion": { - "description": "The shared targeting visible to buyers and sellers. Each shared\ntargeting entity is AND'd together.", + "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.", "items": { "$ref": "TargetingCriteria" }, @@ -3697,7 +3767,7 @@ "type": "object" }, "DealPauseStatus": { - "description": "Tracks which parties (if any) have paused a deal.\nThe deal is considered paused if either hasBuyerPaused or\nhasSellPaused is true.", + "description": "Tracks which parties (if any) have paused a deal. The deal is considered paused if either hasBuyerPaused or hasSellPaused is true.", "id": "DealPauseStatus", "properties": { "buyerPauseReason": { @@ -3745,7 +3815,7 @@ "type": "object" }, "DealTerms": { - "description": "The deal terms specify the details of a Product/deal. They specify things\nlike price per buyer, the type of pricing model (e.g., fixed price, auction)\nand expected impressions from the publisher.", + "description": "The deal terms specify the details of a Product/deal. They specify things like price per buyer, the type of pricing model (e.g., fixed price, auction) and expected impressions from the publisher.", "id": "DealTerms", "properties": { "brandingType": { @@ -3758,7 +3828,7 @@ "enumDescriptions": [ "A placeholder for an undefined branding type.", "Full URL is included in bid requests.", - "A TopLevelDomain or masked URL is sent in bid requests\nrather than the full one." + "A TopLevelDomain or masked URL is sent in bid requests rather than the full one." ], "type": "string" }, @@ -3768,10 +3838,10 @@ }, "estimatedGrossSpend": { "$ref": "Price", - "description": "Non-binding estimate of the estimated gross spend for this deal.\nCan be set by buyer or seller." + "description": "Non-binding estimate of the estimated gross spend for this deal. Can be set by buyer or seller." }, "estimatedImpressionsPerDay": { - "description": "Non-binding estimate of the impressions served per day.\nCan be set by buyer or seller.", + "description": "Non-binding estimate of the impressions served per day. Can be set by buyer or seller.", "format": "int64", "type": "string" }, @@ -3788,7 +3858,7 @@ "description": "The terms for non-guaranteed fixed price deals." }, "sellerTimeZone": { - "description": "The time zone name. For deals with Cost Per Day billing, defines the\ntime zone used to mark the boundaries of a day. It should be an\nIANA TZ name, such as \"America/Los_Angeles\". For more information,\nsee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.", + "description": "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.", "type": "string" } }, @@ -3960,11 +4030,11 @@ "The click through URL doesn't work properly.", "Something is wrong with the creative itself.", "The ad makes a fourth party call to an unapproved vendor.", - "The ad targets consumers using remarketing lists and/or collects\ndata for subsequent use in retargeting, but does not correctly declare\nthat use.", + "The ad targets consumers using remarketing lists and/or collects data for subsequent use in retargeting, but does not correctly declare that use.", "Clicking on the ad leads to an error page.", "The ad size when rendered does not match the declaration.", "Ads with a white background require a border, which was missing.", - "The creative attempts to set cookies from a fourth party that is not\ncertified.", + "The creative attempts to set cookies from a fourth party that is not certified.", "The creative sets an LSO object.", "The ad serves a blank.", "The ad uses rotation, but not all destination URLs were declared.", @@ -3987,7 +4057,7 @@ "The ad causes a popup window to appear.", "The creative does not follow policies set for the RTB protocol.", "The ad contains a URL that uses a numeric IP address for the domain.", - "The ad or landing page contains unacceptable content because it initiated\na software or executable download.", + "The ad or landing page contains unacceptable content because it initiated a software or executable download.", "The ad set an unauthorized cookie on a Google domain.", "Flash content found when no flash was declared.", "SSL support declared but not working correctly.", @@ -3995,7 +4065,7 @@ "Maximum download size exceeded.", "Bad Destination URL: Site Not Crawlable.", "Bad URL: Legal disapproval.", - "Pharmaceuticals, Gambling, Alcohol not allowed and at least one was\ndetected.", + "Pharmaceuticals, Gambling, Alcohol not allowed and at least one was detected.", "Dynamic DNS at Destination URL.", "Poor Image / Video Quality.", "For example, Image Trick to Click.", @@ -4005,9 +4075,9 @@ "Misleading/Inaccurate claims in ads.", "Restricted Products.", "Unacceptable content. For example, malware.", - "The ad automatically redirects to the destination site without a click,\nor reports a click when none were made.", + "The ad automatically redirects to the destination site without a click, or reports a click when none were made.", "The ad uses URL protocols that do not exist or are not allowed on AdX.", - "Restricted content (for example, alcohol) was found in the ad but not\ndeclared.", + "Restricted content (for example, alcohol) was found in the ad but not declared.", "Violation of the remarketing list policy.", "The destination site's robot.txt file prevents it from being crawled.", "Click to download must link to an app.", @@ -4065,40 +4135,44 @@ "type": "object" }, "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", + "description": "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 `{}`.", "id": "Empty", "properties": {}, "type": "object" }, "FilterSet": { - "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field, e.g.,\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\".", + "description": "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, e.g., \"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR seller_network_id=56)\".", "id": "FilterSet", "properties": { "absoluteDateRange": { "$ref": "AbsoluteDateRange", - "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone." + "description": "An absolute date range, defined by a start date and an end date. Interpreted relative to Pacific time zone." }, "breakdownDimensions": { - "description": "The set of dimensions along which to break down the response; may be empty.\nIf multiple dimensions are requested, the breakdown is along the Cartesian\nproduct of the requested dimensions.", + "description": "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.", "enumDescriptions": [ "A placeholder for an unspecified dimension; should not be used.", - "The response should be broken down by publisher identifier.\nThis option is available only for Open Bidding buyers." + "The response should be broken down by publisher identifier. This option is available only for Open Bidding buyers." ], "items": { "enum": [ "BREAKDOWN_DIMENSION_UNSPECIFIED", "PUBLISHER_IDENTIFIER" ], + "enumDescriptions": [ + "A placeholder for an unspecified dimension; should not be used.", + "The response should be broken down by publisher identifier. This option is available only for Open Bidding buyers." + ], "type": "string" }, "type": "array" }, "creativeId": { - "description": "The ID of the creative on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.", + "description": "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, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.", "type": "string" }, "dealId": { - "description": "The ID of the deal on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e., one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.", + "description": "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, i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern.", "format": "int64", "type": "string" }, @@ -4110,7 +4184,7 @@ "APP" ], "enumDescriptions": [ - "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.", + "A placeholder for an undefined environment; indicates that no environment filter will be applied.", "The ad impression appears on the web.", "The ad impression appears in an app." ], @@ -4126,7 +4200,7 @@ "NON_NATIVE_VIDEO" ], "enumDescriptions": [ - "A placeholder for an undefined format; indicates that no format filter\nwill be applied.", + "A placeholder for an undefined format; indicates that no format filter will be applied.", "The ad impression is a native ad, and display (i.e., image) format.", "The ad impression is a native ad, and video format.", "The ad impression is not a native ad, and display (i.e., image) format.", @@ -4135,9 +4209,9 @@ "type": "string" }, "formats": { - "description": "Creative formats bidded on or allowed to bid on, can be empty. Although\nthis field is a list, it can only be populated with a single item. A\nHTTP 400 bad request error will be returned in the response if you specify\nmultiple items.", + "description": "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.", "enumDescriptions": [ - "A placeholder for an undefined format; indicates that no format filter\nwill be applied.", + "A placeholder for an undefined format; indicates that no format filter will be applied.", "The ad impression is a native ad, and display (i.e., image) format.", "The ad impression is a native ad, and video format.", "The ad impression is not a native ad, and display (i.e., image) format.", @@ -4151,18 +4225,25 @@ "NON_NATIVE_DISPLAY", "NON_NATIVE_VIDEO" ], + "enumDescriptions": [ + "A placeholder for an undefined format; indicates that no format filter will be applied.", + "The ad impression is a native ad, and display (i.e., image) format.", + "The ad impression is a native ad, and video format.", + "The ad impression is not a native ad, and display (i.e., image) format.", + "The ad impression is not a native ad, and video format." + ], "type": "string" }, "type": "array" }, "name": { - "description": "A user-defined name of the filter set. Filter set names must be unique\nglobally and match one of the patterns:\n\n- `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting\ndata)\n- `bidders/*/accounts/*/filterSets/*` (for accessing account-level\ntroubleshooting data)\n\nThis field is required in create operations.", + "description": "A user-defined name of the filter set. Filter set names must be unique globally and match one of the patterns: - `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting data) - `bidders/*/accounts/*/filterSets/*` (for accessing account-level troubleshooting data) This field is required in create operations.", "type": "string" }, "platforms": { - "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e., if non-empty,\nresults must match any one of the platforms).", + "description": "The list of platforms on which to filter; may be empty. The filters represented by multiple platforms are ORed together (i.e., if non-empty, results must match any one of the platforms).", "enumDescriptions": [ - "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.", + "A placeholder for an undefined platform; indicates that no platform filter will be applied.", "The ad impression appears on a desktop.", "The ad impression appears on a tablet.", "The ad impression appears on a mobile device." @@ -4174,12 +4255,18 @@ "TABLET", "MOBILE" ], + "enumDescriptions": [ + "A placeholder for an undefined platform; indicates that no platform filter will be applied.", + "The ad impression appears on a desktop.", + "The ad impression appears on a tablet.", + "The ad impression appears on a mobile device." + ], "type": "string" }, "type": "array" }, "publisherIdentifiers": { - "description": "For Open Bidding partners only.\nThe list of publisher identifiers on which to filter; may be empty.\nThe filters represented by multiple publisher identifiers are ORed\ntogether.", + "description": "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.", "items": { "type": "string" }, @@ -4187,14 +4274,14 @@ }, "realtimeTimeRange": { "$ref": "RealtimeTimeRange", - "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp." + "description": "An open-ended realtime time range, defined by the aggregation start timestamp." }, "relativeDateRange": { "$ref": "RelativeDateRange", - "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone." + "description": "A relative date range, defined by an offset from today and a duration. Interpreted relative to Pacific time zone." }, "sellerNetworkIds": { - "description": "For Authorized Buyers only.\nThe list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e., if non-empty, results must match any one of the\npublisher networks). See\n[seller-network-ids](https://developers.google.com/authorized-buyers/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.", + "description": "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 (i.e., 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.", "items": { "format": "int32", "type": "integer" @@ -4202,14 +4289,14 @@ "type": "array" }, "timeSeriesGranularity": { - "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.", + "description": "The granularity of time intervals if a time series breakdown is desired; optional.", "enum": [ "TIME_SERIES_GRANULARITY_UNSPECIFIED", "HOURLY", "DAILY" ], "enumDescriptions": [ - "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.", + "A placeholder for an unspecified interval; no time series is applied. All rows in response will contain data for the entire requested time range.", "Indicates that data will be broken down by the hour.", "Indicates that data will be broken down by the day." ], @@ -4219,7 +4306,7 @@ "type": "object" }, "FilteredBidCreativeRow": { - "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.", + "description": "The number of filtered bids with the specified dimension values that have the specified creative.", "id": "FilteredBidCreativeRow", "properties": { "bidCount": { @@ -4238,7 +4325,7 @@ "type": "object" }, "FilteredBidDetailRow": { - "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.", + "description": "The number of filtered bids with the specified dimension values, among those filtered due to the requested filtering reason (i.e. creative status), that have the specified detail.", "id": "FilteredBidDetailRow", "properties": { "bidCount": { @@ -4246,7 +4333,7 @@ "description": "The number of bids with the specified detail." }, "detailId": { - "description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.", + "description": "The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.", "format": "int32", "type": "integer" }, @@ -4258,7 +4345,7 @@ "type": "object" }, "FirstPartyMobileApplicationTargeting": { - "description": "Represents a list of targeted and excluded mobile application IDs that\npublishers own.\nMobile application IDs are from App Store and Google Play Store.\nAndroid App ID, for example, com.google.android.apps.maps, can be found in\nGoogle Play Store URL.\niOS App ID (which is a number) can be found at the end of iTunes store URL.\nFirst party mobile applications is either included or excluded.", + "description": "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.", "id": "FirstPartyMobileApplicationTargeting", "properties": { "excludedAppIds": { @@ -4283,17 +4370,17 @@ "id": "FrequencyCap", "properties": { "maxImpressions": { - "description": "The maximum number of impressions that can be served to a user within the\nspecified time period.", + "description": "The maximum number of impressions that can be served to a user within the specified time period.", "format": "int32", "type": "integer" }, "numTimeUnits": { - "description": "The amount of time, in the units specified by time_unit_type. Defines the\namount of time over which impressions per user are counted and capped.", + "description": "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.", "format": "int32", "type": "integer" }, "timeUnitType": { - "description": "The time unit. Along with num_time_units defines the amount of time over\nwhich impressions per user are counted and capped.", + "description": "The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.", "enum": [ "TIME_UNIT_TYPE_UNSPECIFIED", "MINUTE", @@ -4304,7 +4391,7 @@ "LIFETIME" ], "enumDescriptions": [ - "A placeholder for an undefined time unit type. This just indicates the\nvariable with this value hasn't been initialized.", + "A placeholder for an undefined time unit type. This just indicates the variable with this value hasn't been initialized.", "Minute", "Hour", "Day", @@ -4329,7 +4416,7 @@ "type": "array" }, "guaranteedImpressions": { - "description": "Guaranteed impressions as a percentage. This is the percentage\nof guaranteed looks that the buyer is guaranteeing to buy.", + "description": "Guaranteed impressions as a percentage. This is the percentage of guaranteed looks that the buyer is guaranteeing to buy.", "format": "int64", "type": "string" }, @@ -4368,7 +4455,7 @@ "type": "object" }, "Image": { - "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.", + "description": "An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved.", "id": "Image", "properties": { "height": { @@ -4389,16 +4476,16 @@ "type": "object" }, "ImpressionMetricsRow": { - "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.", + "description": "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.", "id": "ImpressionMetricsRow", "properties": { "availableImpressions": { "$ref": "MetricValue", - "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable." + "description": "The number of impressions available to the buyer on Ad Exchange. In some cases this value may be unavailable." }, "bidRequests": { "$ref": "MetricValue", - "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest." + "description": "The number of impressions for which Ad Exchange sent the buyer a bid request." }, "inventoryMatches": { "$ref": "MetricValue", @@ -4406,7 +4493,7 @@ }, "responsesWithBids": { "$ref": "MetricValue", - "description": "The number of impressions for which Ad Exchange received a response from\nthe buyer that contained at least one applicable bid." + "description": "The number of impressions for which Ad Exchange received a response from the buyer that contained at least one applicable bid." }, "rowDimensions": { "$ref": "RowDimensions", @@ -4414,13 +4501,13 @@ }, "successfulResponses": { "$ref": "MetricValue", - "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange." + "description": "The number of impressions for which the buyer successfully sent a response to Ad Exchange." } }, "type": "object" }, "InventorySizeTargeting": { - "description": "Represents the size of an ad unit that can be targeted on an ad\nrequest. It only applies to Private Auction, AdX Preferred Deals and\nAuction Packages. This targeting does not apply to Programmatic Guaranteed\nand Preferred Deals in Ad Manager.", + "description": "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.", "id": "InventorySizeTargeting", "properties": { "excludedInventorySizes": { @@ -4452,14 +4539,14 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the bidMetrics.list\nmethod to retrieve the next page of results.", + "description": "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.", "type": "string" } }, "type": "object" }, "ListBidResponseErrorsResponse": { - "description": "Response message for listing all reasons that bid responses resulted in an\nerror.", + "description": "Response message for listing all reasons that bid responses resulted in an error.", "id": "ListBidResponseErrorsResponse", "properties": { "calloutStatusRows": { @@ -4470,25 +4557,25 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the bidResponseErrors.list\nmethod to retrieve the next page of results.", + "description": "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.", "type": "string" } }, "type": "object" }, "ListBidResponsesWithoutBidsResponse": { - "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.", + "description": "Response message for listing all reasons that bid responses were considered to have no applicable bids.", "id": "ListBidResponsesWithoutBidsResponse", "properties": { "bidResponseWithoutBidsStatusRows": { - "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.", + "description": "List of rows, with counts of bid responses without bids aggregated by status.", "items": { "$ref": "BidResponseWithoutBidsStatusRow" }, "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.", + "description": "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.", "type": "string" } }, @@ -4505,7 +4592,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListClientUserInvitationsRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.", "type": "string" } }, @@ -4515,7 +4602,7 @@ "id": "ListClientUsersResponse", "properties": { "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the clients.invitations.list method to retrieve the next page of results.", "type": "string" }, "users": { @@ -4539,32 +4626,32 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the accounts.clients.list method to retrieve the next page of results.", "type": "string" } }, "type": "object" }, "ListCreativeStatusBreakdownByCreativeResponse": { - "description": "Response message for listing all creatives associated with a given filtered\nbid reason.", + "description": "Response message for listing all creatives associated with a given filtered bid reason.", "id": "ListCreativeStatusBreakdownByCreativeResponse", "properties": { "filteredBidCreativeRows": { - "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.", + "description": "List of rows, with counts of bids with a given creative status aggregated by creative.", "items": { "$ref": "FilteredBidCreativeRow" }, "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByCreativeRequest.pageToken field in the subsequent call to the filteredBids.creatives.list method to retrieve the next page of results.", "type": "string" } }, "type": "object" }, "ListCreativeStatusBreakdownByDetailResponse": { - "description": "Response message for listing all details associated with a given filtered bid\nreason.", + "description": "Response message for listing all details associated with a given filtered bid reason.", "id": "ListCreativeStatusBreakdownByDetailResponse", "properties": { "detailType": { @@ -4578,24 +4665,24 @@ "DISAPPROVAL_REASON" ], "enumDescriptions": [ - "A placeholder for an undefined status.\nThis value will never be returned in responses.", - "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/authorized-buyers/rtb/downloads/publisher-excludable-creative-attributes).", - "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/authorized-buyers/rtb/downloads/vendors).", - "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-sensitive-categories).", - "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-product-categories).", - "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in\n[snippet-status-report-proto](https://developers.google.com/authorized-buyers/rtb/downloads/snippet-status-report-proto)." + "A placeholder for an undefined status. This value will never be returned in responses.", + "Indicates that the detail ID refers to a creative attribute; see [publisher-excludable-creative-attributes](https://developers.google.com/authorized-buyers/rtb/downloads/publisher-excludable-creative-attributes).", + "Indicates that the detail ID refers to a vendor; see [vendors](https://developers.google.com/authorized-buyers/rtb/downloads/vendors).", + "Indicates that the detail ID refers to a sensitive category; see [ad-sensitive-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-sensitive-categories).", + "Indicates that the detail ID refers to a product category; see [ad-product-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-product-categories).", + "Indicates that the detail ID refers to a disapproval reason; see DisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/authorized-buyers/rtb/downloads/snippet-status-report-proto)." ], "type": "string" }, "filteredBidDetailRows": { - "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.", + "description": "List of rows, with counts of bids with a given creative status aggregated by detail.", "items": { "$ref": "FilteredBidDetailRow" }, "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the filteredBids.details.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListCreativeStatusBreakdownByDetailRequest.pageToken field in the subsequent call to the filteredBids.details.list method to retrieve the next page of results.", "type": "string" } }, @@ -4613,7 +4700,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results.", "type": "string" } }, @@ -4631,7 +4718,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListDealAssociationsRequest.page_token field in the subsequent call to 'ListDealAssociation' method to retrieve the next page of results.", "type": "string" } }, @@ -4649,50 +4736,50 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListFilterSetsRequest.pageToken field in the subsequent call to the accounts.filterSets.list method to retrieve the next page of results.", "type": "string" } }, "type": "object" }, "ListFilteredBidRequestsResponse": { - "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.", + "description": "Response message for listing all reasons that bid requests were filtered and not sent to the buyer.", "id": "ListFilteredBidRequestsResponse", "properties": { "calloutStatusRows": { - "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.", + "description": "List of rows, with counts of filtered bid requests aggregated by callout status.", "items": { "$ref": "CalloutStatusRow" }, "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the filteredBidRequests.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListFilteredBidRequestsRequest.pageToken field in the subsequent call to the filteredBidRequests.list method to retrieve the next page of results.", "type": "string" } }, "type": "object" }, "ListFilteredBidsResponse": { - "description": "Response message for listing all reasons that bids were filtered from the\nauction.", + "description": "Response message for listing all reasons that bids were filtered from the auction.", "id": "ListFilteredBidsResponse", "properties": { "creativeStatusRows": { - "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).", + "description": "List of rows, with counts of filtered bids aggregated by filtering reason (i.e. creative status).", "items": { "$ref": "CreativeStatusRow" }, "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the filteredBids.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListFilteredBidsRequest.pageToken field in the subsequent call to the filteredBids.list method to retrieve the next page of results.", "type": "string" } }, "type": "object" }, "ListImpressionMetricsResponse": { - "description": "Response message for listing the metrics that are measured in number of\nimpressions.", + "description": "Response message for listing the metrics that are measured in number of impressions.", "id": "ListImpressionMetricsResponse", "properties": { "impressionMetricsRows": { @@ -4703,7 +4790,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the impressionMetrics.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListImpressionMetricsRequest.pageToken field in the subsequent call to the impressionMetrics.list method to retrieve the next page of results.", "type": "string" } }, @@ -4714,25 +4801,25 @@ "id": "ListLosingBidsResponse", "properties": { "creativeStatusRows": { - "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).", + "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e. creative status).", "items": { "$ref": "CreativeStatusRow" }, "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the losingBids.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListLosingBidsRequest.pageToken field in the subsequent call to the losingBids.list method to retrieve the next page of results.", "type": "string" } }, "type": "object" }, "ListNonBillableWinningBidsResponse": { - "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.", + "description": "Response message for listing all reasons for which a buyer was not billed for a winning bid.", "id": "ListNonBillableWinningBidsResponse", "properties": { "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the nonBillableWinningBids.list\nmethod to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the ListNonBillableWinningBidsRequest.pageToken field in the subsequent call to the nonBillableWinningBids.list method to retrieve the next page of results.", "type": "string" }, "nonBillableWinningBidStatusRows": { @@ -4804,7 +4891,7 @@ "id": "LocationContext", "properties": { "geoCriteriaIds": { - "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.", + "description": "IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs.", "items": { "format": "int32", "type": "integer" @@ -4815,7 +4902,7 @@ "type": "object" }, "MarketplaceTargeting": { - "description": "Targeting represents different criteria that can be used by advertisers to\ntarget ad inventory. For example, they can choose to target ad requests only\nif the user is in the US.\nMultiple types of targeting are always applied as a logical AND, unless noted\notherwise.", + "description": "Targeting represents different criteria that can be used by advertisers to target ad inventory. For example, they can choose to target ad requests only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise.", "id": "MarketplaceTargeting", "properties": { "geoTargeting": { @@ -4842,7 +4929,7 @@ "type": "object" }, "MetricValue": { - "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).", + "description": "A metric value, with an expected value and a variance; represents a count that may be either exact or estimated (i.e. when sampled).", "id": "MetricValue", "properties": { "value": { @@ -4851,7 +4938,7 @@ "type": "string" }, "variance": { - "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value", + "description": "The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value", "format": "int64", "type": "string" } @@ -4864,7 +4951,7 @@ "properties": { "firstPartyTargeting": { "$ref": "FirstPartyMobileApplicationTargeting", - "description": "Publisher owned apps to be targeted or excluded by the publisher to\ndisplay the ads in." + "description": "Publisher owned apps to be targeted or excluded by the publisher to display the ads in." } }, "type": "object" @@ -4878,12 +4965,12 @@ "type": "string" }, "nanos": { - "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "description": "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.", "format": "int32", "type": "integer" }, "units": { - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "format": "int64", "type": "string" } @@ -4951,7 +5038,7 @@ "type": "object" }, "NonBillableWinningBidStatusRow": { - "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.", + "description": "The number of winning bids with the specified dimension values for which the buyer was not billed, as described by the specified status.", "id": "NonBillableWinningBidStatusRow", "properties": { "bidCount": { @@ -4972,11 +5059,11 @@ "LOST_IN_MEDIATION" ], "enumDescriptions": [ - "A placeholder for an undefined status.\nThis value will never be returned in responses.", - "The buyer was not billed because the ad was not rendered by the\npublisher.", - "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid.", - "A video impression was served but a fatal error was reported from the\nclient during playback.", - "The buyer was not billed because the ad was outplaced in the mediation\nwaterfall." + "A placeholder for an undefined status. This value will never be returned in responses.", + "The buyer was not billed because the ad was not rendered by the publisher.", + "The buyer was not billed because the impression won by the bid was determined to be invalid.", + "A video impression was served but a fatal error was reported from the client during playback.", + "The buyer was not billed because the ad was outplaced in the mediation waterfall." ], "type": "string" } @@ -4984,11 +5071,11 @@ "type": "object" }, "NonGuaranteedAuctionTerms": { - "description": "Terms for Private Auctions. Note that Private Auctions can be created only\nby the seller, but they can be returned in a get or list request.", + "description": "Terms for Private Auctions. Note that Private Auctions can be created only by the seller, but they can be returned in a get or list request.", "id": "NonGuaranteedAuctionTerms", "properties": { "autoOptimizePrivateAuction": { - "description": "True if open auction buyers are allowed to compete with invited buyers\nin this private auction.", + "description": "True if open auction buyers are allowed to compete with invited buyers in this private auction.", "type": "boolean" }, "reservePricesPerBuyer": { @@ -5002,7 +5089,7 @@ "type": "object" }, "NonGuaranteedFixedPriceTerms": { - "description": "Terms for Preferred Deals. Note that Preferred Deals cannot be created via\nthe API at this time, but can be returned in a get or list request.", + "description": "Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request.", "id": "NonGuaranteedFixedPriceTerms", "properties": { "fixedPrices": { @@ -5039,7 +5126,7 @@ "type": "string" }, "note": { - "description": "The actual note to attach.\n(max-length: 1024 unicode code units)\n\nNote: This field may be set only when creating the resource. Modifying\nthis field while updating the resource will result in an error.", + "description": "The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", "type": "string" }, "noteId": { @@ -5074,19 +5161,19 @@ "id": "PauseProposalRequest", "properties": { "reason": { - "description": "The reason why the proposal is being paused.\nThis human readable message will be displayed in the seller's UI.\n(Max length: 1000 unicode code units.)", + "description": "The reason why the proposal is being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.)", "type": "string" } }, "type": "object" }, "PlacementTargeting": { - "description": "Represents targeting about where the ads can appear, e.g., certain sites or\nmobile applications.\nDifferent placement targeting types will be logically OR'ed.", + "description": "Represents targeting about where the ads can appear, e.g., certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", "id": "PlacementTargeting", "properties": { "mobileApplicationTargeting": { "$ref": "MobileApplicationTargeting", - "description": "Mobile application targeting information in a deal.\nThis doesn't apply to Auction Packages." + "description": "Mobile application targeting information in a deal. This doesn't apply to Auction Packages." }, "urlTargeting": { "$ref": "UrlTargeting", @@ -5112,6 +5199,11 @@ "ANDROID", "IOS" ], + "enumDescriptions": [ + "Desktop platform.", + "Android platform.", + "iOS platform." + ], "type": "string" }, "type": "array" @@ -5135,7 +5227,7 @@ "COST_PER_DAY" ], "enumDescriptions": [ - "A placeholder for an undefined pricing type. If the pricing type is\nunpsecified, `COST_PER_MILLE` will be used instead.", + "A placeholder for an undefined pricing type. If the pricing type is unpsecified, `COST_PER_MILLE` will be used instead.", "Cost per thousand impressions.", "Cost per day" ], @@ -5145,11 +5237,11 @@ "type": "object" }, "PricePerBuyer": { - "description": "Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in\na product can become 0 or 1 deals. To check if there is a PricePerBuyer for\na particular buyer or buyer/advertiser pair, we look for the most specific\nmatching rule - we first look for a rule matching the buyer and advertiser,\nnext a rule with the buyer but an empty advertiser list, and otherwise look\nfor a matching rule where no buyer is set.", + "description": "Used to specify pricing rules for buyers/advertisers. Each PricePerBuyer in a product can become 0 or 1 deals. To check if there is a PricePerBuyer for a particular buyer or buyer/advertiser pair, we look for the most specific matching rule - we first look for a rule matching the buyer and advertiser, next a rule with the buyer but an empty advertiser list, and otherwise look for a matching rule where no buyer is set.", "id": "PricePerBuyer", "properties": { "advertiserIds": { - "description": "The list of advertisers for this price when associated with this buyer.\nIf empty, all advertisers with this buyer pay this price.", + "description": "The list of advertisers for this price when associated with this buyer. If empty, all advertisers with this buyer pay this price.", "items": { "type": "string" }, @@ -5157,7 +5249,7 @@ }, "buyer": { "$ref": "Buyer", - "description": "The buyer who will pay this price. If unset, all buyers can pay this price\n(if the\nadvertisers match, and there's no more specific rule matching the buyer)." + "description": "The buyer who will pay this price. If unset, all buyers can pay this price (if the advertisers match, and there's no more specific rule matching the buyer)." }, "price": { "$ref": "Price", @@ -5171,23 +5263,23 @@ "id": "PrivateData", "properties": { "referenceId": { - "description": "A buyer or seller specified reference ID. This can be queried in the list\noperations (max-length: 1024 unicode code units).", + "description": "A buyer or seller specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).", "type": "string" } }, "type": "object" }, "Product": { - "description": "Note: this resource requires whitelisting for access. Please contact your\naccount manager for access to Marketplace resources.\n\nA product is a segment of inventory that a seller wishes to sell. It is\nassociated with certain terms and targeting information which helps the buyer\nknow more about the inventory.", + "description": "Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.", "id": "Product", "properties": { "availableEndTime": { - "description": "The proposed end time for the deal. The field will be truncated to the\norder of seconds during serving.", + "description": "The proposed end time for the deal. The field will be truncated to the order of seconds during serving.", "format": "google-datetime", "type": "string" }, "availableStartTime": { - "description": "Inventory availability dates. The start time will be truncated to seconds\nduring serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will\nbe truncated to 3:23:34 when serving.", + "description": "Inventory availability dates. The start time will be truncated to seconds during serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34 when serving.", "format": "google-datetime", "type": "string" }, @@ -5208,7 +5300,7 @@ "type": "string" }, "hasCreatorSignedOff": { - "description": "If the creator has already signed off on the product, then the buyer can\nfinalize the deal by accepting the product as is. When copying to a\nproposal, if any of the terms are changed, then auto_finalize is\nautomatically set to false.", + "description": "If the creator has already signed off on the product, then the buyer can finalize the deal by accepting the product as is. When copying to a proposal, if any of the terms are changed, then auto_finalize is automatically set to false.", "type": "boolean" }, "productId": { @@ -5221,7 +5313,7 @@ "type": "string" }, "publisherProfileId": { - "description": "An ID which can be used by the Publisher Profile API to get more\ninformation about the seller that created this product.", + "description": "An ID which can be used by the Publisher Profile API to get more information about the seller that created this product.", "type": "string" }, "seller": { @@ -5247,7 +5339,7 @@ "type": "string" }, "targetingCriterion": { - "description": "Targeting that is shared between the buyer and the seller. Each targeting\ncriterion has a specified key and for each key there is a list of inclusion\nvalue or exclusion values.", + "description": "Targeting that is shared between the buyer and the seller. Each targeting criterion has a specified key and for each key there is a list of inclusion value or exclusion values.", "items": { "$ref": "TargetingCriteria" }, @@ -5263,14 +5355,14 @@ "type": "string" }, "webPropertyCode": { - "description": "The web-property code for the seller. This needs to be copied as is when\nadding a new deal to a proposal.", + "description": "The web-property code for the seller. This needs to be copied as is when adding a new deal to a proposal.", "type": "string" } }, "type": "object" }, "Proposal": { - "description": "Note: this resource requires whitelisting for access. Please contact your\naccount manager for access to Marketplace resources.\n\nRepresents a proposal in the Marketplace. A proposal is the unit of\nnegotiation between a seller and a buyer and contains deals which\nare served.\n\nNote: you can not update, create, or otherwise modify Private\nAuction or Preferred Deals deals through the API.\n\nFields are updatable unless noted otherwise.", + "description": "Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise.", "id": "Proposal", "properties": { "billedBuyer": { @@ -5279,7 +5371,7 @@ }, "buyer": { "$ref": "Buyer", - "description": "Reference to the buyer on the proposal.\n\nNote: This field may be set only when creating the resource. Modifying\nthis field while updating the resource will result in an error." + "description": "Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error." }, "buyerContacts": { "description": "Contact information for the buyer.", @@ -5293,7 +5385,7 @@ "description": "Private data for buyer. (hidden from seller)." }, "deals": { - "description": "The deals associated with this proposal. For Private Auction proposals\n(whose deals have NonGuaranteedAuctionTerms), there will only be one deal.", + "description": "The deals associated with this proposal. For Private Auction proposals (whose deals have NonGuaranteedAuctionTerms), there will only be one deal.", "items": { "$ref": "Deal" }, @@ -5308,11 +5400,11 @@ "type": "boolean" }, "isSetupComplete": { - "description": "Output only. True, if the buyside inventory setup is complete for this\nproposal.", + "description": "Output only. True, if the buyside inventory setup is complete for this proposal.", "type": "boolean" }, "lastUpdaterOrCommentorRole": { - "description": "Output only. The role of the last user that either updated the proposal or\nleft a comment.", + "description": "Output only. The role of the last user that either updated the proposal or left a comment.", "enum": [ "BUYER_SELLER_ROLE_UNSPECIFIED", "BUYER", @@ -5347,7 +5439,7 @@ "type": "string" }, "privateAuctionId": { - "description": "Output only. Private auction ID if this proposal is a private auction\nproposal.", + "description": "Output only. Private auction ID if this proposal is a private auction proposal.", "type": "string" }, "proposalId": { @@ -5355,7 +5447,7 @@ "type": "string" }, "proposalRevision": { - "description": "Output only. The revision number for the proposal.\nEach update to the proposal or the deal causes the proposal revision number\nto auto-increment. The buyer keeps track of the last revision number they\nknow of and pass it in when making an update. If the head revision number\non the server has since incremented, then an ABORTED error is returned\nduring the update operation to let the buyer know that a subsequent update\nwas made.", + "description": "Output only. The revision number for the proposal. Each update to the proposal or the 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.", "format": "int64", "type": "string" }, @@ -5374,14 +5466,14 @@ "The proposal is under negotiation or renegotiation.", "The proposal has been accepted by the buyer.", "The proposal has been accepted by the seller.", - "The negotiations on the proposal were canceled and the proposal was never\nfinalized.", - "The proposal is finalized. During renegotiation, the proposal may\nnot be in this state." + "The negotiations on the proposal were canceled and the proposal was never finalized.", + "The proposal is finalized. During renegotiation, the proposal may not be in this state." ], "type": "string" }, "seller": { "$ref": "Seller", - "description": "Reference to the seller on the proposal.\n\nNote: This field may be set only when creating the resource. Modifying\nthis field while updating the resource will result in an error." + "description": "Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error." }, "sellerContacts": { "description": "Output only. Contact information for the seller.", @@ -5399,7 +5491,7 @@ "type": "object" }, "PublisherProfile": { - "description": "Note: this resource requires whitelisting for access. Please contact your\naccount manager for access to Marketplace resources.\n\nRepresents a publisher profile\n(https://support.google.com/admanager/answer/6035806?hl=en) in Marketplace.\n\nAll fields are read only. All string fields are free-form text entered by the\npublisher unless noted otherwise.", + "description": "Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile (https://support.google.com/admanager/answer/6035806?hl=en) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.", "id": "PublisherProfile", "properties": { "audienceDescription": { @@ -5407,11 +5499,11 @@ "type": "string" }, "buyerPitchStatement": { - "description": "Statement explaining what's unique about publisher's business, and why\nbuyers should partner with the publisher.", + "description": "Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.", "type": "string" }, "directDealsContact": { - "description": "Contact information for direct reservation deals. This is free text entered\nby the publisher and may include information like names, phone numbers and\nemail addresses.", + "description": "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.", "type": "string" }, "displayName": { @@ -5419,7 +5511,7 @@ "type": "string" }, "domains": { - "description": "The list of domains represented in this publisher profile. Empty if this is\na parent profile. These are top private domains, meaning that these will\nnot contain a string like \"photos.google.co.uk/123\", but will instead\ncontain \"google.co.uk\".", + "description": "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\".", "items": { "type": "string" }, @@ -5430,11 +5522,11 @@ "type": "string" }, "isParent": { - "description": "Indicates if this profile is the parent profile of the seller. A parent\nprofile represents all the inventory from the seller, as opposed to child\nprofile that is created to brand a portion of inventory. One seller should\nhave only one parent publisher profile, and can have multiple child\nprofiles. Publisher profiles for the same seller will have same value of\nfield google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller.\nSee https://support.google.com/admanager/answer/6035806?hl=en for details.", + "description": "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 should have only one parent publisher profile, and can have multiple child profiles. Publisher profiles for the same seller will have same value of field google.ads.adexchange.buyer.v2beta1.PublisherProfile.seller. See https://support.google.com/admanager/answer/6035806?hl=en for details.", "type": "boolean" }, "logoUrl": { - "description": "A Google public URL to the logo for this publisher profile. The logo is\nstored as a PNG, JPG, or GIF image.", + "description": "A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.", "type": "string" }, "mediaKitUrl": { @@ -5446,7 +5538,7 @@ "type": "string" }, "programmaticDealsContact": { - "description": "Contact information for programmatic deals. This is free text entered by\nthe publisher and may include information like names, phone numbers and\nemail addresses.", + "description": "Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.", "type": "string" }, "publisherProfileId": { @@ -5466,7 +5558,7 @@ "description": "Seller of the publisher profile." }, "topHeadlines": { - "description": "Up to three key metrics and rankings. Max 100 characters each.\nFor example \"#1 Mobile News Site for 20 Straight Months\".", + "description": "Up to three key metrics and rankings. Max 100 characters each. For example \"#1 Mobile News Site for 20 Straight Months\".", "items": { "type": "string" }, @@ -5476,7 +5568,7 @@ "type": "object" }, "RealtimeTimeRange": { - "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.", + "description": "An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set.", "id": "RealtimeTimeRange", "properties": { "startTimestamp": { @@ -5488,16 +5580,16 @@ "type": "object" }, "RelativeDateRange": { - "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today,\ni.e., the limits for these values are:\noffset_days >= 0\nduration_days >= 1\noffset_days + duration_days <= 30", + "description": "A relative date range, specified by an offset and a duration. The supported range of dates begins 30 days before today and ends today, i.e., the limits for these values are: offset_days >= 0 duration_days >= 1 offset_days + duration_days <= 30", "id": "RelativeDateRange", "properties": { "durationDays": { - "description": "The number of days in the requested date range, e.g., for a range spanning\ntoday: 1. For a range spanning the last 7 days: 7.", + "description": "The number of days in the requested date range, e.g., for a range spanning today: 1. For a range spanning the last 7 days: 7.", "format": "int32", "type": "integer" }, "offsetDays": { - "description": "The end date of the filter set, specified as the number of days before\ntoday, e.g., for a range where the last date is today: 0.", + "description": "The end date of the filter set, specified as the number of days before today, e.g., for a range where the last date is today: 0.", "format": "int32", "type": "integer" } @@ -5516,17 +5608,17 @@ "type": "object" }, "ResumeProposalRequest": { - "description": "Request message to resume (unpause) serving for an already-finalized\nproposal.", + "description": "Request message to resume (unpause) serving for an already-finalized proposal.", "id": "ResumeProposalRequest", "properties": {}, "type": "object" }, "RowDimensions": { - "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.", + "description": "A response may include multiple rows, breaking down along various dimensions. Encapsulates the values of all dimensions for a given row.", "id": "RowDimensions", "properties": { "publisherIdentifier": { - "description": "The publisher identifier for this row, if a breakdown by\n[BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension)\nwas requested.", + "description": "The publisher identifier for this row, if a breakdown by [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) was requested.", "type": "string" }, "timeInterval": { @@ -5551,6 +5643,10 @@ "INSECURE", "SSL" ], + "enumDescriptions": [ + "Matches impressions that require insecure compatibility.", + "Matches impressions that require SSL compatibility." + ], "type": "string" }, "type": "array" @@ -5559,11 +5655,11 @@ "type": "object" }, "Seller": { - "description": "Represents a seller of inventory. Each seller is identified by a unique\nAd Manager account ID.", + "description": "Represents a seller of inventory. Each seller is identified by a unique Ad Manager account ID.", "id": "Seller", "properties": { "accountId": { - "description": "The unique ID for the seller. The seller fills in this field.\nThe seller account ID is then available to buyer in the product.", + "description": "The unique ID for the seller. The seller fills in this field. The seller account ID is then available to buyer in the product.", "type": "string" }, "subAccountId": { @@ -5597,7 +5693,7 @@ }, "location": { "$ref": "LocationContext", - "description": "Matches impressions coming from users *or* publishers in a specific\nlocation." + "description": "Matches impressions coming from users *or* publishers in a specific location." }, "platform": { "$ref": "PlatformContext", @@ -5611,7 +5707,7 @@ "type": "object" }, "ServingRestriction": { - "description": "Output only. A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).", + "description": "Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction).", "id": "ServingRestriction", "properties": { "contexts": { @@ -5623,17 +5719,17 @@ }, "disapproval": { "$ref": "Disapproval", - "description": "Disapproval bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod." + "description": "Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method." }, "disapprovalReasons": { - "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.\nDeprecated; please use\ndisapproval\nfield instead.", + "description": "Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead.", "items": { "$ref": "Disapproval" }, "type": "array" }, "status": { - "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).", + "description": "The status of the creative in this context (for example, it has been explicitly disapproved or is pending review).", "enum": [ "STATUS_UNSPECIFIED", "DISAPPROVAL", @@ -5650,7 +5746,7 @@ "type": "object" }, "Size": { - "description": "Message depicting the size of the creative. The units of width and\nheight depend on the type of the targeting.", + "description": "Message depicting the size of the creative. The units of width and height depend on the type of the targeting.", "id": "Size", "properties": { "height": { @@ -5673,25 +5769,25 @@ "type": "object" }, "TargetingCriteria": { - "description": "Advertisers can target different attributes of an ad slot. For example,\nthey can choose to show ads only if the user is in the U.S. Such\ntargeting criteria can be specified as part of Shared Targeting.", + "description": "Advertisers can target different attributes of an ad slot. For example, they can choose to show ads only if the user is in the U.S. Such targeting criteria can be specified as part of Shared Targeting.", "id": "TargetingCriteria", "properties": { "exclusions": { - "description": "The list of values to exclude from targeting. Each value is AND'd\ntogether.", + "description": "The list of values to exclude from targeting. Each value is AND'd together.", "items": { "$ref": "TargetingValue" }, "type": "array" }, "inclusions": { - "description": "The list of value to include as part of the targeting. Each value is OR'd\ntogether.", + "description": "The list of value to include as part of the targeting. Each value is OR'd together.", "items": { "$ref": "TargetingValue" }, "type": "array" }, "key": { - "description": "The key representing the shared targeting criterion.\nTargeting criteria defined by Google ad servers will begin with GOOG_.\nThird parties may define their own keys.\nA list of permissible keys along with the acceptable values will be\nprovided as part of the external documentation.", + "description": "The key representing the shared targeting criterion. Targeting criteria defined by Google ad servers will begin with GOOG_. Third parties may define their own keys. A list of permissible keys along with the acceptable values will be provided as part of the external documentation.", "type": "string" } }, @@ -5703,11 +5799,11 @@ "properties": { "creativeSizeValue": { "$ref": "CreativeSize", - "description": "The creative size value to include/exclude.\nFilled in when key = GOOG_CREATIVE_SIZE" + "description": "The creative size value to include/exclude. Filled in when key = GOOG_CREATIVE_SIZE" }, "dayPartTargetingValue": { "$ref": "DayPartTargeting", - "description": "The daypart targeting to include / exclude.\nFilled in when the key is GOOG_DAYPART_TARGETING.\nThe definition of this targeting is derived from the structure\nused by Ad Manager." + "description": "The daypart targeting to include / exclude. Filled in when the key is GOOG_DAYPART_TARGETING. The definition of this targeting is derived from the structure used by Ad Manager." }, "longValue": { "description": "The long value to include/exclude.", @@ -5745,12 +5841,12 @@ "id": "TimeInterval", "properties": { "endTime": { - "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.", + "description": "The timestamp marking the end of the range (exclusive) for which data is included.", "format": "google-datetime", "type": "string" }, "startTime": { - "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.", + "description": "The timestamp marking the start of the range (inclusive) for which data is included.", "format": "google-datetime", "type": "string" } @@ -5758,11 +5854,11 @@ "type": "object" }, "TimeOfDay": { - "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.", + "description": "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`.", "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "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.", "format": "int32", "type": "integer" }, @@ -5777,7 +5873,7 @@ "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", + "description": "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.", "format": "int32", "type": "integer" } @@ -5785,7 +5881,7 @@ "type": "object" }, "UrlTargeting": { - "description": "Represents a list of targeted and excluded URLs (e.g., google.com).\nFor Private Auction and AdX Preferred Deals, URLs are either included or\nexcluded.\nFor Programmatic Guaranteed and Preferred Deals, this doesn't\napply.", + "description": "Represents a list of targeted and excluded URLs (e.g., google.com). For Private Auction and AdX Preferred Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.", "id": "UrlTargeting", "properties": { "excludedUrls": { @@ -5814,7 +5910,7 @@ "type": "string" }, "videoVastXml": { - "description": "The contents of a VAST document for a video ad.\nThis document should conform to the VAST 2.0 or 3.0 standard.", + "description": "The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.", "type": "string" } }, @@ -5825,7 +5921,7 @@ "id": "VideoTargeting", "properties": { "excludedPositionTypes": { - "description": "A list of video positions to be excluded.\nPosition types can either be included or excluded (XOR).", + "description": "A list of video positions to be excluded. Position types can either be included or excluded (XOR).", "enumDescriptions": [ "A placeholder for an undefined video position.", "Ad is played before the video.", @@ -5839,12 +5935,18 @@ "MIDROLL", "POSTROLL" ], + "enumDescriptions": [ + "A placeholder for an undefined video position.", + "Ad is played before the video.", + "Ad is played during the video.", + "Ad is played after the video." + ], "type": "string" }, "type": "array" }, "targetedPositionTypes": { - "description": "A list of video positions to be included.\nWhen the included list is present, the excluded list must be empty.\nWhen the excluded list is present, the included list must be empty.", + "description": "A list of video positions to be included. When the included list is present, the excluded list must be empty. When the excluded list is present, the included list must be empty.", "enumDescriptions": [ "A placeholder for an undefined video position.", "Ad is played before the video.", @@ -5858,6 +5960,12 @@ "MIDROLL", "POSTROLL" ], + "enumDescriptions": [ + "A placeholder for an undefined video position.", + "Ad is played before the video.", + "Ad is played during the video.", + "Ad is played after the video." + ], "type": "string" }, "type": "array" @@ -5870,7 +5978,7 @@ "id": "WatchCreativeRequest", "properties": { "topic": { - "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.", + "description": "The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to ad-exchange-buyside-reports@google.com to write to the topic. This should be the full resource name in \"projects/{project_id}/topics/{topic_id}\" format.", "type": "string" } }, diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index d921ce078b..f907bfe8a6 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -191,11 +191,11 @@ export namespace adexchangebuyer2_v2beta1 { */ 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. + * 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. + * 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; } @@ -302,7 +302,7 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$CancelNegotiationRequest {} /** - * A client resource represents a client buyer&mdash;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. + * 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 { /** @@ -314,7 +314,7 @@ export namespace adexchangebuyer2_v2beta1 { */ 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. + * 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; /** @@ -326,7 +326,7 @@ export namespace adexchangebuyer2_v2beta1 { */ 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. + * 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; /** @@ -343,7 +343,7 @@ export namespace adexchangebuyer2_v2beta1 { 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 via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. + * 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 via accepting an email invitation (see the accounts.clients.invitations.create method). All fields are required unless otherwise specified. */ export interface Schema$ClientUser { /** @@ -627,7 +627,7 @@ export namespace adexchangebuyer2_v2beta1 { targetedCriteriaIds?: string[] | null; } /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. */ export interface Schema$Date { /** @@ -690,11 +690,11 @@ export namespace adexchangebuyer2_v2beta1 { */ 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. + * 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 sinced 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. + * Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced 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; /** @@ -758,7 +758,7 @@ export namespace adexchangebuyer2_v2beta1 { */ 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. + * 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; /** @@ -880,7 +880,7 @@ export namespace adexchangebuyer2_v2beta1 { 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); } The JSON representation for `Empty` is empty JSON object `{}`. + * 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 `{}`. */ export interface Schema$Empty {} /** @@ -950,7 +950,7 @@ export namespace adexchangebuyer2_v2beta1 { */ 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. + * 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; /** @@ -1390,7 +1390,7 @@ export namespace adexchangebuyer2_v2beta1 { */ value?: string | null; /** - * The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value + * The variance (i.e. square of the standard deviation) of the metric value. If value is exact, variance is 0. Can be used to calculate margin of error as a percentage of value, using the following formula, where Z is the standard constant that depends on the desired size of the confidence interval (e.g. for 90% confidence interval, use Z = 1.645): marginOfError = 100 * Z * sqrt(variance) / value */ variance?: string | null; } @@ -1529,7 +1529,7 @@ export namespace adexchangebuyer2_v2beta1 { */ creatorRole?: string | null; /** - * The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. + * The actual note to attach. (max-length: 1024 unicode code units) Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ note?: string | null; /** @@ -1625,7 +1625,7 @@ export namespace adexchangebuyer2_v2beta1 { referenceId?: string | null; } /** - * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory. + * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory. */ export interface Schema$Product { /** @@ -1690,7 +1690,7 @@ export namespace adexchangebuyer2_v2beta1 { webPropertyCode?: string | null; } /** - * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. + * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise. */ export interface Schema$Proposal { /** @@ -1698,7 +1698,7 @@ export namespace adexchangebuyer2_v2beta1 { */ billedBuyer?: Schema$Buyer; /** - * Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. + * Reference to the buyer on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ buyer?: Schema$Buyer; /** @@ -1754,7 +1754,7 @@ export namespace adexchangebuyer2_v2beta1 { */ proposalState?: string | null; /** - * Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. + * Reference to the seller on the proposal. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. */ seller?: Schema$Seller; /** @@ -1767,7 +1767,7 @@ export namespace adexchangebuyer2_v2beta1 { updateTime?: string | null; } /** - * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile (https://support.google.com/admanager/answer/6035806?hl=en) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise. + * Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile (https://support.google.com/admanager/answer/6035806?hl=en) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise. */ export interface Schema$PublisherProfile { /** @@ -2172,8 +2172,7 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.accounts.clients.create({ - * // Unique numerical account ID for the buyer of which the client buyer - * // is a customer; the sponsor buyer to create a client for. (required) + * // Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required) * accountId: 'placeholder-value', * * // Request body metadata @@ -2475,19 +2474,11 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.clients.list({ * // Unique numerical account ID of the sponsor buyer to list the clients for. * accountId: 'placeholder-value', - * // Requested page size. The server may return fewer clients than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // 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 - * // accounts.clients.list - * // method. + * // 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 accounts.clients.list method. * pageToken: 'placeholder-value', - * // Optional unique identifier (from the standpoint of an Ad Exchange sponsor - * // buyer partner) of the client to return. - * // If specified, at most one client will be returned in the response. + * // Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response. * partnerClientId: 'placeholder-value', * }); * console.log(res.data); @@ -2626,8 +2617,7 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.accounts.clients.update({ - * // Unique numerical account ID for the buyer of which the client buyer - * // is a customer; the sponsor buyer to update a client for. (required) + * // Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required) * accountId: 'placeholder-value', * // Unique numerical account ID of the client to update. (required) * clientAccountId: 'placeholder-value', @@ -2855,8 +2845,7 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.clients.invitations.create({ * // Numerical account ID of the client's sponsor buyer. (required) * accountId: 'placeholder-value', - * // Numerical account ID of the client buyer that the user - * // should be associated with. (required) + * // Numerical account ID of the client buyer that the user should be associated with. (required) * clientAccountId: 'placeholder-value', * * // Request body metadata @@ -3009,8 +2998,7 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.clients.invitations.get({ * // Numerical account ID of the client's sponsor buyer. (required) * accountId: 'placeholder-value', - * // Numerical account ID of the client buyer that the user invitation - * // to be retrieved is associated with. (required) + * // Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required) * clientAccountId: 'placeholder-value', * // Numerical identifier of the user invitation to retrieve. (required) * invitationId: 'placeholder-value', @@ -3155,22 +3143,11 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.clients.invitations.list({ * // Numerical account ID of the client's sponsor buyer. (required) * accountId: 'placeholder-value', - * // Numerical account ID of the client buyer to list invitations for. - * // (required) - * // You must either specify a string representation of a - * // numerical account identifier or the `-` character - * // to list all the invitations for all the clients - * // of a given sponsor buyer. + * // Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer. * clientAccountId: 'placeholder-value', - * // Requested page size. Server may return fewer clients than requested. - * // If unspecified, server will pick an appropriate default. + * // Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListClientUserInvitationsResponse.nextPageToken - * // returned from the previous call to the - * // clients.invitations.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -3375,8 +3352,7 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.clients.users.get({ * // Numerical account ID of the client's sponsor buyer. (required) * accountId: 'placeholder-value', - * // Numerical account ID of the client buyer - * // that the user to be retrieved is associated with. (required) + * // Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) * clientAccountId: 'placeholder-value', * // Numerical identifier of the user to retrieve. (required) * userId: 'placeholder-value', @@ -3515,24 +3491,13 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.accounts.clients.users.list({ - * // Numerical account ID of the sponsor buyer of the client to list users for. - * // (required) + * // Numerical account ID of the sponsor buyer of the client to list users for. (required) * accountId: 'placeholder-value', - * // The account ID of the client buyer to list users for. (required) - * // You must specify either a string representation of a - * // numerical account identifier or the `-` character - * // to list all the client users for all the clients - * // of a given sponsor buyer. + * // The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer. * clientAccountId: 'placeholder-value', - * // Requested page size. The server may return fewer clients than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // 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 - * // accounts.clients.users.list - * // method. + * // 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 accounts.clients.users.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -3675,8 +3640,7 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.clients.users.update({ * // Numerical account ID of the client's sponsor buyer. (required) * accountId: 'placeholder-value', - * // Numerical account ID of the client buyer that the user to be retrieved - * // is associated with. (required) + * // Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) * clientAccountId: 'placeholder-value', * // Numerical identifier of the user to retrieve. (required) * userId: 'placeholder-value', @@ -3893,13 +3857,9 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.accounts.creatives.create({ - * // The account that this creative belongs to. - * // Can be used to filter the response of the - * // creatives.list - * // method. + * // The account that this creative belongs to. Can be used to filter the response of the creatives.list method. * accountId: 'placeholder-value', - * // Indicates if multiple creatives can share an ID or not. Default is - * // NO_DUPLICATES (one ID per creative). + * // Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative). * duplicateIdMode: 'placeholder-value', * * // Request body metadata @@ -4250,35 +4210,13 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.accounts.creatives.list({ - * // The account to list the creatives from. - * // Specify "-" to list all creatives the current user has access to. + * // The account to list the creatives from. Specify "-" to list all creatives the current user has access to. * accountId: 'placeholder-value', - * // Requested page size. The server may return fewer creatives than requested - * // (due to timeout constraint) even if more are available via another call. - * // If unspecified, server will pick an appropriate default. - * // Acceptable values are 1 to 1000, inclusive. + * // Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListCreativesResponse.next_page_token - * // returned from the previous call to 'ListCreatives' method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method. * pageToken: 'placeholder-value', - * // An optional query string to filter creatives. If no filter is specified, - * // all active creatives will be returned. - * //

Supported queries are: - * //

- * // Example: 'accountId=12345 AND (dealsStatus:disapproved AND - * // disapprovalReason:unacceptable_content) OR attribute:47' + * // An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' * query: 'placeholder-value', * }); * console.log(res.data); @@ -4302,7 +4240,7 @@ export namespace adexchangebuyer2_v2beta1 { * @param {string} params.accountId The account to list the creatives from. Specify "-" to list all creatives the current user has access to. * @param {integer=} params.pageSize Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method. - * @param {string=} params.query An optional query string to filter creatives. If no filter is specified, all active creatives will be returned.

Supported queries are:

Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' + * @param {string=} params.query An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4421,8 +4359,7 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.creatives.stopWatching({ * // The account of the creative to stop notifications for. * accountId: 'placeholder-value', - * // The creative ID of the creative to stop notifications for. - * // Specify "-" to specify stopping account level notifications. + * // The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications. * creativeId: 'placeholder-value', * * // Request body metadata @@ -4560,15 +4497,9 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.accounts.creatives.update({ - * // The account that this creative belongs to. - * // Can be used to filter the response of the - * // creatives.list - * // method. + * // The account that this creative belongs to. Can be used to filter the response of the creatives.list method. * accountId: 'placeholder-value', - * // The buyer-defined creative ID of this creative. - * // Can be used to filter the response of the - * // creatives.list - * // method. + * // The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. * creativeId: 'placeholder-value', * * // Request body metadata @@ -4761,11 +4692,7 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.creatives.watch({ * // The account of the creative to watch. * accountId: 'placeholder-value', - * // The creative ID to watch for status changes. - * // Specify "-" to watch all creatives under the above account. - * // If both creative-level and account-level notifications are - * // sent, only a single notification will be sent to the - * // creative-level notification topic. + * // The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic. * creativeId: 'placeholder-value', * * // Request body metadata @@ -4921,7 +4848,7 @@ export namespace adexchangebuyer2_v2beta1 { */ pageToken?: string; /** - * An optional query string to filter creatives. If no filter is specified, all active creatives will be returned.

Supported queries are:

Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' + * An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' */ query?: string; } @@ -5149,33 +5076,15 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.accounts.creatives.dealAssociations.list({ - * // The account to list the associations from. - * // Specify "-" to list all creatives the current user has access to. + * // The account to list the associations from. Specify "-" to list all creatives the current user has access to. * accountId: 'placeholder-value', - * // The creative ID to list the associations from. - * // Specify "-" to list all creatives under the above account. + * // The creative ID to list the associations from. Specify "-" to list all creatives under the above account. * creativeId: 'placeholder-value', - * // Requested page size. Server may return fewer associations than requested. - * // If unspecified, server will pick an appropriate default. + * // Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListDealAssociationsResponse.next_page_token - * // returned from the previous call to 'ListDealAssociations' method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method. * pageToken: 'placeholder-value', - * // An optional query string to filter deal associations. If no filter is - * // specified, all associations will be returned. - * // Supported queries are: - * // - * // Example: 'dealsId=12345 AND dealsStatus:disapproved' + * // An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved' * query: 'placeholder-value', * }); * console.log(res.data); @@ -5200,7 +5109,7 @@ export namespace adexchangebuyer2_v2beta1 { * @param {string} params.creativeId The creative ID to list the associations from. Specify "-" to list all creatives under the above account. * @param {integer=} params.pageSize Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method. - * @param {string=} params.query An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: Example: 'dealsId=12345 AND dealsStatus:disapproved' + * @param {string=} params.query An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved' * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5474,7 +5383,7 @@ export namespace adexchangebuyer2_v2beta1 { */ pageToken?: string; /** - * An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: Example: 'dealsId=12345 AND dealsStatus:disapproved' + * An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved' */ query?: string; } @@ -5530,16 +5439,11 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.finalizedProposals.list({ * // Account ID of the buyer. * accountId: 'placeholder-value', - * // An optional PQL filter query used to query for proposals. - * // - * // Nested repeated fields, such as proposal.deals.targetingCriterion, - * // cannot be filtered. + * // An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. * filter: 'placeholder-value', - * // Syntax the filter is written in. Current implementation defaults to PQL - * // but in the future it will be LIST_FILTER. + * // Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. * filterSyntax: 'placeholder-value', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', * // The page token as returned from ListProposalsResponse. * pageToken: 'placeholder-value', @@ -5563,7 +5467,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID of the buyer. - * @param {string=} params.filter An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. + * @param {string=} params.filter An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. * @param {string=} params.filterSyntax Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken The page token as returned from ListProposalsResponse. @@ -5663,7 +5567,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. + * An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. */ filter?: string; /** @@ -5863,15 +5767,9 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.products.list({ * // Account ID of the buyer. * accountId: 'placeholder-value', - * // An optional PQL query used to query for products. See - * // https://developers.google.com/ad-manager/docs/pqlreference - * // for documentation about PQL and examples. - * // - * // Nested repeated fields, such as product.targetingCriterion.inclusions, - * // cannot be filtered. + * // An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered. * filter: 'placeholder-value', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', * // The page token as returned from ListProductsResponse. * pageToken: 'placeholder-value', @@ -5895,7 +5793,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID of the buyer. - * @param {string=} params.filter An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered. + * @param {string=} params.filter An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered. * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken The page token as returned from ListProductsResponse. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6006,7 +5904,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered. + * An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered. */ filter?: string; /** @@ -7007,16 +6905,11 @@ export namespace adexchangebuyer2_v2beta1 { * const res = await adexchangebuyer2.accounts.proposals.list({ * // Account ID of the buyer. * accountId: 'placeholder-value', - * // An optional PQL filter query used to query for proposals. - * // - * // Nested repeated fields, such as proposal.deals.targetingCriterion, - * // cannot be filtered. + * // An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. * filter: 'placeholder-value', - * // Syntax the filter is written in. Current implementation defaults to PQL - * // but in the future it will be LIST_FILTER. + * // Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. * filterSyntax: 'placeholder-value', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', * // The page token as returned from ListProposalsResponse. * pageToken: 'placeholder-value', @@ -7040,7 +6933,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {string} params.accountId Account ID of the buyer. - * @param {string=} params.filter An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. + * @param {string=} params.filter An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. * @param {string=} params.filterSyntax Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken The page token as returned from ListProposalsResponse. @@ -7135,7 +7028,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.pause - * @desc Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating. + * @desc Update the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating. * @example * // Before running the sample: * // - Enable the API at: @@ -7296,7 +7189,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.resume - * @desc Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating. + * @desc Update the given proposal to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all deals in the proposal. Note that if the `has_seller_paused` bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating. * @example * // Before running the sample: * // - Enable the API at: @@ -7455,7 +7348,7 @@ export namespace adexchangebuyer2_v2beta1 { /** * adexchangebuyer2.accounts.proposals.update - * @desc Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head. + * @desc Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in `proposal.proposal_revision`, an `ABORTED` error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a `deal_id`, the server will assign a new unique ID and create the deal. If passed-in deal has a `deal_id`, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a `deal_id` not present at head. * @example * // Before running the sample: * // - Enable the API at: @@ -7725,7 +7618,7 @@ export namespace adexchangebuyer2_v2beta1 { */ accountId?: string; /** - * An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. + * An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. */ filter?: string; /** @@ -8206,20 +8099,9 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.create({ - * // Whether the filter set is transient, or should be persisted indefinitely. - * // By default, filter sets are not transient. - * // If transient, it will be available for at least 1 hour after creation. + * // Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. * isTransient: 'placeholder-value', - * // Name of the owner (bidder or account) of the filter set to be created. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: `bidders/123` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456` + * // Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` * ownerName: 'bidders/my-bidder/accounts/my-account', * * // Request body metadata @@ -8274,7 +8156,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {boolean=} params.isTransient Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. - * @param {string} params.ownerName Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * @param {string} params.ownerName Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` * @param {().FilterSet} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -8387,17 +8269,7 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.delete({ - * // Full name of the resource to delete. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * name: 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', * }); * console.log(res.data); @@ -8415,7 +8287,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.name Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8524,17 +8396,7 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.get({ - * // Full name of the resource being requested. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * name: 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', * }); * console.log(res.data); @@ -8567,7 +8429,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.name Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -8676,26 +8538,11 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.list({ - * // Name of the owner (bidder or account) of the filter sets to be listed. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: `bidders/123` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456` + * // Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` * ownerName: 'bidders/my-bidder/accounts/my-account', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListFilterSetsResponse.nextPageToken - * // returned from the previous call to the - * // accounts.filterSets.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -8716,7 +8563,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.ownerName Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * @param {string} params.ownerName Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8816,7 +8663,7 @@ export namespace adexchangebuyer2_v2beta1 { */ isTransient?: boolean; /** - * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` */ ownerName?: string; @@ -8828,21 +8675,21 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Delete extends StandardParameters { /** - * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ name?: string; } export interface Params$Resource$Bidders$Accounts$Filtersets$Get extends StandardParameters { /** - * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ name?: string; } export interface Params$Resource$Bidders$Accounts$Filtersets$List extends StandardParameters { /** - * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` */ ownerName?: string; /** @@ -8889,27 +8736,12 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListBidMetricsResponse.nextPageToken - * // returned from the previous call to the bidMetrics.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. * pageToken: 'placeholder-value', * } * ); @@ -8931,7 +8763,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9027,7 +8859,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Bidmetrics$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -9074,27 +8906,12 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListBidResponseErrorsResponse.nextPageToken - * // returned from the previous call to the bidResponseErrors.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. * pageToken: 'placeholder-value', * } * ); @@ -9116,7 +8933,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9215,7 +9032,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Bidresponseerrors$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -9262,27 +9079,12 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListBidResponsesWithoutBidsResponse.nextPageToken - * // returned from the previous call to the bidResponsesWithoutBids.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. * pageToken: 'placeholder-value', * } * ); @@ -9304,7 +9106,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9403,7 +9205,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Bidresponseswithoutbids$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -9450,27 +9252,12 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListFilteredBidRequestsResponse.nextPageToken - * // returned from the previous call to the filteredBidRequests.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method. * pageToken: 'placeholder-value', * } * ); @@ -9492,7 +9279,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9591,7 +9378,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbidrequests$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -9646,27 +9433,12 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListFilteredBidsResponse.nextPageToken - * // returned from the previous call to the filteredBids.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method. * pageToken: 'placeholder-value', * } * ); @@ -9688,7 +9460,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9784,7 +9556,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Filteredbids$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -9831,32 +9603,14 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list( * { - * // The ID of the creative status for which to retrieve a breakdown by - * // creative. - * // See - * // [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). + * // The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). * creativeStatusId: 'placeholder-value', - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListCreativeStatusBreakdownByCreativeResponse.nextPageToken - * // returned from the previous call to the filteredBids.creatives.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method. * pageToken: 'placeholder-value', * } * ); @@ -9879,7 +9633,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9997,7 +9751,7 @@ export namespace adexchangebuyer2_v2beta1 { */ creativeStatusId?: number; /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -10044,32 +9798,14 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list( * { - * // The ID of the creative status for which to retrieve a breakdown by detail. - * // See - * // [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). - * // Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. + * // The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. * creativeStatusId: 'placeholder-value', - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListCreativeStatusBreakdownByDetailResponse.nextPageToken - * // returned from the previous call to the filteredBids.details.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method. * pageToken: 'placeholder-value', * } * ); @@ -10093,7 +9829,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10211,7 +9947,7 @@ export namespace adexchangebuyer2_v2beta1 { */ creativeStatusId?: number; /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -10258,27 +9994,12 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListImpressionMetricsResponse.nextPageToken - * // returned from the previous call to the impressionMetrics.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method. * pageToken: 'placeholder-value', * } * ); @@ -10300,7 +10021,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10399,7 +10120,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Impressionmetrics$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -10446,27 +10167,12 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.losingBids.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListLosingBidsResponse.nextPageToken - * // returned from the previous call to the losingBids.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method. * pageToken: 'placeholder-value', * } * ); @@ -10488,7 +10194,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10584,7 +10290,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Losingbids$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -10631,27 +10337,12 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: * 'bidders/my-bidder/accounts/my-account/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListNonBillableWinningBidsResponse.nextPageToken - * // returned from the previous call to the nonBillableWinningBids.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method. * pageToken: 'placeholder-value', * } * ); @@ -10673,7 +10364,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10772,7 +10463,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Accounts$Filtersets$Nonbillablewinningbids$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -10850,20 +10541,9 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.create({ - * // Whether the filter set is transient, or should be persisted indefinitely. - * // By default, filter sets are not transient. - * // If transient, it will be available for at least 1 hour after creation. + * // Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. * isTransient: 'placeholder-value', - * // Name of the owner (bidder or account) of the filter set to be created. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: `bidders/123` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456` + * // Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` * ownerName: 'bidders/my-bidder', * * // Request body metadata @@ -10918,7 +10598,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {boolean=} params.isTransient Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation. - * @param {string} params.ownerName Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * @param {string} params.ownerName Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` * @param {().FilterSet} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -11031,17 +10711,7 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.delete({ - * // Full name of the resource to delete. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * name: 'bidders/my-bidder/filterSets/my-filterSet', * }); * console.log(res.data); @@ -11059,7 +10729,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.name Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11168,17 +10838,7 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.get({ - * // Full name of the resource being requested. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * name: 'bidders/my-bidder/filterSets/my-filterSet', * }); * console.log(res.data); @@ -11211,7 +10871,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.name Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -11320,26 +10980,11 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.list({ - * // Name of the owner (bidder or account) of the filter sets to be listed. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: `bidders/123` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456` + * // Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` * ownerName: 'bidders/my-bidder', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListFilterSetsResponse.nextPageToken - * // returned from the previous call to the - * // accounts.filterSets.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -11360,7 +11005,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.ownerName Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * @param {string} params.ownerName Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11460,7 +11105,7 @@ export namespace adexchangebuyer2_v2beta1 { */ isTransient?: boolean; /** - * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` */ ownerName?: string; @@ -11472,21 +11117,21 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Delete extends StandardParameters { /** - * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ name?: string; } export interface Params$Resource$Bidders$Filtersets$Get extends StandardParameters { /** - * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ name?: string; } export interface Params$Resource$Bidders$Filtersets$List extends StandardParameters { /** - * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` + * Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456` */ ownerName?: string; /** @@ -11532,26 +11177,11 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.bidMetrics.list({ - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListBidMetricsResponse.nextPageToken - * // returned from the previous call to the bidMetrics.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -11572,7 +11202,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11668,7 +11298,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Bidmetrics$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -11714,26 +11344,11 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.bidResponseErrors.list({ - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListBidResponseErrorsResponse.nextPageToken - * // returned from the previous call to the bidResponseErrors.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -11754,7 +11369,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11853,7 +11468,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Bidresponseerrors$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -11900,26 +11515,11 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListBidResponsesWithoutBidsResponse.nextPageToken - * // returned from the previous call to the bidResponsesWithoutBids.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. * pageToken: 'placeholder-value', * } * ); @@ -11941,7 +11541,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12040,7 +11640,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Bidresponseswithoutbids$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -12087,26 +11687,11 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.filteredBidRequests.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListFilteredBidRequestsResponse.nextPageToken - * // returned from the previous call to the filteredBidRequests.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method. * pageToken: 'placeholder-value', * } * ); @@ -12128,7 +11713,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12227,7 +11812,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Filteredbidrequests$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -12281,26 +11866,11 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.filteredBids.list({ - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListFilteredBidsResponse.nextPageToken - * // returned from the previous call to the filteredBids.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -12321,7 +11891,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12417,7 +11987,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Filteredbids$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -12464,31 +12034,13 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list( * { - * // The ID of the creative status for which to retrieve a breakdown by - * // creative. - * // See - * // [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). + * // The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). * creativeStatusId: 'placeholder-value', - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListCreativeStatusBreakdownByCreativeResponse.nextPageToken - * // returned from the previous call to the filteredBids.creatives.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method. * pageToken: 'placeholder-value', * } * ); @@ -12511,7 +12063,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12629,7 +12181,7 @@ export namespace adexchangebuyer2_v2beta1 { */ creativeStatusId?: number; /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -12676,31 +12228,13 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.filteredBids.details.list( * { - * // The ID of the creative status for which to retrieve a breakdown by detail. - * // See - * // [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). - * // Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. + * // The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. * creativeStatusId: 'placeholder-value', - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListCreativeStatusBreakdownByDetailResponse.nextPageToken - * // returned from the previous call to the filteredBids.details.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method. * pageToken: 'placeholder-value', * } * ); @@ -12724,7 +12258,7 @@ export namespace adexchangebuyer2_v2beta1 { * * @param {object} params Parameters for request * @param {integer} params.creativeStatusId The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12842,7 +12376,7 @@ export namespace adexchangebuyer2_v2beta1 { */ creativeStatusId?: number; /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -12888,26 +12422,11 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.impressionMetrics.list({ - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListImpressionMetricsResponse.nextPageToken - * // returned from the previous call to the impressionMetrics.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -12928,7 +12447,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13027,7 +12546,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Impressionmetrics$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -13073,26 +12592,11 @@ export namespace adexchangebuyer2_v2beta1 { * * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.losingBids.list({ - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListLosingBidsResponse.nextPageToken - * // returned from the previous call to the losingBids.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method. * pageToken: 'placeholder-value', * }); * console.log(res.data); @@ -13113,7 +12617,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13209,7 +12713,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Losingbids$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /** @@ -13256,26 +12760,11 @@ export namespace adexchangebuyer2_v2beta1 { * // Do the magic * const res = await adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list( * { - * // Name of the filter set that should be applied to the requested metrics. - * // For example: - * // - * // - For a bidder-level filter set for bidder 123: - * // `bidders/123/filterSets/abc` - * // - * // - For an account-level filter set for the buyer account representing bidder - * // 123: `bidders/123/accounts/123/filterSets/abc` - * // - * // - For an account-level filter set for the child seat buyer account 456 - * // whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * // Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * filterSetName: 'bidders/my-bidder/filterSets/my-filterSet', - * // Requested page size. The server may return fewer results than requested. - * // If unspecified, the server will pick an appropriate default. + * // Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. - * // Typically, this is the value of - * // ListNonBillableWinningBidsResponse.nextPageToken - * // returned from the previous call to the nonBillableWinningBids.list - * // method. + * // A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method. * pageToken: 'placeholder-value', * } * ); @@ -13297,7 +12786,7 @@ export namespace adexchangebuyer2_v2beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * @param {string} params.filterSetName Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` * @param {integer=} params.pageSize Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13396,7 +12885,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Params$Resource$Bidders$Filtersets$Nonbillablewinningbids$List extends StandardParameters { /** - * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + * Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` */ filterSetName?: string; /**