Method: advertisers.lineItems.patch

  • Display & Video 360 API v1 has been sunset.

  • This endpoint updates an existing line item and returns the updated line item if successful.

  • Concurrent requests to update the same line item using this endpoint along with lineItems.bulkEditLineItemAssignedTargetingOptions, lineItems.patch, assignedTargetingOptions.create, or assignedTargetingOptions.delete are not allowed.

  • The update is made using a PATCH HTTP request with specific path parameters for the advertiser and line item IDs, and a query parameter updateMask to specify which fields to update.

  • The request body contains an instance of the LineItem object, and a successful response body also contains an instance of the LineItem object.

  • This API call requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

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:

HTTP request

PATCH https://displayvideo.googleapis.com/v1/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.