advertisers

Changed on

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: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete 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.

patch/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}

Request

  • Base URL: https://displayvideo.googleapis.com
  • URL: https://displayvideo.googleapis.com/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/display-video) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/display-video)

Path parameters

advertiserIdstring required

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

lineItemIdstring required

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

Query parameters

updateMaskstring

Required. The mask to control which fields to update.

Request body

advertiserIdstring int64

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

campaignIdstring int64

Output only. The unique ID of the campaign that the line item belongs to.

containsEuPoliticalAds'EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN' | 'CONTAINS_EU_POLITICAL_ADVERTISING' | 'DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING'

Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING in the parent advertiser, then this field will be assigned DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, the advertisers.lineItems.create request will fail.

creativeIdsstring[]

The IDs of the creatives associated with the line item.

displayNamestring

Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.

entityStatus'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION'

Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only ENTITY_STATUS_DRAFT is allowed. To activate a line item, use UpdateLineItem method and update the status to ENTITY_STATUS_ACTIVE after creation. * A line item cannot be changed back to ENTITY_STATUS_DRAFT status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is ENTITY_STATUS_ACTIVE.

excludeNewExchangesboolean

Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.

insertionOrderIdstring int64

Required. Immutable. The unique ID of the insertion order that the line item belongs to.

lineItemIdstring int64

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

lineItemType'LINE_ITEM_TYPE_UNSPECIFIED' | 'LINE_ITEM_TYPE_DISPLAY_DEFAULT' | 'LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL' | 'LINE_ITEM_TYPE_VIDEO_DEFAULT' | 'LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL' | 'LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY' | 'LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY' | 'LINE_ITEM_TYPE_AUDIO_DEFAULT' | 'LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY' | 'LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW' | 'LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME' | 'LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME' | 'LINE_ITEM_TYPE_DEMAND_GEN'

Required. Immutable. The type of the line item.

namestring

Output only. The resource name of the line item.

optimizeFixedBiddingboolean

Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to false, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a bidding_strategy of type FIXED_BID.

reservationType'RESERVATION_TYPE_UNSPECIFIED' | 'RESERVATION_TYPE_NOT_GUARANTEED' | 'RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED' | 'RESERVATION_TYPE_TAG_GUARANTEED' | 'RESERVATION_TYPE_PETRA_VIRAL' | 'RESERVATION_TYPE_INSTANT_RESERVE'

Output only. The reservation type of the line item.

updateTimestring google-datetime

Output only. The timestamp when the line item was last updated. Assigned by the system.

warningMessagesstring[]

Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.

Response

Successful response

Changes

  • 52cdb4885336Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

  • 0f73dc785c76Revision changes
    • warning

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the //// response property for the response status

    • warning

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the //// response property for the response status

    • warning

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the //// response property for the response status

    • warning

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the //// response property for the response status

    • warning

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the //// response property for the response status

    • warning

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the //// response property for the response status

    • warning

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the //// response property for the response status

    • warning

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the //// response property for the response status

    • info

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the request property ////

    • info

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the request property ////

    • info

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the request property ////

    • info

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the request property ////

    • info

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the request property ////

    • info

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the request property ////

    • info

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the request property ////

    • info

      added the new THIRD_PARTY_VENDOR_AQUILA enum value to the request property ////