REST Resource: sellers.adPlays

  • An AdPlay resource represents a single instance of an ad playing.

  • The JSON representation of an AdPlay includes fields such as name, startTime, endTime, and impressionCount.

  • An AdPlay references associated resources like lines, ad units, and creative assets using either their resource name or external ID.

  • Methods for interacting with AdPlays include batchCreate and create for creating new ad plays.

Resource: AdPlay

A single ad play.

JSON representation 
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "impressionCount": number,

  // Union field line_reference can be only one of the following:
  "line": string,
  "lineExternalId": string
  // End of list of possible types for union field line_reference.

  // Union field ad_unit_reference can be only one of the following:
  "adUnit": string,
  "adUnitExternalId": string
  // End of list of possible types for union field ad_unit_reference.

  // Union field creative_asset_reference can be only one of the following:
  "creativeAsset": string,
  "creativeAssetExternalId": string
  // End of list of possible types for union field creative_asset_reference.
}
Fields
name

string

Output only. The resource name of the ad play in the format: sellers/{seller}/adPlays/{adPlay}.
startTime

string (Timestamp format)

Time the ad started to play.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Time the ad play ended.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
impressionCount

number

Total number of impressions. Impressions can be estimated and fractional values are supported.

Union field line_reference.

line_reference can be only one of the following:
line

string

The line this ad play belongs to. The order will be inferred from the line. Format: sellers/111/orders/123/lines/321.
lineExternalId

string

Input only. The external id of the line this ad play belongs to. The order will be inferred from the line. Format: 123.

Union field ad_unit_reference.

ad_unit_reference can be only one of the following:
adUnit

string

The ad unit this ad play was served on. Format: sellers/111/adUnits/123.
adUnitExternalId

string

Input only. The external id of the ad unit this ad play was served on. Format: 789.

Union field creative_asset_reference.

creative_asset_reference can be only one of the following:
creativeAsset

string

The creative asset this ad play served. Format: sellers/111/creativeAssets/123.
creativeAssetExternalId

string

Input only. The external id of the creative asset this ad play served. Format: 3210.

Methods

batchCreate

 Creates new ad plays in batch.

create

 Creates an ad play.