Updates an existing guaranteed order. Returns the updated guaranteed order if successful.


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> guaranteed-orders patch ...

Required Scalar Argument

  • <guaranteed-order-id> (string)
    • Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacy_guaranteed_order_id}.

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:

  default-advertiser-id: string
  default-campaign-id: string
  display-name: string
  exchange: string
  guaranteed-order-id: string
  legacy-guaranteed-order-id: string
  name: string
  publisher-name: string
  read-access-inherited: boolean
  read-advertiser-ids: [string]
  read-write-advertiser-id: string
  read-write-partner-id: string
    config-status: string
    entity-pause-reason: string
    entity-status: 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 . default-advertiser-id=stet
    • Output only. The ID of default advertiser of the guaranteed order. The default advertiser is either the read_write_advertiser_id or, if that is not set, the first advertiser listed in read_advertiser_ids. Otherwise, there is no default advertiser.
  • default-campaign-id=dolor
    • The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser.
  • display-name=sadipscing
    • Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
  • exchange=duo
    • Required. Immutable. The exchange where the guaranteed order originated.
  • guaranteed-order-id=at
    • Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacy_guaranteed_order_id}.
  • legacy-guaranteed-order-id=accusam
    • Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.
  • name=no
    • Output only. The resource name of the guaranteed order.
  • publisher-name=tempor
    • Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.
  • read-access-inherited=false
    • Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.
  • read-advertiser-ids=ea
    • The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.
    • Each invocation of this argument appends the given value to the array.
  • read-write-advertiser-id=erat
    • The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.
  • read-write-partner-id=accusam
    • The partner with read/write access to the guaranteed order.
  • status config-status=magna
    • Output only. The configuration status of the guaranteed order. Acceptable values are PENDING and COMPLETED. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.
  • entity-pause-reason=ipsum
    • The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to ENTITY_STATUS_PAUSED.
  • entity-status=gubergren

    • Whether or not the guaranteed order is servable. Acceptable values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, and ENTITY_STATUS_PAUSED. Default value is ENTITY_STATUS_ACTIVE.
  • .. update-time=kasd

    • Output only. The timestamp when the guaranteed order 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").