--- title: "PATCH /v4/inventorySources/{+inventorySourceId}" method: PATCH path: "/v4/inventorySources/{+inventorySourceId}" tags: ["inventorySources"] --- # PATCH /v4/inventorySources/{+inventorySourceId} `PATCH /v4/inventorySources/{+inventorySourceId}` Updates an existing inventory source. Returns the updated inventory source if successful. ## Path parameters - `inventorySourceId` string, required ## Query parameters - `advertiserId` string - `partnerId` string - `updateMask` string ## Request body - InventorySource — An inventory source. - `timeRange` TimeRange — A time range. - `startTime` string, google-datetime — Required. The lower bound of a time range, inclusive. - `endTime` string, google-datetime — Required. The upper bound of a time range, inclusive. - `readWriteAccessors` InventorySourceAccessors — The partner or advertisers with access to the inventory source. - `partner` InventorySourceAccessorsPartnerAccessor — The partner with access to the inventory source. - `partnerId` string, int64 — The ID of the partner. - `advertisers` InventorySourceAccessorsAdvertiserAccessors — The advertisers with access to the inventory source. - `advertiserIds` string[] — The IDs of the advertisers. - `exchange` 'EXCHANGE_UNSPECIFIED' | 'EXCHANGE_GOOGLE_AD_MANAGER' | 'EXCHANGE_APPNEXUS' | 'EXCHANGE_BRIGHTROLL' | 'EXCHANGE_ADFORM' | 'EXCHANGE_ADMETA' | 'EXCHANGE_ADMIXER' | 'EXCHANGE_ADSMOGO' | 'EXCHANGE_ADSWIZZ' | 'EXCHANGE_BIDSWITCH' | 'EXCHANGE_BRIGHTROLL_DISPLAY' | 'EXCHANGE_CADREON' | 'EXCHANGE_DAILYMOTION' | 'EXCHANGE_FIVE' | 'EXCHANGE_FLUCT' | 'EXCHANGE_FREEWHEEL' | 'EXCHANGE_GENIEE' | 'EXCHANGE_GUMGUM' | 'EXCHANGE_IMOBILE' | 'EXCHANGE_IBILLBOARD' | 'EXCHANGE_IMPROVE_DIGITAL' | 'EXCHANGE_INDEX' | 'EXCHANGE_KARGO' | 'EXCHANGE_MICROAD' | 'EXCHANGE_MOPUB' | 'EXCHANGE_NEND' | 'EXCHANGE_ONE_BY_AOL_DISPLAY' | 'EXCHANGE_ONE_BY_AOL_MOBILE' | 'EXCHANGE_ONE_BY_AOL_VIDEO' | 'EXCHANGE_OOYALA' | 'EXCHANGE_OPENX' | 'EXCHANGE_PERMODO' | 'EXCHANGE_PLATFORMONE' | 'EXCHANGE_PLATFORMID' | 'EXCHANGE_PUBMATIC' | 'EXCHANGE_PULSEPOINT' | 'EXCHANGE_REVENUEMAX' | 'EXCHANGE_RUBICON' | 'EXCHANGE_SMARTCLIP' | 'EXCHANGE_SMARTRTB' | 'EXCHANGE_SMARTSTREAMTV' | 'EXCHANGE_SOVRN' | 'EXCHANGE_SPOTXCHANGE' | 'EXCHANGE_STROER' | 'EXCHANGE_TEADSTV' | 'EXCHANGE_TELARIA' | 'EXCHANGE_TVN' | 'EXCHANGE_UNITED' | 'EXCHANGE_YIELDLAB' | 'EXCHANGE_YIELDMO' | 'EXCHANGE_UNRULYX' | 'EXCHANGE_OPEN8' | 'EXCHANGE_TRITON' | 'EXCHANGE_TRIPLELIFT' | 'EXCHANGE_TABOOLA' | 'EXCHANGE_INMOBI' | 'EXCHANGE_SMAATO' | 'EXCHANGE_AJA' | 'EXCHANGE_SUPERSHIP' | 'EXCHANGE_NEXSTAR_DIGITAL' | 'EXCHANGE_WAZE' | 'EXCHANGE_SOUNDCAST' | 'EXCHANGE_SHARETHROUGH' | 'EXCHANGE_FYBER' | 'EXCHANGE_RED_FOR_PUBLISHERS' | 'EXCHANGE_MEDIANET' | 'EXCHANGE_TAPJOY' | 'EXCHANGE_VISTAR' | 'EXCHANGE_DAX' | 'EXCHANGE_JCD' | 'EXCHANGE_PLACE_EXCHANGE' | 'EXCHANGE_APPLOVIN' | 'EXCHANGE_CONNATIX' | 'EXCHANGE_RESET_DIGITAL' | 'EXCHANGE_HIVESTACK' | 'EXCHANGE_DRAX' | 'EXCHANGE_APPLOVIN_GBID' | 'EXCHANGE_FYBER_GBID' | 'EXCHANGE_UNITY_GBID' | 'EXCHANGE_CHARTBOOST_GBID' | 'EXCHANGE_ADMOST_GBID' | 'EXCHANGE_TOPON_GBID' | 'EXCHANGE_NETFLIX' | 'EXCHANGE_CORE' | 'EXCHANGE_COMMERCE_GRID' | 'EXCHANGE_SPOTIFY' | 'EXCHANGE_TUBI' | 'EXCHANGE_SNAP' | 'EXCHANGE_CADENT' | 'EXCHANGE_EXTE' — The exchange to which the inventory source belongs. - `inventorySourceProductType` 'INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED' | 'PREFERRED_DEAL' | 'PRIVATE_AUCTION' | 'PROGRAMMATIC_GUARANTEED' | 'TAG_GUARANTEED' | 'YOUTUBE_RESERVE' | 'INSTANT_RESERVE' | 'GUARANTEED_PACKAGE' | 'PROGRAMMATIC_TV' | 'AUCTION_PACKAGE' — Output only. The product type of the inventory source, denoting the way through which it sells inventory. - `status` InventorySourceStatus — The status related settings of the inventory source. - `entityPauseReason` string — The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`. - `sellerStatus` 'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION' — Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`. - `configStatus` 'INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED' | 'INVENTORY_SOURCE_CONFIG_STATUS_PENDING' | 'INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED' — Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. - `entityStatus` 'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION' — Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`. - `sellerPauseReason` string — Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`. - `creativeConfigs` CreativeConfig[] — The creative requirements of the inventory source. Not applicable for auction packages. - `creativeType` 'CREATIVE_TYPE_UNSPECIFIED' | 'CREATIVE_TYPE_STANDARD' | 'CREATIVE_TYPE_EXPANDABLE' | 'CREATIVE_TYPE_VIDEO' | 'CREATIVE_TYPE_NATIVE' | 'CREATIVE_TYPE_TEMPLATED_APP_INSTALL' | 'CREATIVE_TYPE_NATIVE_SITE_SQUARE' | 'CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL' | 'CREATIVE_TYPE_LIGHTBOX' | 'CREATIVE_TYPE_NATIVE_APP_INSTALL' | 'CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE' | 'CREATIVE_TYPE_AUDIO' | 'CREATIVE_TYPE_PUBLISHER_HOSTED' | 'CREATIVE_TYPE_NATIVE_VIDEO' | 'CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO' | 'CREATIVE_TYPE_ASSET_BASED_CREATIVE' — The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO` - `displayCreativeConfig` InventorySourceDisplayCreativeConfig — The configuration for display creatives. - `creativeSize` Dimensions — Dimensions. - `widthPixels` integer — The width in pixels. - `heightPixels` integer — The height in pixels. - `videoCreativeConfig` InventorySourceVideoCreativeConfig — The configuration for video creatives. - `duration` string, google-duration — The duration requirements for the video creatives that can be assigned to the inventory source. - `readAdvertiserIds` string[] — Output only. The IDs of advertisers with read-only access to the inventory source. - `inventorySourceType` 'INVENTORY_SOURCE_TYPE_UNSPECIFIED' | 'INVENTORY_SOURCE_TYPE_PRIVATE' | 'INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE' — Denotes the type of the inventory source. - `readPartnerIds` string[] — Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source. - `dealId` string — The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges. - `guaranteedOrderId` string — Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`. - `displayName` string — The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes. - `updateTime` string, google-datetime — Output only. The timestamp when the inventory source was last updated. Assigned by the system. - `deliveryMethod` 'INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED' | 'INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC' | 'INVENTORY_SOURCE_DELIVERY_METHOD_TAG' — The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. - `rateDetails` RateDetails — The rate related settings of the inventory source. - `rate` Money — Represents an amount of money with its currency type. - `currencyCode` string — The three-letter currency code defined in ISO 4217. - `units` string, int64 — The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - `nanos` integer — 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. - `minimumSpend` Money — Represents an amount of money with its currency type. - `currencyCode` string — The three-letter currency code defined in ISO 4217. - `units` string, int64 — The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - `nanos` integer — 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. - `inventorySourceRateType` 'INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED' | 'INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED' | 'INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR' | 'INVENTORY_SOURCE_RATE_TYPE_CPD' | 'INVENTORY_SOURCE_RATE_TYPE_CPH' | 'INVENTORY_SOURCE_RATE_TYPE_FLAT' — The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`. - `unitsPurchased` string, int64 — Required for guaranteed inventory sources. The number of impressions guaranteed by the seller. - `publisherName` string — The publisher/seller name of the inventory source. - `name` string — Output only. The resource name of the inventory source. - `commitment` 'INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED' | 'INVENTORY_SOURCE_COMMITMENT_GUARANTEED' | 'INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED' — Whether the inventory source has a guaranteed or non-guaranteed delivery. - `inventorySourceId` string, int64 — Output only. The unique ID of the inventory source. Assigned by the system. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/displayvideo.md) · [All operations](https://skmtc.net/google/apis/displayvideo/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/displayvideo/versions/68b64e49eced/schema)