REST Resource: networks.lineItems.creatives

Resource: LineItemCreativeAssociation

A LineItemCreativeAssociation associates a Creative or CreativeSet with a LineItem so that the creative can be served in ad units targeted by the line item.

JSON representation 
{
  "name": string,
  "sizes": [
    {
      object (Size)
    }
  ],
  "targetingDisplayName": string,
  "lineItem": string,
  "creative": string,
  "creativeSet": string,
  "status": enum (LineItemCreativeAssociationStatus),
  "startTime": string,
  "endTime": string,
  "destinationUrl": string,
  "manualCreativeRotationWeight": number,
  "sequentialCreativeRotationIndex": integer,
  "updateTime": string,
  "stats": {
    object (LineItemCreativeAssociationStats)
  }
}
Fields
name

string

Identifier. The resource name of the LineItemCreativeAssociation. Format: networks/{networkCode}/lineItems/{lineItemId}/creatives/{creativeId}
sizes[]

object (Size)

Optional. Overrides the value set for size of the creative, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size.
targetingDisplayName

string

Optional. Specifies creative targeting for this line item creative association. It should match the [targetingName][CreativePlaceholder.targeting_name] specified on the corresponding [creativePlaceholder][LineItem.creative_placeholder] on the lineItem.
lineItem

string

Required. Immutable. The LineItem to which the LineItemCreativeAssociation belongs.
creative

string

Optional. Immutable. The Creative to which the LineItemCreativeAssociation associated. Optional if creativeSet is set.
creativeSet

string

Optional. Immutable. The CreativeSet to which the LineItemCreativeAssociation associated. Optional if creative is set.
status

enum (LineItemCreativeAssociationStatus)

Output only. The status of the association.
startTime

string (Timestamp format)

Optional. Overrides the value set for startTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the startTime of the lineItem will be used.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Optional. Overrides endTime of the lineItem. This value is only valid for Ad Manager 360 networks. If unset, the endTime of the lineItem will be used.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
destinationUrl

string

Optional. Overrides the value set for [destinationUrl][Creative.destination_url] of the creative. This value is only valid for Ad Manager 360 networks.
manualCreativeRotationWeight

number

Optional. Non-empty default. The weight of the creative. This value is only used if the creativeRotationType of the lineItem is set to WEIGHTED. Defaults to 10.
sequentialCreativeRotationIndex

integer

Optional. Non-empty default. The sequential rotation index of the Creative. This value is used only if the lineItem's creativeRotationType is set to SEQUENTIAL. Defaults to 1.
updateTime

string (Timestamp format)

Output only. The date and time this association was last modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
stats

object (LineItemCreativeAssociationStats)

Output only. Contains trafficking statistics for the association.

LineItemCreativeAssociationStatus

Describes the status of the association.

Enums
LINE_ITEM_CREATIVE_ASSOCIATION_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE The association is active and the associated Creative can be served.
INACTIVE The association is inactive and the associated Creative is ineligible for being served.

LineItemCreativeAssociationStats

Contains statistics such as impressions, clicks delivered, and viewable impressions for a LineItemCreativeAssociation.

JSON representation 
{
  "creativeSetStats": {
    string: {
      object (CreativeStats)
    },
    ...
  },
  "impressionsDelivered": string,
  "clicksDelivered": string,
  "viewableImpressionsDelivered": string
}
Fields
creativeSetStats

map (key: string (int64 format), value: object (CreativeStats))

Output only. Creative set stats.
impressionsDelivered

string (int64 format)

Output only. The number of impressions delivered.
clicksDelivered

string (int64 format)

Output only. The number of clicks delivered.
viewableImpressionsDelivered

string (int64 format)

Output only. The number of viewable impressions delivered.

CreativeStats

Contains statistics such as impressions, clicks delivered, and viewable impressions for creatives belonging to a CreativeSet.

JSON representation 
{
  "impressionsDelivered": string,
  "clicksDelivered": string,
  "viewableImpressionsDelivered": string
}
Fields
impressionsDelivered

string (int64 format)

Output only. The number of impressions delivered.
clicksDelivered

string (int64 format)

Output only. The number of clicks delivered.
viewableImpressionsDelivered

string (int64 format)

Output only. The number of video completions delivered.

Methods

get

 Retrieves a LineItemCreativeAssociation object.

list

 Lists LineItemCreativeAssociation objects.