Method: advertisers.sdfuploadtasks.upload

  • An SDF Upload Task is created by posting to the specified URI and is a long-running, asynchronous operation.

  • The advertiserId path parameter is required to identify the advertiser for which to upload SDF.

  • The request body requires a filename and the SDF version of the uploaded file.

  • A successful response returns an Operation instance which includes metadata about the task and can be retrieved using sdfuploadtask.operations.get.

  • The authorization scope https://www.googleapis.com/auth/display-video is required.

Creates an SDF Upload Task. Returns an Operation.

An SDF Upload Task is a long-running, asynchronous operation. The metadata type of this operation is SdfUploadTaskMetadata. If the request is successful, the response type of the operation is SdfUploadTask. The response will not include the resulting files, which can then be retrieved using media.download.

The state of operation can be retrieved with sdfuploadtask.operations.get.

Any errors can be found in the error.message. Note that error.details is expected to be empty.

HTTP request

  • Upload URI, for media upload requests:
    POST https://displayvideo.googleapis.com/upload/v4/advertisers/{advertiserId}/sdfuploadtasks
  • Metadata URI, for metadata-only requests:
    POST https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/sdfuploadtasks

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the advertiser to upload SDF for.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "filename": string,
  "sdfVersion": enum (SdfVersion)
}
Fields
filename

string

Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.
sdfVersion

enum (SdfVersion)

Required. The SDF version of the uploaded file. If set to SDF_VERSION_UNSPECIFIED, this will default to the version specified by the identified advertiser. An advertiser inherits its SDF version from its partner unless configured otherwise.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.