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

Scopes

You will need authorization for the https://www.googleapis.com/auth/display-video scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/display-video. You can set the scope for this method like this: displayvideo1 --scope <scope> inventory-sources patch ...

Required Scalar Argument

• <inventory-source-id> (string)
  • Output only. The unique ID of the inventory source. Assigned by the system.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

InventorySource:
  commitment: string
  deal-id: string
  delivery-method: string
  display-name: string
  exchange: string
  guaranteed-order-id: string
  inventory-source-id: string
  inventory-source-product-type: string
  inventory-source-type: string
  name: string
  publisher-name: string
  rate-details:
    inventory-source-rate-type: string
    minimum-spend:
      currency-code: string
      nanos: integer
      units: string
    rate:
      currency-code: string
      nanos: integer
      units: string
    units-purchased: string
  read-advertiser-ids: [string]
  read-partner-ids: [string]
  read-write-accessors:
    advertisers:
      advertiser-ids: [string]
    partner:
      partner-id: string
  status:
    config-status: string
    entity-pause-reason: string
    entity-status: string
    seller-pause-reason: string
    seller-status: string
  time-range:
    end-time: string
    start-time: string
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . commitment=justo
  • Whether the inventory source has a guaranteed or non-guaranteed delivery.
• deal-id=clita
  • 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.
• delivery-method=stet
  • 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.
• display-name=sea
  • The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.
• exchange=sit
  • The exchange to which the inventory source belongs.
• guaranteed-order-id=sed
  • Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
• inventory-source-id=et
  • Output only. The unique ID of the inventory source. Assigned by the system.
• inventory-source-product-type=no
  • Output only. The product type of the inventory source, denoting the way through which it sells inventory.
• inventory-source-type=sit
  • Denotes the type of the inventory source.
• name=labore
  • Output only. The resource name of the inventory source.
• publisher-name=sea
  • The publisher/seller name of the inventory source.
• rate-details inventory-source-rate-type=sea
  • The rate type. Acceptable values are INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR, and INVENTORY_SOURCE_RATE_TYPE_CPD.
• minimum-spend currency-code=sadipscing
  • The three-letter currency code defined in ISO 4217.
• nanos=80
  • 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.

• units=aliquyam

  • The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

• ..rate currency-code=eirmod

  • The three-letter currency code defined in ISO 4217.
• nanos=81
  • 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.

• units=labore

  • The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

• .. units-purchased=eos

  • Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.

• .. read-advertiser-ids=invidunt

  • Output only. The IDs of advertisers with read-only access to the inventory source.
  • Each invocation of this argument appends the given value to the array.
• read-partner-ids=at
  • 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.
  • Each invocation of this argument appends the given value to the array.

• read-write-accessors.advertisers advertiser-ids=sea

  • The IDs of the advertisers.
  • Each invocation of this argument appends the given value to the array.

• ..partner partner-id=sed

  • The ID of the partner.

• ...status config-status=dolor

  • 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.
• entity-pause-reason=dolor
  • 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.
• entity-status=sed
  • 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.
• seller-pause-reason=et
  • 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.

• seller-status=et

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

• ..time-range end-time=duo

  • Required. The upper bound of a time range, inclusive.

• start-time=dolor

  • Required. The lower bound of a time range, inclusive.

• .. update-time=voluptua.

  • Output only. The timestamp when the inventory source was last updated. Assigned by the system.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p advertiser-id=string

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

• -p partner-id=string

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

• -p update-mask=string

  • Required. The mask to control which fields to update.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").