REST Resource: package

  • A package resource represents a group of files delivered via web, SFTP, or other mechanisms, currently supporting the upload of a package with one metadata file or retrieving data about a previously uploaded package.

  • The package resource's JSON representation includes details like kind, uploaderName, content, locale, customIds, name, type, timeCreated, status, statusReports, and id, all providing comprehensive information about the package.

  • StatusReport objects contain information describing the source of a package status report, including statusContent and statusFileName, which are specifically used in Hybrid implementations.

  • Available methods for managing package resources are get, which retrieves information for a specific package, and insert, used to insert a metadata-only package.

Resource: Package

A package resource represents a group of files that is delivered via the web, SFTP, or another delivery mechanism. The API currently supports the ability to upload a package containing exactly one metadata file or to retrieve information about a previously uploaded package.

JSON representation 
{
  "kind": string,
  "uploaderName": string,
  "content": string,
  "locale": string,
  "customIds": [
    string
  ],
  "name": string,
  "type": string,
  "timeCreated": string,
  "status": string,
  "statusReports": [
    {
      object (StatusReport)
    }
  ],
  "id": string
}
Fields
kind

string

The type of the API resource. For package resources, this value is youtubePartner#package.
uploaderName

string

The uploader name.
content

string

The package's metadata file contents.
locale

string

The desired locale of the error messages as defined in BCP 47 (http: //tools.ietf.org/html/bcp47). For example, "en-US" or "de". If not specified we will return the error messages in English ("en").
customIds[]

string

The list of customer IDs.
name

string

The package name.
type

string

The package type. Acceptable values are:

  • Art Track - The package contains Art Track metadata and media.
  • Composition - The package contains composition metadata.
  • Movie - The package contains movie metadata and media.
  • Music Video - The package contains music video metadata and media.
  • Sound Recording - The package contains sound recording metadata.
  • TV Episode - The package contains television episode metadata and media.
  • Unknown media type - The package media type is unknown.
  • Web - The package contains web video metadata and media.
timeCreated

string

The package creation time. The value is specified in RFC 3339 (YYYY-MM-DDThh:mm:ss.000Z) format.
status

string

The package status. Acceptable values are:

  • Draft - The package metadata is being prepared.
  • Errors - The package failed validation or processing.
  • Processing - The package is currently being processed.
  • Successful - The package processed successfully.
  • Unknown status - The package status is unknown.
statusReports[]

object (StatusReport)

The package status reports.
id

string

An ID that YouTube assigns and uses to uniquely identify the package.

StatusReport

This object contains information that describes the source of the package status report.

JSON representation 
{
  "statusContent": string,
  "statusFileName": string
}
Fields
statusContent

string

The content of the report message. Used only in Hybrid.
statusFileName

string

Status file name. Used only in Hybrid.

Methods

get

 Retrieves information for the specified package.

insert

 Inserts a metadata-only package.