Method: sellers.adPlays.batchCreate

  • New ad plays can be created in batches with a maximum of 1000 per batch.

  • Successful batch creation returns the newly created ad plays.

  • The API uses a POST request to the specified endpoint for batch creation.

  • The request body includes a list of CreateAdPlayRequest objects containing the ad play details and parent seller name.

  • Authorization requires the https://www.googleapis.com/auth/doubleclickbidmanager OAuth scope.

Creates new ad plays in batch.

  • Max allowed number of ad plays in a batch is 1000.
  • Returns the newly created ad plays if successful.
  • Returns error code INVALID_ARGUMENT if invalid ad unit, order, line, or creative are specified.
  • Returns error code ALREADY_EXISTS if an ad play for the same ad unit, order, line, and creative with the same startTime already exists.
  • Returns error code NOT_FOUND if no matching ad unit, order, line, or creative asset found.
  • Returns error code FAILED_PRECONDITION if the request contains both resource name and external id.

HTTP request

POST https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/adPlays:batchCreate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The seller resource name. Format: sellers/{seller}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (CreateAdPlayRequest)
    }
  ]
}
Fields
requests[]

object (CreateAdPlayRequest)

Required. The ad plays to create.

Max allowed number of ad plays in a batch is 1000. Start time should be in the past and at most 3 days before creation date. End time should be in the past and after start time.

Response body

If successful, the response body contains data with the following structure:

Response for creating ad plays in batch.

JSON representation 
{
  "adPlays": [
    {
      object (AdPlay)
    }
  ]
}
Fields
adPlays[]

object (AdPlay)

The ad plays that were created.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/doubleclickbidmanager

For more information, see the OAuth 2.0 Overview.

CreateAdPlayRequest

Request message for AdPlayService.CreateAdPlay.

JSON representation 
{
  "parent": string,
  "adPlay": {
    object (AdPlay)
  }
}
Fields
parent

string

Required. The seller resource name. Format: sellers/{seller}
adPlay

object (AdPlay)

Required. The ad play to create.

Ad play name will be generated by the system and should not be set. Start time should be in the past and at most 3 days before creation date. End time should be in the past and after start time.