v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB
inventorySources

Updates an existing inventory source. Returns the updated inventory source if successful.

patch/v4/inventorySources/{+inventorySourceId}

Path parameters

inventorySourceIdstring required

Output only. The unique ID of the inventory source. Assigned by the system.

Query parameters

advertiserIdstring

The ID of the advertiser that the request is being made within.

partnerIdstring

The ID of the partner that the request is being made within.

updateMaskstring

Required. The mask to control which fields to update.

Request body

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.

readAdvertiserIdsstring[]

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.

readPartnerIdsstring[]

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.

dealIdstring

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.

guaranteedOrderIdstring

Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is INVENTORY_SOURCE_COMMITMENT_GUARANTEED.

displayNamestring

The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.

updateTimestring 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.

publisherNamestring

The publisher/seller name of the inventory source.

namestring

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.

inventorySourceIdstring int64

Output only. The unique ID of the inventory source. Assigned by the system.

Response

Successful response