add

Builds creatives for video extensions based on the video ID received from AdVideos.

  1. Restrictions
  2. Request
  3. Response

Restrictions

Maximum of 10 videos per method call.

Request

Request structure in JSON format:

    "params" : { /* required */
        "Creatives" : [{ /* required */
            "VideoExtensionCreative" : { /* required */
                "VideoId" : (string) /* required */
            }
        }, ... ]
    }
Parameter Type Description Required
Result structure (for JSON) / AddResponse structure (for SOAP)
Creatives array of CreativeAddItem Creatives to add (a maximum of 10). Yes
CreativeAddItem structure
VideoExtensionCreative array of VideoExtensionCreativeAddItem Settings of a creative for video extensions. Yes
VideoExtensionCreativeAddItem structure
VideoId string ID of the video. Yes
Parameter Type Description Required
Result structure (for JSON) / AddResponse structure (for SOAP)
Creatives array of CreativeAddItem Creatives to add (a maximum of 10). Yes
CreativeAddItem structure
VideoExtensionCreative array of VideoExtensionCreativeAddItem Settings of a creative for video extensions. Yes
VideoExtensionCreativeAddItem structure
VideoId string ID of the video. Yes

Response

Response structure in JSON format:

{
  "result" : { /* required */
        "AddResults" : [{
            "Warnings" : [{
                "Code" : (integer) /* required */,
                "Message" : (string) /* required */,
                "Details" : (string)
            }, ... ],
            "Errors" : [{
                "Code" : (integer) /* required */,
                "Message" : (string) /* required */,
                "Details" : (string)
            }, ... ],
            "Id" : (long)
        }, ... ]
    }
}
Parameter Type Description
Result structure (for JSON) / AddResponse structure (for SOAP)
AddResults array Results of adding creatives.
AddResults structure
Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification Array of errors that occured when adding videos to the upload queue.
Id long The ID of the newly built creative. Returned if there aren't any errors. See the section Operations on object arrays.
Warnings, Errors structure
Code int

Error code.

Message string Textual message about the error.
Details string

Detailed description of the reason for the error.

Parameter Type Description
Result structure (for JSON) / AddResponse structure (for SOAP)
AddResults array Results of adding creatives.
AddResults structure
Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification Array of errors that occured when adding videos to the upload queue.
Id long The ID of the newly built creative. Returned if there aren't any errors. See the section Operations on object arrays.
Warnings, Errors structure
Code int

Error code.

Message string Textual message about the error.
Details string

Detailed description of the reason for the error.