Method: advertisers.lineItems.patch

  • This method updates an existing line item and returns the updated item upon success.

  • Certain concurrent requests that also update the line item are restricted.

  • YouTube & Partners line items are not supported for creation or updates via the API.

  • This method may experience high latency, so increasing your default timeout is recommended.

  • The endpoint requires authorization with the https://www.googleapis.com/auth/display-video scope.

Updates an existing line item. Returns the updated line item if successful.

Requests to this endpoint cannot be made concurrently with the following requests updating the same line item:

YouTube & Partners line items cannot be created or updated using the API.

This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

HTTP request

PATCH https://displayvideo.googleapis.com/v2/advertisers/{lineItem.advertiserId}/lineItems/{lineItem.lineItemId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
lineItem.advertiserId

string (int64 format)

Output only. The unique ID of the advertiser the line item belongs to.
lineItem.lineItemId

string (int64 format)

Output only. The unique ID of the line item. Assigned by the system.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The mask to control which fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of LineItem.

Response body

If successful, the response body contains an instance of LineItem.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.