{ "uuid": "5883c7f1-5183-46fb-be32-c968ee158ce7", "lastMigration": 29, "name": "Authorized Buyers Marketplace API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "51a0c868-8735-48fd-a16d-0f831c4ef734", "documentation": "Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.", "method": "post", "endpoint": "v1/:auctionPackage:subscribeClients", "responses": [ { "uuid": "484f3821-b3ed-4496-9b57-87fbbcaf08b6", "body": "{\n \"createTime\": \"\",\n \"creator\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"name\": \"\",\n \"subscribedClients\": [\n \"\"\n ],\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99bd8903-437e-4e83-b1a0-4dc2d096f809", "documentation": "Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.", "method": "post", "endpoint": "v1/:auctionPackage:unsubscribeClients", "responses": [ { "uuid": "3c3eede4-48ce-4c05-b57d-4d1807a034ba", "body": "{\n \"createTime\": \"\",\n \"creator\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"name\": \"\",\n \"subscribedClients\": [\n \"\"\n ],\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6bb6e64b-6762-426f-bb75-ef627f0a6e16", "documentation": "Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.", "method": "post", "endpoint": "v1/:buyer/proposals:sendRfp", "responses": [ { "uuid": "6b9ace69-246b-48f9-83b6-7db84d487a48", "body": "{\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"buyerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"buyerPrivateData\": {\n \"referenceId\": \"\"\n },\n \"client\": \"\",\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"displayName\": \"\",\n \"isRenegotiating\": {{faker 'datatype.boolean'}},\n \"lastUpdaterOrCommentorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"name\": \"\",\n \"notes\": [\n {\n \"createTime\": \"\",\n \"creatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"note\": \"\"\n }\n ],\n \"originatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}},\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'BUYER_REVIEW_REQUESTED' 'SELLER_REVIEW_REQUESTED' 'BUYER_ACCEPTANCE_REQUESTED' 'FINALIZED' 'TERMINATED')}}\",\n \"termsAndConditions\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0258f115-97fd-42f0-8fbf-71bed4f38b46", "documentation": "Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.", "method": "post", "endpoint": "v1/:deal:addCreative", "responses": [ { "uuid": "90f9f400-f019-49b0-84d1-1cad3a2eecb8", "body": "{\n \"deal\": {\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"client\": \"\",\n \"createTime\": \"\",\n \"creativeRequirements\": {\n \"creativeFormat\": \"{{oneOf (array 'CREATIVE_FORMAT_UNSPECIFIED' 'DISPLAY' 'VIDEO')}}\",\n \"creativePreApprovalPolicy\": \"{{oneOf (array 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED' 'SELLER_PRE_APPROVAL_REQUIRED' 'SELLER_PRE_APPROVAL_NOT_REQUIRED')}}\",\n \"creativeSafeFrameCompatibility\": \"{{oneOf (array 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED' 'COMPATIBLE' 'INCOMPATIBLE')}}\",\n \"maxAdDurationMs\": \"\",\n \"programmaticCreativeSource\": \"{{oneOf (array 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED' 'ADVERTISER' 'PUBLISHER')}}\",\n \"skippableAdType\": \"{{oneOf (array 'SKIPPABLE_AD_TYPE_UNSPECIFIED' 'SKIPPABLE' 'INSTREAM_SELECT' 'NOT_SKIPPABLE' 'ANY')}}\"\n },\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"deliveryControl\": {\n \"companionDeliveryType\": \"{{oneOf (array 'COMPANION_DELIVERY_TYPE_UNSPECIFIED' 'DELIVERY_OPTIONAL' 'DELIVERY_AT_LEAST_ONE' 'DELIVERY_ALL')}}\",\n \"creativeRotationType\": \"{{oneOf (array 'CREATIVE_ROTATION_TYPE_UNSPECIFIED' 'ROTATION_EVEN' 'ROTATION_OPTIMIZED' 'ROTATION_MANUAL' 'ROTATION_SEQUENTIAL')}}\",\n \"deliveryRateType\": \"{{oneOf (array 'DELIVERY_RATE_TYPE_UNSPECIFIED' 'EVENLY' 'FRONT_LOADED' 'AS_FAST_AS_POSSIBLE')}}\",\n \"frequencyCap\": [\n {\n \"maxImpressions\": {{faker 'number.int' max=99999}},\n \"timeUnitType\": \"{{oneOf (array 'TIME_UNIT_TYPE_UNSPECIFIED' 'MINUTE' 'HOUR' 'DAY' 'WEEK' 'MONTH' 'LIFETIME' 'POD' 'STREAM')}}\",\n \"timeUnitsCount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"roadblockingType\": \"{{oneOf (array 'ROADBLOCKING_TYPE_UNSPECIFIED' 'ONLY_ONE' 'ONE_OR_MORE' 'AS_MANY_AS_POSSIBLE' 'ALL_ROADBLOCK' 'CREATIVE_SET')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\",\n \"estimatedGrossSpend\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"flightEndTime\": \"\",\n \"flightStartTime\": \"\",\n \"name\": \"\",\n \"preferredDealTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n }\n },\n \"privateAuctionTerms\": {\n \"floorPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"openAuctionAllowed\": {{faker 'datatype.boolean'}}\n },\n \"programmaticGuaranteedTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"guaranteedLooks\": \"\",\n \"impressionCap\": \"\",\n \"minimumDailyLooks\": \"\",\n \"percentShareOfVoice\": \"\",\n \"reservationType\": \"{{oneOf (array 'RESERVATION_TYPE_UNSPECIFIED' 'STANDARD' 'SPONSORSHIP')}}\"\n },\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerTimeZone\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"targeting\": {\n \"daypartTargeting\": {\n \"dayParts\": [\n {\n \"dayOfWeek\": \"{{oneOf (array 'DAY_OF_WEEK_UNSPECIFIED' 'MONDAY' 'TUESDAY' 'WEDNESDAY' 'THURSDAY' 'FRIDAY' 'SATURDAY' 'SUNDAY')}}\",\n \"endTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"timeZoneType\": \"{{oneOf (array 'TIME_ZONE_TYPE_UNSPECIFIED' 'SELLER' 'USER')}}\"\n },\n \"geoTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"inventorySizeTargeting\": {\n \"excludedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ],\n \"targetedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ]\n },\n \"inventoryTypeTargeting\": {\n \"inventoryTypes\": [\n \"{{oneOf (array 'INVENTORY_TYPE_UNSPECIFIED' 'BROWSER' 'MOBILE_APP' 'VIDEO_PLAYER')}}\"\n ]\n },\n \"placementTargeting\": {\n \"mobileApplicationTargeting\": {\n \"firstPartyTargeting\": {\n \"excludedAppIds\": [\n \"\"\n ],\n \"targetedAppIds\": [\n \"\"\n ]\n }\n },\n \"uriTargeting\": {\n \"excludedUris\": [\n \"\"\n ],\n \"targetedUris\": [\n \"\"\n ]\n }\n },\n \"technologyTargeting\": {\n \"deviceCapabilityTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"deviceCategoryTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemTargeting\": {\n \"operatingSystemCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemVersionCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n }\n }\n },\n \"userListTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"videoTargeting\": {\n \"excludedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ],\n \"targetedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ]\n }\n },\n \"updateTime\": \"\"\n },\n \"dealPausingInfo\": {\n \"pauseReason\": \"\",\n \"pauseRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}}\n },\n \"dealServingStatus\": \"{{oneOf (array 'DEAL_SERVING_STATUS_UNSPECIFIED' 'ACTIVE' 'ENDED' 'PAUSED_BY_BUYER' 'PAUSED_BY_SELLER')}}\",\n \"name\": \"\",\n \"readyToServe\": {{faker 'datatype.boolean'}},\n \"rtbMetrics\": {\n \"adImpressions7Days\": \"\",\n \"bidRate7Days\": {{faker 'number.float'}},\n \"bidRequests7Days\": \"\",\n \"bids7Days\": \"\",\n \"filteredBidRate7Days\": {{faker 'number.float'}},\n \"mustBidRateCurrentMonth\": {{faker 'number.float'}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5a7751cb-4ca3-4fe6-af1a-477269a24509", "documentation": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.", "method": "post", "endpoint": "v1/:deal:setReadyToServe", "responses": [ { "uuid": "e6884cfa-a57d-42d2-920e-c6453db4f487", "body": "{\n \"deal\": {\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"client\": \"\",\n \"createTime\": \"\",\n \"creativeRequirements\": {\n \"creativeFormat\": \"{{oneOf (array 'CREATIVE_FORMAT_UNSPECIFIED' 'DISPLAY' 'VIDEO')}}\",\n \"creativePreApprovalPolicy\": \"{{oneOf (array 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED' 'SELLER_PRE_APPROVAL_REQUIRED' 'SELLER_PRE_APPROVAL_NOT_REQUIRED')}}\",\n \"creativeSafeFrameCompatibility\": \"{{oneOf (array 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED' 'COMPATIBLE' 'INCOMPATIBLE')}}\",\n \"maxAdDurationMs\": \"\",\n \"programmaticCreativeSource\": \"{{oneOf (array 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED' 'ADVERTISER' 'PUBLISHER')}}\",\n \"skippableAdType\": \"{{oneOf (array 'SKIPPABLE_AD_TYPE_UNSPECIFIED' 'SKIPPABLE' 'INSTREAM_SELECT' 'NOT_SKIPPABLE' 'ANY')}}\"\n },\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"deliveryControl\": {\n \"companionDeliveryType\": \"{{oneOf (array 'COMPANION_DELIVERY_TYPE_UNSPECIFIED' 'DELIVERY_OPTIONAL' 'DELIVERY_AT_LEAST_ONE' 'DELIVERY_ALL')}}\",\n \"creativeRotationType\": \"{{oneOf (array 'CREATIVE_ROTATION_TYPE_UNSPECIFIED' 'ROTATION_EVEN' 'ROTATION_OPTIMIZED' 'ROTATION_MANUAL' 'ROTATION_SEQUENTIAL')}}\",\n \"deliveryRateType\": \"{{oneOf (array 'DELIVERY_RATE_TYPE_UNSPECIFIED' 'EVENLY' 'FRONT_LOADED' 'AS_FAST_AS_POSSIBLE')}}\",\n \"frequencyCap\": [\n {\n \"maxImpressions\": {{faker 'number.int' max=99999}},\n \"timeUnitType\": \"{{oneOf (array 'TIME_UNIT_TYPE_UNSPECIFIED' 'MINUTE' 'HOUR' 'DAY' 'WEEK' 'MONTH' 'LIFETIME' 'POD' 'STREAM')}}\",\n \"timeUnitsCount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"roadblockingType\": \"{{oneOf (array 'ROADBLOCKING_TYPE_UNSPECIFIED' 'ONLY_ONE' 'ONE_OR_MORE' 'AS_MANY_AS_POSSIBLE' 'ALL_ROADBLOCK' 'CREATIVE_SET')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\",\n \"estimatedGrossSpend\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"flightEndTime\": \"\",\n \"flightStartTime\": \"\",\n \"name\": \"\",\n \"preferredDealTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n }\n },\n \"privateAuctionTerms\": {\n \"floorPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"openAuctionAllowed\": {{faker 'datatype.boolean'}}\n },\n \"programmaticGuaranteedTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"guaranteedLooks\": \"\",\n \"impressionCap\": \"\",\n \"minimumDailyLooks\": \"\",\n \"percentShareOfVoice\": \"\",\n \"reservationType\": \"{{oneOf (array 'RESERVATION_TYPE_UNSPECIFIED' 'STANDARD' 'SPONSORSHIP')}}\"\n },\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerTimeZone\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"targeting\": {\n \"daypartTargeting\": {\n \"dayParts\": [\n {\n \"dayOfWeek\": \"{{oneOf (array 'DAY_OF_WEEK_UNSPECIFIED' 'MONDAY' 'TUESDAY' 'WEDNESDAY' 'THURSDAY' 'FRIDAY' 'SATURDAY' 'SUNDAY')}}\",\n \"endTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"timeZoneType\": \"{{oneOf (array 'TIME_ZONE_TYPE_UNSPECIFIED' 'SELLER' 'USER')}}\"\n },\n \"geoTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"inventorySizeTargeting\": {\n \"excludedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ],\n \"targetedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ]\n },\n \"inventoryTypeTargeting\": {\n \"inventoryTypes\": [\n \"{{oneOf (array 'INVENTORY_TYPE_UNSPECIFIED' 'BROWSER' 'MOBILE_APP' 'VIDEO_PLAYER')}}\"\n ]\n },\n \"placementTargeting\": {\n \"mobileApplicationTargeting\": {\n \"firstPartyTargeting\": {\n \"excludedAppIds\": [\n \"\"\n ],\n \"targetedAppIds\": [\n \"\"\n ]\n }\n },\n \"uriTargeting\": {\n \"excludedUris\": [\n \"\"\n ],\n \"targetedUris\": [\n \"\"\n ]\n }\n },\n \"technologyTargeting\": {\n \"deviceCapabilityTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"deviceCategoryTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemTargeting\": {\n \"operatingSystemCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemVersionCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n }\n }\n },\n \"userListTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"videoTargeting\": {\n \"excludedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ],\n \"targetedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ]\n }\n },\n \"updateTime\": \"\"\n },\n \"dealPausingInfo\": {\n \"pauseReason\": \"\",\n \"pauseRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}}\n },\n \"dealServingStatus\": \"{{oneOf (array 'DEAL_SERVING_STATUS_UNSPECIFIED' 'ACTIVE' 'ENDED' 'PAUSED_BY_BUYER' 'PAUSED_BY_SELLER')}}\",\n \"name\": \"\",\n \"readyToServe\": {{faker 'datatype.boolean'}},\n \"rtbMetrics\": {\n \"adImpressions7Days\": \"\",\n \"bidRate7Days\": {{faker 'number.float'}},\n \"bidRequests7Days\": \"\",\n \"bids7Days\": \"\",\n \"filteredBidRate7Days\": {{faker 'number.float'}},\n \"mustBidRateCurrentMonth\": {{faker 'number.float'}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "21cc2d13-dd3d-468b-bcb7-af01d7141995", "documentation": "Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.", "method": "delete", "endpoint": "v1/:name", "responses": [ { "uuid": "8917968e-7572-47b7-995c-e0dd11d77aac", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "96a29068-50df-44cf-836d-7726e12cb666", "documentation": "Gets the requested publisher profile by name.", "method": "get", "endpoint": "v1/:name", "responses": [ { "uuid": "cff08a28-ae8c-41aa-ac53-c6ebf2beabb6", "body": "{\n \"audienceDescription\": \"\",\n \"directDealsContact\": \"\",\n \"displayName\": \"\",\n \"domains\": [\n \"\"\n ],\n \"isParent\": {{faker 'datatype.boolean'}},\n \"logoUrl\": \"\",\n \"mediaKitUrl\": \"\",\n \"mobileApps\": [\n {\n \"appStore\": \"{{oneOf (array 'APP_STORE_TYPE_UNSPECIFIED' 'APPLE_ITUNES' 'GOOGLE_PLAY' 'ROKU' 'AMAZON_FIRE_TV' 'PLAYSTATION' 'XBOX' 'SAMSUNG_TV' 'AMAZON' 'OPPO' 'SAMSUNG' 'VIVO' 'XIAOMI')}}\",\n \"externalAppId\": \"\",\n \"name\": \"\"\n }\n ],\n \"name\": \"\",\n \"overview\": \"\",\n \"pitchStatement\": \"\",\n \"programmaticDealsContact\": \"\",\n \"publisherCode\": \"\",\n \"samplePageUrl\": \"\",\n \"topHeadlines\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bddf8616-54c3-42f9-99a5-b02694faa688", "documentation": "Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.", "method": "patch", "endpoint": "v1/:name", "responses": [ { "uuid": "c998209a-08a7-4a02-94fc-41fbaacd2b74", "body": "{\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"client\": \"\",\n \"createTime\": \"\",\n \"creativeRequirements\": {\n \"creativeFormat\": \"{{oneOf (array 'CREATIVE_FORMAT_UNSPECIFIED' 'DISPLAY' 'VIDEO')}}\",\n \"creativePreApprovalPolicy\": \"{{oneOf (array 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED' 'SELLER_PRE_APPROVAL_REQUIRED' 'SELLER_PRE_APPROVAL_NOT_REQUIRED')}}\",\n \"creativeSafeFrameCompatibility\": \"{{oneOf (array 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED' 'COMPATIBLE' 'INCOMPATIBLE')}}\",\n \"maxAdDurationMs\": \"\",\n \"programmaticCreativeSource\": \"{{oneOf (array 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED' 'ADVERTISER' 'PUBLISHER')}}\",\n \"skippableAdType\": \"{{oneOf (array 'SKIPPABLE_AD_TYPE_UNSPECIFIED' 'SKIPPABLE' 'INSTREAM_SELECT' 'NOT_SKIPPABLE' 'ANY')}}\"\n },\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"deliveryControl\": {\n \"companionDeliveryType\": \"{{oneOf (array 'COMPANION_DELIVERY_TYPE_UNSPECIFIED' 'DELIVERY_OPTIONAL' 'DELIVERY_AT_LEAST_ONE' 'DELIVERY_ALL')}}\",\n \"creativeRotationType\": \"{{oneOf (array 'CREATIVE_ROTATION_TYPE_UNSPECIFIED' 'ROTATION_EVEN' 'ROTATION_OPTIMIZED' 'ROTATION_MANUAL' 'ROTATION_SEQUENTIAL')}}\",\n \"deliveryRateType\": \"{{oneOf (array 'DELIVERY_RATE_TYPE_UNSPECIFIED' 'EVENLY' 'FRONT_LOADED' 'AS_FAST_AS_POSSIBLE')}}\",\n \"frequencyCap\": [\n {\n \"maxImpressions\": {{faker 'number.int' max=99999}},\n \"timeUnitType\": \"{{oneOf (array 'TIME_UNIT_TYPE_UNSPECIFIED' 'MINUTE' 'HOUR' 'DAY' 'WEEK' 'MONTH' 'LIFETIME' 'POD' 'STREAM')}}\",\n \"timeUnitsCount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"roadblockingType\": \"{{oneOf (array 'ROADBLOCKING_TYPE_UNSPECIFIED' 'ONLY_ONE' 'ONE_OR_MORE' 'AS_MANY_AS_POSSIBLE' 'ALL_ROADBLOCK' 'CREATIVE_SET')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\",\n \"estimatedGrossSpend\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"flightEndTime\": \"\",\n \"flightStartTime\": \"\",\n \"name\": \"\",\n \"preferredDealTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n }\n },\n \"privateAuctionTerms\": {\n \"floorPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"openAuctionAllowed\": {{faker 'datatype.boolean'}}\n },\n \"programmaticGuaranteedTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"guaranteedLooks\": \"\",\n \"impressionCap\": \"\",\n \"minimumDailyLooks\": \"\",\n \"percentShareOfVoice\": \"\",\n \"reservationType\": \"{{oneOf (array 'RESERVATION_TYPE_UNSPECIFIED' 'STANDARD' 'SPONSORSHIP')}}\"\n },\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerTimeZone\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"targeting\": {\n \"daypartTargeting\": {\n \"dayParts\": [\n {\n \"dayOfWeek\": \"{{oneOf (array 'DAY_OF_WEEK_UNSPECIFIED' 'MONDAY' 'TUESDAY' 'WEDNESDAY' 'THURSDAY' 'FRIDAY' 'SATURDAY' 'SUNDAY')}}\",\n \"endTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"timeZoneType\": \"{{oneOf (array 'TIME_ZONE_TYPE_UNSPECIFIED' 'SELLER' 'USER')}}\"\n },\n \"geoTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"inventorySizeTargeting\": {\n \"excludedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ],\n \"targetedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ]\n },\n \"inventoryTypeTargeting\": {\n \"inventoryTypes\": [\n \"{{oneOf (array 'INVENTORY_TYPE_UNSPECIFIED' 'BROWSER' 'MOBILE_APP' 'VIDEO_PLAYER')}}\"\n ]\n },\n \"placementTargeting\": {\n \"mobileApplicationTargeting\": {\n \"firstPartyTargeting\": {\n \"excludedAppIds\": [\n \"\"\n ],\n \"targetedAppIds\": [\n \"\"\n ]\n }\n },\n \"uriTargeting\": {\n \"excludedUris\": [\n \"\"\n ],\n \"targetedUris\": [\n \"\"\n ]\n }\n },\n \"technologyTargeting\": {\n \"deviceCapabilityTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"deviceCategoryTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemTargeting\": {\n \"operatingSystemCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemVersionCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n }\n }\n },\n \"userListTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"videoTargeting\": {\n \"excludedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ],\n \"targetedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ]\n }\n },\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "81303114-4c8a-4cfe-b9e6-cac9fb734869", "documentation": "Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.", "method": "post", "endpoint": "v1/:name:accept", "responses": [ { "uuid": "4f7689c3-720f-44ac-9dcb-4ae70c7c9d0d", "body": "{\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"buyerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"buyerPrivateData\": {\n \"referenceId\": \"\"\n },\n \"client\": \"\",\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"displayName\": \"\",\n \"isRenegotiating\": {{faker 'datatype.boolean'}},\n \"lastUpdaterOrCommentorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"name\": \"\",\n \"notes\": [\n {\n \"createTime\": \"\",\n \"creatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"note\": \"\"\n }\n ],\n \"originatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}},\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'BUYER_REVIEW_REQUESTED' 'SELLER_REVIEW_REQUESTED' 'BUYER_ACCEPTANCE_REQUESTED' 'FINALIZED' 'TERMINATED')}}\",\n \"termsAndConditions\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e7a9312f-ba8b-4c28-b3be-9b23fcd7b0be", "documentation": "Activates an existing client user. The state of the client user will be updated from \"INACTIVE\" to \"ACTIVE\". This method has no effect if the client user is already in \"ACTIVE\" state. An error will be returned if the client user to activate is still in \"INVITED\" state.", "method": "post", "endpoint": "v1/:name:activate", "responses": [ { "uuid": "d87c6486-f66f-4cd6-b195-a2e7253bc2e0", "body": "{\n \"email\": \"\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'INVITED' 'ACTIVE' 'INACTIVE')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5aa5afb2-cab3-4311-b2bb-fb88f522246d", "documentation": "Deactivates an existing client user. The state of the client user will be updated from \"ACTIVE\" to \"INACTIVE\". This method has no effect if the client user is already in \"INACTIVE\" state. An error will be returned if the client user to deactivate is still in \"INVITED\" state.", "method": "post", "endpoint": "v1/:name:deactivate", "responses": [ { "uuid": "d3e33ee0-9c12-4e96-9734-d47664fd95f9", "body": "{\n \"email\": \"\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'INVITED' 'ACTIVE' 'INACTIVE')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba2720d3-0653-430a-822d-26135cb7d4de", "documentation": "Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals.", "method": "post", "endpoint": "v1/:name:pause", "responses": [ { "uuid": "f7cfeb4b-1259-42ca-872d-620813d24a28", "body": "{\n \"deal\": {\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"client\": \"\",\n \"createTime\": \"\",\n \"creativeRequirements\": {\n \"creativeFormat\": \"{{oneOf (array 'CREATIVE_FORMAT_UNSPECIFIED' 'DISPLAY' 'VIDEO')}}\",\n \"creativePreApprovalPolicy\": \"{{oneOf (array 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED' 'SELLER_PRE_APPROVAL_REQUIRED' 'SELLER_PRE_APPROVAL_NOT_REQUIRED')}}\",\n \"creativeSafeFrameCompatibility\": \"{{oneOf (array 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED' 'COMPATIBLE' 'INCOMPATIBLE')}}\",\n \"maxAdDurationMs\": \"\",\n \"programmaticCreativeSource\": \"{{oneOf (array 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED' 'ADVERTISER' 'PUBLISHER')}}\",\n \"skippableAdType\": \"{{oneOf (array 'SKIPPABLE_AD_TYPE_UNSPECIFIED' 'SKIPPABLE' 'INSTREAM_SELECT' 'NOT_SKIPPABLE' 'ANY')}}\"\n },\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"deliveryControl\": {\n \"companionDeliveryType\": \"{{oneOf (array 'COMPANION_DELIVERY_TYPE_UNSPECIFIED' 'DELIVERY_OPTIONAL' 'DELIVERY_AT_LEAST_ONE' 'DELIVERY_ALL')}}\",\n \"creativeRotationType\": \"{{oneOf (array 'CREATIVE_ROTATION_TYPE_UNSPECIFIED' 'ROTATION_EVEN' 'ROTATION_OPTIMIZED' 'ROTATION_MANUAL' 'ROTATION_SEQUENTIAL')}}\",\n \"deliveryRateType\": \"{{oneOf (array 'DELIVERY_RATE_TYPE_UNSPECIFIED' 'EVENLY' 'FRONT_LOADED' 'AS_FAST_AS_POSSIBLE')}}\",\n \"frequencyCap\": [\n {\n \"maxImpressions\": {{faker 'number.int' max=99999}},\n \"timeUnitType\": \"{{oneOf (array 'TIME_UNIT_TYPE_UNSPECIFIED' 'MINUTE' 'HOUR' 'DAY' 'WEEK' 'MONTH' 'LIFETIME' 'POD' 'STREAM')}}\",\n \"timeUnitsCount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"roadblockingType\": \"{{oneOf (array 'ROADBLOCKING_TYPE_UNSPECIFIED' 'ONLY_ONE' 'ONE_OR_MORE' 'AS_MANY_AS_POSSIBLE' 'ALL_ROADBLOCK' 'CREATIVE_SET')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\",\n \"estimatedGrossSpend\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"flightEndTime\": \"\",\n \"flightStartTime\": \"\",\n \"name\": \"\",\n \"preferredDealTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n }\n },\n \"privateAuctionTerms\": {\n \"floorPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"openAuctionAllowed\": {{faker 'datatype.boolean'}}\n },\n \"programmaticGuaranteedTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"guaranteedLooks\": \"\",\n \"impressionCap\": \"\",\n \"minimumDailyLooks\": \"\",\n \"percentShareOfVoice\": \"\",\n \"reservationType\": \"{{oneOf (array 'RESERVATION_TYPE_UNSPECIFIED' 'STANDARD' 'SPONSORSHIP')}}\"\n },\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerTimeZone\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"targeting\": {\n \"daypartTargeting\": {\n \"dayParts\": [\n {\n \"dayOfWeek\": \"{{oneOf (array 'DAY_OF_WEEK_UNSPECIFIED' 'MONDAY' 'TUESDAY' 'WEDNESDAY' 'THURSDAY' 'FRIDAY' 'SATURDAY' 'SUNDAY')}}\",\n \"endTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"timeZoneType\": \"{{oneOf (array 'TIME_ZONE_TYPE_UNSPECIFIED' 'SELLER' 'USER')}}\"\n },\n \"geoTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"inventorySizeTargeting\": {\n \"excludedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ],\n \"targetedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ]\n },\n \"inventoryTypeTargeting\": {\n \"inventoryTypes\": [\n \"{{oneOf (array 'INVENTORY_TYPE_UNSPECIFIED' 'BROWSER' 'MOBILE_APP' 'VIDEO_PLAYER')}}\"\n ]\n },\n \"placementTargeting\": {\n \"mobileApplicationTargeting\": {\n \"firstPartyTargeting\": {\n \"excludedAppIds\": [\n \"\"\n ],\n \"targetedAppIds\": [\n \"\"\n ]\n }\n },\n \"uriTargeting\": {\n \"excludedUris\": [\n \"\"\n ],\n \"targetedUris\": [\n \"\"\n ]\n }\n },\n \"technologyTargeting\": {\n \"deviceCapabilityTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"deviceCategoryTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemTargeting\": {\n \"operatingSystemCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemVersionCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n }\n }\n },\n \"userListTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"videoTargeting\": {\n \"excludedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ],\n \"targetedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ]\n }\n },\n \"updateTime\": \"\"\n },\n \"dealPausingInfo\": {\n \"pauseReason\": \"\",\n \"pauseRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}}\n },\n \"dealServingStatus\": \"{{oneOf (array 'DEAL_SERVING_STATUS_UNSPECIFIED' 'ACTIVE' 'ENDED' 'PAUSED_BY_BUYER' 'PAUSED_BY_SELLER')}}\",\n \"name\": \"\",\n \"readyToServe\": {{faker 'datatype.boolean'}},\n \"rtbMetrics\": {\n \"adImpressions7Days\": \"\",\n \"bidRate7Days\": {{faker 'number.float'}},\n \"bidRequests7Days\": \"\",\n \"bids7Days\": \"\",\n \"filteredBidRate7Days\": {{faker 'number.float'}},\n \"mustBidRateCurrentMonth\": {{faker 'number.float'}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fbb203a8-2e87-4042-b783-eef6af8fd3e9", "documentation": "Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals.", "method": "post", "endpoint": "v1/:name:resume", "responses": [ { "uuid": "a3960b0d-f942-4923-9bfe-9bd53e6f3e1d", "body": "{\n \"deal\": {\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"client\": \"\",\n \"createTime\": \"\",\n \"creativeRequirements\": {\n \"creativeFormat\": \"{{oneOf (array 'CREATIVE_FORMAT_UNSPECIFIED' 'DISPLAY' 'VIDEO')}}\",\n \"creativePreApprovalPolicy\": \"{{oneOf (array 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED' 'SELLER_PRE_APPROVAL_REQUIRED' 'SELLER_PRE_APPROVAL_NOT_REQUIRED')}}\",\n \"creativeSafeFrameCompatibility\": \"{{oneOf (array 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED' 'COMPATIBLE' 'INCOMPATIBLE')}}\",\n \"maxAdDurationMs\": \"\",\n \"programmaticCreativeSource\": \"{{oneOf (array 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED' 'ADVERTISER' 'PUBLISHER')}}\",\n \"skippableAdType\": \"{{oneOf (array 'SKIPPABLE_AD_TYPE_UNSPECIFIED' 'SKIPPABLE' 'INSTREAM_SELECT' 'NOT_SKIPPABLE' 'ANY')}}\"\n },\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"deliveryControl\": {\n \"companionDeliveryType\": \"{{oneOf (array 'COMPANION_DELIVERY_TYPE_UNSPECIFIED' 'DELIVERY_OPTIONAL' 'DELIVERY_AT_LEAST_ONE' 'DELIVERY_ALL')}}\",\n \"creativeRotationType\": \"{{oneOf (array 'CREATIVE_ROTATION_TYPE_UNSPECIFIED' 'ROTATION_EVEN' 'ROTATION_OPTIMIZED' 'ROTATION_MANUAL' 'ROTATION_SEQUENTIAL')}}\",\n \"deliveryRateType\": \"{{oneOf (array 'DELIVERY_RATE_TYPE_UNSPECIFIED' 'EVENLY' 'FRONT_LOADED' 'AS_FAST_AS_POSSIBLE')}}\",\n \"frequencyCap\": [\n {\n \"maxImpressions\": {{faker 'number.int' max=99999}},\n \"timeUnitType\": \"{{oneOf (array 'TIME_UNIT_TYPE_UNSPECIFIED' 'MINUTE' 'HOUR' 'DAY' 'WEEK' 'MONTH' 'LIFETIME' 'POD' 'STREAM')}}\",\n \"timeUnitsCount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"roadblockingType\": \"{{oneOf (array 'ROADBLOCKING_TYPE_UNSPECIFIED' 'ONLY_ONE' 'ONE_OR_MORE' 'AS_MANY_AS_POSSIBLE' 'ALL_ROADBLOCK' 'CREATIVE_SET')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\",\n \"estimatedGrossSpend\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"flightEndTime\": \"\",\n \"flightStartTime\": \"\",\n \"name\": \"\",\n \"preferredDealTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n }\n },\n \"privateAuctionTerms\": {\n \"floorPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"openAuctionAllowed\": {{faker 'datatype.boolean'}}\n },\n \"programmaticGuaranteedTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"guaranteedLooks\": \"\",\n \"impressionCap\": \"\",\n \"minimumDailyLooks\": \"\",\n \"percentShareOfVoice\": \"\",\n \"reservationType\": \"{{oneOf (array 'RESERVATION_TYPE_UNSPECIFIED' 'STANDARD' 'SPONSORSHIP')}}\"\n },\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerTimeZone\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"targeting\": {\n \"daypartTargeting\": {\n \"dayParts\": [\n {\n \"dayOfWeek\": \"{{oneOf (array 'DAY_OF_WEEK_UNSPECIFIED' 'MONDAY' 'TUESDAY' 'WEDNESDAY' 'THURSDAY' 'FRIDAY' 'SATURDAY' 'SUNDAY')}}\",\n \"endTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"timeZoneType\": \"{{oneOf (array 'TIME_ZONE_TYPE_UNSPECIFIED' 'SELLER' 'USER')}}\"\n },\n \"geoTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"inventorySizeTargeting\": {\n \"excludedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ],\n \"targetedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ]\n },\n \"inventoryTypeTargeting\": {\n \"inventoryTypes\": [\n \"{{oneOf (array 'INVENTORY_TYPE_UNSPECIFIED' 'BROWSER' 'MOBILE_APP' 'VIDEO_PLAYER')}}\"\n ]\n },\n \"placementTargeting\": {\n \"mobileApplicationTargeting\": {\n \"firstPartyTargeting\": {\n \"excludedAppIds\": [\n \"\"\n ],\n \"targetedAppIds\": [\n \"\"\n ]\n }\n },\n \"uriTargeting\": {\n \"excludedUris\": [\n \"\"\n ],\n \"targetedUris\": [\n \"\"\n ]\n }\n },\n \"technologyTargeting\": {\n \"deviceCapabilityTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"deviceCategoryTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemTargeting\": {\n \"operatingSystemCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemVersionCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n }\n }\n },\n \"userListTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"videoTargeting\": {\n \"excludedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ],\n \"targetedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ]\n }\n },\n \"updateTime\": \"\"\n },\n \"dealPausingInfo\": {\n \"pauseReason\": \"\",\n \"pauseRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}}\n },\n \"dealServingStatus\": \"{{oneOf (array 'DEAL_SERVING_STATUS_UNSPECIFIED' 'ACTIVE' 'ENDED' 'PAUSED_BY_BUYER' 'PAUSED_BY_SELLER')}}\",\n \"name\": \"\",\n \"readyToServe\": {{faker 'datatype.boolean'}},\n \"rtbMetrics\": {\n \"adImpressions7Days\": \"\",\n \"bidRate7Days\": {{faker 'number.float'}},\n \"bidRequests7Days\": \"\",\n \"bids7Days\": \"\",\n \"filteredBidRate7Days\": {{faker 'number.float'}},\n \"mustBidRateCurrentMonth\": {{faker 'number.float'}}\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4a584af4-cd21-4122-aa9b-efee767ac8a5", "documentation": "Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.", "method": "post", "endpoint": "v1/:name:subscribe", "responses": [ { "uuid": "68050b1c-ccd2-4f0c-8c99-1d2bce529ce1", "body": "{\n \"createTime\": \"\",\n \"creator\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"name\": \"\",\n \"subscribedClients\": [\n \"\"\n ],\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "151f1817-5eff-43d8-a989-71330ee59b6a", "documentation": "Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.", "method": "post", "endpoint": "v1/:name:unsubscribe", "responses": [ { "uuid": "1d7eef57-8cca-4370-85a2-aa364aa7dcf4", "body": "{\n \"createTime\": \"\",\n \"creator\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"name\": \"\",\n \"subscribedClients\": [\n \"\"\n ],\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "79a56ebd-5023-4434-bc4a-902c21428499", "documentation": "List the auction packages subscribed by a buyer and its clients.", "method": "get", "endpoint": "v1/:parent/auctionPackages", "responses": [ { "uuid": "beec2222-f4d6-4b1f-acfd-a35fe6b6f443", "body": "{\n \"auctionPackages\": [\n {\n \"createTime\": \"\",\n \"creator\": \"\",\n \"description\": \"\",\n \"displayName\": \"\",\n \"name\": \"\",\n \"subscribedClients\": [\n \"\"\n ],\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2ab074e6-f5d8-45ad-9b6f-3ac9dcd22145", "documentation": "Lists all the clients for the current buyer.", "method": "get", "endpoint": "v1/:parent/clients", "responses": [ { "uuid": "1c556c2b-9a78-4965-af1f-7e4f5c226dd4", "body": "{\n \"clients\": [\n {\n \"displayName\": \"\",\n \"name\": \"\",\n \"partnerClientId\": \"\",\n \"role\": \"{{oneOf (array 'CLIENT_ROLE_UNSPECIFIED' 'CLIENT_DEAL_VIEWER' 'CLIENT_DEAL_NEGOTIATOR' 'CLIENT_DEAL_APPROVER')}}\",\n \"sellerVisible\": {{faker 'datatype.boolean'}},\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ACTIVE' 'INACTIVE')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a6a54e7b-d895-4afb-b921-c32911368e25", "documentation": "Creates a new client.", "method": "post", "endpoint": "v1/:parent/clients", "responses": [ { "uuid": "13404c99-51b0-40da-a617-6cdafe6b89cc", "body": "{\n \"displayName\": \"\",\n \"name\": \"\",\n \"partnerClientId\": \"\",\n \"role\": \"{{oneOf (array 'CLIENT_ROLE_UNSPECIFIED' 'CLIENT_DEAL_VIEWER' 'CLIENT_DEAL_NEGOTIATOR' 'CLIENT_DEAL_APPROVER')}}\",\n \"sellerVisible\": {{faker 'datatype.boolean'}},\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ACTIVE' 'INACTIVE')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "131ab5c3-1e9a-45da-930c-1d43fbbe714d", "documentation": "Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.", "method": "get", "endpoint": "v1/:parent/deals", "responses": [ { "uuid": "7813ab64-3f54-46cc-af8e-d7387a1f3d9d", "body": "{\n \"deals\": [\n {\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"client\": \"\",\n \"createTime\": \"\",\n \"creativeRequirements\": {\n \"creativeFormat\": \"{{oneOf (array 'CREATIVE_FORMAT_UNSPECIFIED' 'DISPLAY' 'VIDEO')}}\",\n \"creativePreApprovalPolicy\": \"{{oneOf (array 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED' 'SELLER_PRE_APPROVAL_REQUIRED' 'SELLER_PRE_APPROVAL_NOT_REQUIRED')}}\",\n \"creativeSafeFrameCompatibility\": \"{{oneOf (array 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED' 'COMPATIBLE' 'INCOMPATIBLE')}}\",\n \"maxAdDurationMs\": \"\",\n \"programmaticCreativeSource\": \"{{oneOf (array 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED' 'ADVERTISER' 'PUBLISHER')}}\",\n \"skippableAdType\": \"{{oneOf (array 'SKIPPABLE_AD_TYPE_UNSPECIFIED' 'SKIPPABLE' 'INSTREAM_SELECT' 'NOT_SKIPPABLE' 'ANY')}}\"\n },\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"deliveryControl\": {\n \"companionDeliveryType\": \"{{oneOf (array 'COMPANION_DELIVERY_TYPE_UNSPECIFIED' 'DELIVERY_OPTIONAL' 'DELIVERY_AT_LEAST_ONE' 'DELIVERY_ALL')}}\",\n \"creativeRotationType\": \"{{oneOf (array 'CREATIVE_ROTATION_TYPE_UNSPECIFIED' 'ROTATION_EVEN' 'ROTATION_OPTIMIZED' 'ROTATION_MANUAL' 'ROTATION_SEQUENTIAL')}}\",\n \"deliveryRateType\": \"{{oneOf (array 'DELIVERY_RATE_TYPE_UNSPECIFIED' 'EVENLY' 'FRONT_LOADED' 'AS_FAST_AS_POSSIBLE')}}\",\n \"frequencyCap\": [\n {\n \"maxImpressions\": {{faker 'number.int' max=99999}},\n \"timeUnitType\": \"{{oneOf (array 'TIME_UNIT_TYPE_UNSPECIFIED' 'MINUTE' 'HOUR' 'DAY' 'WEEK' 'MONTH' 'LIFETIME' 'POD' 'STREAM')}}\",\n \"timeUnitsCount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"roadblockingType\": \"{{oneOf (array 'ROADBLOCKING_TYPE_UNSPECIFIED' 'ONLY_ONE' 'ONE_OR_MORE' 'AS_MANY_AS_POSSIBLE' 'ALL_ROADBLOCK' 'CREATIVE_SET')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\",\n \"estimatedGrossSpend\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"flightEndTime\": \"\",\n \"flightStartTime\": \"\",\n \"name\": \"\",\n \"preferredDealTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n }\n },\n \"privateAuctionTerms\": {\n \"floorPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"openAuctionAllowed\": {{faker 'datatype.boolean'}}\n },\n \"programmaticGuaranteedTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"guaranteedLooks\": \"\",\n \"impressionCap\": \"\",\n \"minimumDailyLooks\": \"\",\n \"percentShareOfVoice\": \"\",\n \"reservationType\": \"{{oneOf (array 'RESERVATION_TYPE_UNSPECIFIED' 'STANDARD' 'SPONSORSHIP')}}\"\n },\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerTimeZone\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"targeting\": {\n \"daypartTargeting\": {\n \"dayParts\": [\n {\n \"dayOfWeek\": \"{{oneOf (array 'DAY_OF_WEEK_UNSPECIFIED' 'MONDAY' 'TUESDAY' 'WEDNESDAY' 'THURSDAY' 'FRIDAY' 'SATURDAY' 'SUNDAY')}}\",\n \"endTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"timeZoneType\": \"{{oneOf (array 'TIME_ZONE_TYPE_UNSPECIFIED' 'SELLER' 'USER')}}\"\n },\n \"geoTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"inventorySizeTargeting\": {\n \"excludedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ],\n \"targetedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ]\n },\n \"inventoryTypeTargeting\": {\n \"inventoryTypes\": [\n \"{{oneOf (array 'INVENTORY_TYPE_UNSPECIFIED' 'BROWSER' 'MOBILE_APP' 'VIDEO_PLAYER')}}\"\n ]\n },\n \"placementTargeting\": {\n \"mobileApplicationTargeting\": {\n \"firstPartyTargeting\": {\n \"excludedAppIds\": [\n \"\"\n ],\n \"targetedAppIds\": [\n \"\"\n ]\n }\n },\n \"uriTargeting\": {\n \"excludedUris\": [\n \"\"\n ],\n \"targetedUris\": [\n \"\"\n ]\n }\n },\n \"technologyTargeting\": {\n \"deviceCapabilityTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"deviceCategoryTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemTargeting\": {\n \"operatingSystemCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemVersionCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n }\n }\n },\n \"userListTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"videoTargeting\": {\n \"excludedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ],\n \"targetedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ]\n }\n },\n \"updateTime\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "da2a3460-d516-43b2-bb28-72ff944f59a6", "documentation": "Batch updates multiple deals in the same proposal.", "method": "post", "endpoint": "v1/:parent/deals:batchUpdate", "responses": [ { "uuid": "8eaaf760-f9e0-4063-ac9c-83e9bf7f7181", "body": "{\n \"deals\": [\n {\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"client\": \"\",\n \"createTime\": \"\",\n \"creativeRequirements\": {\n \"creativeFormat\": \"{{oneOf (array 'CREATIVE_FORMAT_UNSPECIFIED' 'DISPLAY' 'VIDEO')}}\",\n \"creativePreApprovalPolicy\": \"{{oneOf (array 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED' 'SELLER_PRE_APPROVAL_REQUIRED' 'SELLER_PRE_APPROVAL_NOT_REQUIRED')}}\",\n \"creativeSafeFrameCompatibility\": \"{{oneOf (array 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED' 'COMPATIBLE' 'INCOMPATIBLE')}}\",\n \"maxAdDurationMs\": \"\",\n \"programmaticCreativeSource\": \"{{oneOf (array 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED' 'ADVERTISER' 'PUBLISHER')}}\",\n \"skippableAdType\": \"{{oneOf (array 'SKIPPABLE_AD_TYPE_UNSPECIFIED' 'SKIPPABLE' 'INSTREAM_SELECT' 'NOT_SKIPPABLE' 'ANY')}}\"\n },\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"deliveryControl\": {\n \"companionDeliveryType\": \"{{oneOf (array 'COMPANION_DELIVERY_TYPE_UNSPECIFIED' 'DELIVERY_OPTIONAL' 'DELIVERY_AT_LEAST_ONE' 'DELIVERY_ALL')}}\",\n \"creativeRotationType\": \"{{oneOf (array 'CREATIVE_ROTATION_TYPE_UNSPECIFIED' 'ROTATION_EVEN' 'ROTATION_OPTIMIZED' 'ROTATION_MANUAL' 'ROTATION_SEQUENTIAL')}}\",\n \"deliveryRateType\": \"{{oneOf (array 'DELIVERY_RATE_TYPE_UNSPECIFIED' 'EVENLY' 'FRONT_LOADED' 'AS_FAST_AS_POSSIBLE')}}\",\n \"frequencyCap\": [\n {\n \"maxImpressions\": {{faker 'number.int' max=99999}},\n \"timeUnitType\": \"{{oneOf (array 'TIME_UNIT_TYPE_UNSPECIFIED' 'MINUTE' 'HOUR' 'DAY' 'WEEK' 'MONTH' 'LIFETIME' 'POD' 'STREAM')}}\",\n \"timeUnitsCount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"roadblockingType\": \"{{oneOf (array 'ROADBLOCKING_TYPE_UNSPECIFIED' 'ONLY_ONE' 'ONE_OR_MORE' 'AS_MANY_AS_POSSIBLE' 'ALL_ROADBLOCK' 'CREATIVE_SET')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\",\n \"estimatedGrossSpend\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"flightEndTime\": \"\",\n \"flightStartTime\": \"\",\n \"name\": \"\",\n \"preferredDealTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n }\n },\n \"privateAuctionTerms\": {\n \"floorPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"openAuctionAllowed\": {{faker 'datatype.boolean'}}\n },\n \"programmaticGuaranteedTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"guaranteedLooks\": \"\",\n \"impressionCap\": \"\",\n \"minimumDailyLooks\": \"\",\n \"percentShareOfVoice\": \"\",\n \"reservationType\": \"{{oneOf (array 'RESERVATION_TYPE_UNSPECIFIED' 'STANDARD' 'SPONSORSHIP')}}\"\n },\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerTimeZone\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"targeting\": {\n \"daypartTargeting\": {\n \"dayParts\": [\n {\n \"dayOfWeek\": \"{{oneOf (array 'DAY_OF_WEEK_UNSPECIFIED' 'MONDAY' 'TUESDAY' 'WEDNESDAY' 'THURSDAY' 'FRIDAY' 'SATURDAY' 'SUNDAY')}}\",\n \"endTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"timeZoneType\": \"{{oneOf (array 'TIME_ZONE_TYPE_UNSPECIFIED' 'SELLER' 'USER')}}\"\n },\n \"geoTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"inventorySizeTargeting\": {\n \"excludedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ],\n \"targetedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ]\n },\n \"inventoryTypeTargeting\": {\n \"inventoryTypes\": [\n \"{{oneOf (array 'INVENTORY_TYPE_UNSPECIFIED' 'BROWSER' 'MOBILE_APP' 'VIDEO_PLAYER')}}\"\n ]\n },\n \"placementTargeting\": {\n \"mobileApplicationTargeting\": {\n \"firstPartyTargeting\": {\n \"excludedAppIds\": [\n \"\"\n ],\n \"targetedAppIds\": [\n \"\"\n ]\n }\n },\n \"uriTargeting\": {\n \"excludedUris\": [\n \"\"\n ],\n \"targetedUris\": [\n \"\"\n ]\n }\n },\n \"technologyTargeting\": {\n \"deviceCapabilityTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"deviceCategoryTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemTargeting\": {\n \"operatingSystemCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemVersionCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n }\n }\n },\n \"userListTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"videoTargeting\": {\n \"excludedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ],\n \"targetedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ]\n }\n },\n \"updateTime\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1bfcd23d-0986-41c6-8168-65fa82ea0b0c", "documentation": "Lists finalized deals. Use the URL path \"/v1/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", "method": "get", "endpoint": "v1/:parent/finalizedDeals", "responses": [ { "uuid": "daee4914-6dc8-4cb6-a7d8-40c147938f29", "body": "{\n \"finalizedDeals\": [\n {\n \"deal\": {\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"client\": \"\",\n \"createTime\": \"\",\n \"creativeRequirements\": {\n \"creativeFormat\": \"{{oneOf (array 'CREATIVE_FORMAT_UNSPECIFIED' 'DISPLAY' 'VIDEO')}}\",\n \"creativePreApprovalPolicy\": \"{{oneOf (array 'CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED' 'SELLER_PRE_APPROVAL_REQUIRED' 'SELLER_PRE_APPROVAL_NOT_REQUIRED')}}\",\n \"creativeSafeFrameCompatibility\": \"{{oneOf (array 'CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED' 'COMPATIBLE' 'INCOMPATIBLE')}}\",\n \"maxAdDurationMs\": \"\",\n \"programmaticCreativeSource\": \"{{oneOf (array 'PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED' 'ADVERTISER' 'PUBLISHER')}}\",\n \"skippableAdType\": \"{{oneOf (array 'SKIPPABLE_AD_TYPE_UNSPECIFIED' 'SKIPPABLE' 'INSTREAM_SELECT' 'NOT_SKIPPABLE' 'ANY')}}\"\n },\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"deliveryControl\": {\n \"companionDeliveryType\": \"{{oneOf (array 'COMPANION_DELIVERY_TYPE_UNSPECIFIED' 'DELIVERY_OPTIONAL' 'DELIVERY_AT_LEAST_ONE' 'DELIVERY_ALL')}}\",\n \"creativeRotationType\": \"{{oneOf (array 'CREATIVE_ROTATION_TYPE_UNSPECIFIED' 'ROTATION_EVEN' 'ROTATION_OPTIMIZED' 'ROTATION_MANUAL' 'ROTATION_SEQUENTIAL')}}\",\n \"deliveryRateType\": \"{{oneOf (array 'DELIVERY_RATE_TYPE_UNSPECIFIED' 'EVENLY' 'FRONT_LOADED' 'AS_FAST_AS_POSSIBLE')}}\",\n \"frequencyCap\": [\n {\n \"maxImpressions\": {{faker 'number.int' max=99999}},\n \"timeUnitType\": \"{{oneOf (array 'TIME_UNIT_TYPE_UNSPECIFIED' 'MINUTE' 'HOUR' 'DAY' 'WEEK' 'MONTH' 'LIFETIME' 'POD' 'STREAM')}}\",\n \"timeUnitsCount\": {{faker 'number.int' max=99999}}\n }\n ],\n \"roadblockingType\": \"{{oneOf (array 'ROADBLOCKING_TYPE_UNSPECIFIED' 'ONLY_ONE' 'ONE_OR_MORE' 'AS_MANY_AS_POSSIBLE' 'ALL_ROADBLOCK' 'CREATIVE_SET')}}\"\n },\n \"description\": \"\",\n \"displayName\": \"\",\n \"estimatedGrossSpend\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"flightEndTime\": \"\",\n \"flightStartTime\": \"\",\n \"name\": \"\",\n \"preferredDealTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n }\n },\n \"privateAuctionTerms\": {\n \"floorPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"openAuctionAllowed\": {{faker 'datatype.boolean'}}\n },\n \"programmaticGuaranteedTerms\": {\n \"fixedPrice\": {\n \"amount\": {\n \"currencyCode\": \"\",\n \"nanos\": {{faker 'number.int' max=99999}},\n \"units\": \"\"\n },\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'CPM' 'CPD')}}\"\n },\n \"guaranteedLooks\": \"\",\n \"impressionCap\": \"\",\n \"minimumDailyLooks\": \"\",\n \"percentShareOfVoice\": \"\",\n \"reservationType\": \"{{oneOf (array 'RESERVATION_TYPE_UNSPECIFIED' 'STANDARD' 'SPONSORSHIP')}}\"\n },\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerTimeZone\": {\n \"id\": \"\",\n \"version\": \"\"\n },\n \"targeting\": {\n \"daypartTargeting\": {\n \"dayParts\": [\n {\n \"dayOfWeek\": \"{{oneOf (array 'DAY_OF_WEEK_UNSPECIFIED' 'MONDAY' 'TUESDAY' 'WEDNESDAY' 'THURSDAY' 'FRIDAY' 'SATURDAY' 'SUNDAY')}}\",\n \"endTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n },\n \"startTime\": {\n \"hours\": {{faker 'number.int' max=99999}},\n \"minutes\": {{faker 'number.int' max=99999}},\n \"nanos\": {{faker 'number.int' max=99999}},\n \"seconds\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"timeZoneType\": \"{{oneOf (array 'TIME_ZONE_TYPE_UNSPECIFIED' 'SELLER' 'USER')}}\"\n },\n \"geoTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"inventorySizeTargeting\": {\n \"excludedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ],\n \"targetedInventorySizes\": [\n {\n \"height\": \"\",\n \"type\": \"{{oneOf (array 'TYPE_UNSPECIFIED' 'PIXEL' 'INTERSTITIAL' 'NATIVE' 'FLUID')}}\",\n \"width\": \"\"\n }\n ]\n },\n \"inventoryTypeTargeting\": {\n \"inventoryTypes\": [\n \"{{oneOf (array 'INVENTORY_TYPE_UNSPECIFIED' 'BROWSER' 'MOBILE_APP' 'VIDEO_PLAYER')}}\"\n ]\n },\n \"placementTargeting\": {\n \"mobileApplicationTargeting\": {\n \"firstPartyTargeting\": {\n \"excludedAppIds\": [\n \"\"\n ],\n \"targetedAppIds\": [\n \"\"\n ]\n }\n },\n \"uriTargeting\": {\n \"excludedUris\": [\n \"\"\n ],\n \"targetedUris\": [\n \"\"\n ]\n }\n },\n \"technologyTargeting\": {\n \"deviceCapabilityTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"deviceCategoryTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemTargeting\": {\n \"operatingSystemCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"operatingSystemVersionCriteria\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n }\n }\n },\n \"userListTargeting\": {\n \"excludedCriteriaIds\": [\n \"\"\n ],\n \"targetedCriteriaIds\": [\n \"\"\n ]\n },\n \"videoTargeting\": {\n \"excludedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ],\n \"targetedPositionTypes\": [\n \"{{oneOf (array 'POSITION_TYPE_UNSPECIFIED' 'PREROLL' 'MIDROLL' 'POSTROLL')}}\"\n ]\n }\n },\n \"updateTime\": \"\"\n },\n \"dealPausingInfo\": {\n \"pauseReason\": \"\",\n \"pauseRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}}\n },\n \"dealServingStatus\": \"{{oneOf (array 'DEAL_SERVING_STATUS_UNSPECIFIED' 'ACTIVE' 'ENDED' 'PAUSED_BY_BUYER' 'PAUSED_BY_SELLER')}}\",\n \"name\": \"\",\n \"readyToServe\": {{faker 'datatype.boolean'}},\n \"rtbMetrics\": {\n \"adImpressions7Days\": \"\",\n \"bidRate7Days\": {{faker 'number.float'}},\n \"bidRequests7Days\": \"\",\n \"bids7Days\": \"\",\n \"filteredBidRate7Days\": {{faker 'number.float'}},\n \"mustBidRateCurrentMonth\": {{faker 'number.float'}}\n }\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b4bf5c60-1cd9-40f2-ba85-f2bc97a21399", "documentation": "Lists proposals. A filter expression (list filter syntax) may be specified to filter the results. This will not list finalized versions of proposals that are being renegotiated; to retrieve these use the finalizedProposals resource.", "method": "get", "endpoint": "v1/:parent/proposals", "responses": [ { "uuid": "722991df-f112-40fb-a44c-f6cfe4fcd51f", "body": "{\n \"nextPageToken\": \"\",\n \"proposals\": [\n {\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"buyerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"buyerPrivateData\": {\n \"referenceId\": \"\"\n },\n \"client\": \"\",\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"displayName\": \"\",\n \"isRenegotiating\": {{faker 'datatype.boolean'}},\n \"lastUpdaterOrCommentorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"name\": \"\",\n \"notes\": [\n {\n \"createTime\": \"\",\n \"creatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"note\": \"\"\n }\n ],\n \"originatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}},\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'BUYER_REVIEW_REQUESTED' 'SELLER_REVIEW_REQUESTED' 'BUYER_ACCEPTANCE_REQUESTED' 'FINALIZED' 'TERMINATED')}}\",\n \"termsAndConditions\": \"\",\n \"updateTime\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "00e57f24-c0f2-441f-b534-54eb0d48c1a7", "documentation": "Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.", "method": "get", "endpoint": "v1/:parent/publisherProfiles", "responses": [ { "uuid": "d00db404-714e-45b1-8bd2-58b6e4b3f591", "body": "{\n \"nextPageToken\": \"\",\n \"publisherProfiles\": [\n {\n \"audienceDescription\": \"\",\n \"directDealsContact\": \"\",\n \"displayName\": \"\",\n \"domains\": [\n \"\"\n ],\n \"isParent\": {{faker 'datatype.boolean'}},\n \"logoUrl\": \"\",\n \"mediaKitUrl\": \"\",\n \"mobileApps\": [\n {\n \"appStore\": \"{{oneOf (array 'APP_STORE_TYPE_UNSPECIFIED' 'APPLE_ITUNES' 'GOOGLE_PLAY' 'ROKU' 'AMAZON_FIRE_TV' 'PLAYSTATION' 'XBOX' 'SAMSUNG_TV' 'AMAZON' 'OPPO' 'SAMSUNG' 'VIVO' 'XIAOMI')}}\",\n \"externalAppId\": \"\",\n \"name\": \"\"\n }\n ],\n \"name\": \"\",\n \"overview\": \"\",\n \"pitchStatement\": \"\",\n \"programmaticDealsContact\": \"\",\n \"publisherCode\": \"\",\n \"samplePageUrl\": \"\",\n \"topHeadlines\": [\n \"\"\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8cf1c183-3d43-440d-9718-1e98d9690823", "documentation": "Lists all client users for a specified client.", "method": "get", "endpoint": "v1/:parent/users", "responses": [ { "uuid": "d36da7b2-d7e3-41ff-9bc2-dfa0274ca479", "body": "{\n \"clientUsers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'INVITED' 'ACTIVE' 'INACTIVE')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ea8f3485-9a43-44b9-9601-f7a123ee98ae", "documentation": "Creates a new client user in \"INVITED\" state. An email invitation will be sent to the new user, once accepted the user will become active.", "method": "post", "endpoint": "v1/:parent/users", "responses": [ { "uuid": "a8f97314-3a87-4c40-857a-cfc4e05e3814", "body": "{\n \"email\": \"\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'INVITED' 'ACTIVE' 'INACTIVE')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "db201a91-bbc3-41af-ba76-c98d592b5d83", "documentation": "Creates a note for this proposal and sends to the seller.", "method": "post", "endpoint": "v1/:proposal:addNote", "responses": [ { "uuid": "ea53f37b-b05e-4dd2-8fab-e2cd7d69a0fc", "body": "{\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"buyerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"buyerPrivateData\": {\n \"referenceId\": \"\"\n },\n \"client\": \"\",\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"displayName\": \"\",\n \"isRenegotiating\": {{faker 'datatype.boolean'}},\n \"lastUpdaterOrCommentorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"name\": \"\",\n \"notes\": [\n {\n \"createTime\": \"\",\n \"creatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"note\": \"\"\n }\n ],\n \"originatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}},\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'BUYER_REVIEW_REQUESTED' 'SELLER_REVIEW_REQUESTED' 'BUYER_ACCEPTANCE_REQUESTED' 'FINALIZED' 'TERMINATED')}}\",\n \"termsAndConditions\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "697eee31-b774-452f-aaaf-71425189f537", "documentation": "Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.", "method": "post", "endpoint": "v1/:proposal:cancelNegotiation", "responses": [ { "uuid": "4dc3be29-e5d8-404a-8d23-b1652ae971f8", "body": "{\n \"billedBuyer\": \"\",\n \"buyer\": \"\",\n \"buyerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"buyerPrivateData\": {\n \"referenceId\": \"\"\n },\n \"client\": \"\",\n \"dealType\": \"{{oneOf (array 'DEAL_TYPE_UNSPECIFIED' 'PREFERRED_DEAL' 'PRIVATE_AUCTION' 'PROGRAMMATIC_GUARANTEED')}}\",\n \"displayName\": \"\",\n \"isRenegotiating\": {{faker 'datatype.boolean'}},\n \"lastUpdaterOrCommentorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"name\": \"\",\n \"notes\": [\n {\n \"createTime\": \"\",\n \"creatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"note\": \"\"\n }\n ],\n \"originatorRole\": \"{{oneOf (array 'BUYER_SELLER_ROLE_UNSPECIFIED' 'BUYER' 'SELLER')}}\",\n \"pausingConsented\": {{faker 'datatype.boolean'}},\n \"proposalRevision\": \"\",\n \"publisherProfile\": \"\",\n \"sellerContacts\": [\n {\n \"displayName\": \"\",\n \"email\": \"\"\n }\n ],\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'BUYER_REVIEW_REQUESTED' 'SELLER_REVIEW_REQUESTED' 'BUYER_ACCEPTANCE_REQUESTED' 'FINALIZED' 'TERMINATED')}}\",\n \"termsAndConditions\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "51a0c868-8735-48fd-a16d-0f831c4ef734" }, { "type": "route", "uuid": "99bd8903-437e-4e83-b1a0-4dc2d096f809" }, { "type": "route", "uuid": "6bb6e64b-6762-426f-bb75-ef627f0a6e16" }, { "type": "route", "uuid": "0258f115-97fd-42f0-8fbf-71bed4f38b46" }, { "type": "route", "uuid": "5a7751cb-4ca3-4fe6-af1a-477269a24509" }, { "type": "route", "uuid": "21cc2d13-dd3d-468b-bcb7-af01d7141995" }, { "type": "route", "uuid": "96a29068-50df-44cf-836d-7726e12cb666" }, { "type": "route", "uuid": "bddf8616-54c3-42f9-99a5-b02694faa688" }, { "type": "route", "uuid": "81303114-4c8a-4cfe-b9e6-cac9fb734869" }, { "type": "route", "uuid": "e7a9312f-ba8b-4c28-b3be-9b23fcd7b0be" }, { "type": "route", "uuid": "5aa5afb2-cab3-4311-b2bb-fb88f522246d" }, { "type": "route", "uuid": "ba2720d3-0653-430a-822d-26135cb7d4de" }, { "type": "route", "uuid": "fbb203a8-2e87-4042-b783-eef6af8fd3e9" }, { "type": "route", "uuid": "4a584af4-cd21-4122-aa9b-efee767ac8a5" }, { "type": "route", "uuid": "151f1817-5eff-43d8-a989-71330ee59b6a" }, { "type": "route", "uuid": "79a56ebd-5023-4434-bc4a-902c21428499" }, { "type": "route", "uuid": "2ab074e6-f5d8-45ad-9b6f-3ac9dcd22145" }, { "type": "route", "uuid": "a6a54e7b-d895-4afb-b921-c32911368e25" }, { "type": "route", "uuid": "131ab5c3-1e9a-45da-930c-1d43fbbe714d" }, { "type": "route", "uuid": "da2a3460-d516-43b2-bb28-72ff944f59a6" }, { "type": "route", "uuid": "1bfcd23d-0986-41c6-8168-65fa82ea0b0c" }, { "type": "route", "uuid": "b4bf5c60-1cd9-40f2-ba85-f2bc97a21399" }, { "type": "route", "uuid": "00e57f24-c0f2-441f-b534-54eb0d48c1a7" }, { "type": "route", "uuid": "8cf1c183-3d43-440d-9718-1e98d9690823" }, { "type": "route", "uuid": "ea8f3485-9a43-44b9-9601-f7a123ee98ae" }, { "type": "route", "uuid": "db201a91-bbc3-41af-ba76-c98d592b5d83" }, { "type": "route", "uuid": "697eee31-b774-452f-aaaf-71425189f537" } ] }