Reading status reports
The features described in this article are available only to partners who use YouTube’s Content Manager to manage their copyrighted content.
After processing a feed, YouTube posts an XML status report that identifies the actions that YouTube performed when processing the feed and indicates whether each action was processed successfully.
The <Feed> tag is the root element in a status report. Its subtags identify the feed uploader, the time that YouTube posted the status report, the original XML feed associated with the report, and a unique ID that YouTube uses to identify the attempt to process that feed. It also contains one <action> tag for each action performed in the feed.
The table below identifies the different actions identified in a status report and also lists the information that the status report returns for each action. You can see a sample status report. The Action name column values correspond to values of the <action> tag’s name attribute. Note that some child elements may not be present if an action fails, whie the <status_detail> may only be present if the action fails.
| Action name | Child actions | Description | Child elements |
|---|---|---|---|
| Parse | This action indicates whether the feed parsed correctly. If a feed cannot be parsed, then none of the actions requested in the feed will be completed. If a feed can be parsed but contains non-fatal errors, such as the inclusion of an XML tag that is ignored for a particular asset, this action will be reported with a Success status, and the non-fatal errors will be reported within the Report erroraction. Note that if your XML feed sets the <feed> tag’s strictattribute to True, then any parser error will be treated as a fatal error. | <status> <status_detail>? <timestamp> |
|
| Process asset | Set metadata Set ownership Set rights policy |
An asset has been inserted or updated. Its child actions identify specific changes to the asset. | <command> <id> <in_file> <status> <status_detail>? <timestamp> <action>* |
| Set metadata | YouTube has set the asset metadata to match the values in the feed. | <status> <status_detail>? <timestamp> |
|
| Set ownership | YouTube has set the asset’sownership data to match the values in the feed. For this action, the <in_file> tag value contains an XPath that identifies the ownership rules associated with the asset. | <in_file> <status> <status_detail>? <timestamp> |
|
| Set rights owner | YouTube has set the composition asset’s owner to the publisher specified in the feed. A status report will contain one Set rights owner action for each owner of type publisher listed in the feed. For example, if three publishers share ownership of a composition, then the status report will contain three Set rights owner actions. | <status> <status_detail>? <timestamp> |
|
| Set rights policy | YouTube has set the match policy for the asset. YouTube will apply the match policy to user-uploaded videos that match the asset. For this action, the <in_file> tag value contains an XPath that identifies the policy. Note that a Set rights policy action is also reported when YouTube processes a claim, and during that process flow, the policy that is set is a usage policy. | <policy> <status> <status_detail>? <timestamp> |
|
| Process file | Submit reference Submit video Submit AudioSwap track Submit image Submit Timed Text |
A file has been uploaded to YouTube. The child actions explain how the file is being used. For example, it could be used to create a reference (for an audio or video file), to set a custom thumbnail image for a video (for an image file), or to provide captions (timed text) for a video. An audio file might also be included in AudioSwap. | <filename> <in_file> <status> <status_detail>? <timestamp> <action>* |
| Submit reference | The file has been associated with an asset to create a reference. The <id> tags reported for this action will specify the reference ID of the new reference as well as the asset ID of the associated asset. If the reference is also being associated with a video, then this action will also contain an <id> tag that provides the video ID of that video. | <command> <id>* <status> <status_detail>? <timestamp> |
|
| Submit video | A new YouTube video has been created using the content of the file. The <id> tag reported for this action will specify the video ID that YouTube assigned to uniquely identify the new video. | <command> <id> <status> <status_detail>? <timestamp> |
|
| Submit AudioSwap track | The sound recording file has been included in YouTube’s AudioSwapprogram. | <status> <status_detail>? <timestamp> |
|
| Submit image | You have associated an image with a particular video. The <artwork> tag identifies the different types of images that you can associate with a video. Or you have set the custom thumbnail image for a video. | <status> <status_detail>? <timestamp> |
|
| Submit Timed Text | You have added a caption track to the video. | <command> <status> <status_detail>? <timestamp> |
|
| Process claim | Set rights policy Claim video |
YouTube has attempted to claim a video for your account and set a policy for that claim. If successful, this action will contain <id> tags that identify the video being claimed and the asset ID that matches the claimed video. | <command> <id> <status> <status_detail>? <timestamp> <action>* |
| Set rights policy | YouTube has attempted to set the usage policy for your video. A usage policy instructs YouTube on how to handle a video that you have uploaded.Note that a Set rights policy action is also reported when YouTube processes an asset, and during that process flow, the policy that is set is a match policy. | <policy> <status> <status_detail>? <timestamp> |
|
| Claim video | YouTube has claimed your uploaded video. The <in_file> tag specifies an XPath value that identifies that video in your XML feed. | <status> <status_detail>? <timestamp> |
|
| Update video | YouTube has attempted to update a video’s metadata. The <id> tag reported for this action will specify the video ID that YouTube uses to uniquely identify the video, and the <in_file> tag contains an XPath that identifies that video in your XML feed. | <command> <id> <status> <status_detail>? <timestamp> |
|
| Update reference | YouTube has attempted to activate, deactivate, or delete a reference. The <id> tag reported for this action will specify the reference ID that YouTube uses to identify the reference, and the <in_file> tag contains an XPath that identifies the reference in your XML feed. If you successfully activate or deactivate the reference, the value of the <command> tag will be Update, and the value of the <command_detail> tag will be either Activate or Deactivate. If you successfully delete the reference, then the value of the <command> tag will be Delete. | <command> <command_detail>? <id> <status> <status_detail>? <timestamp> |
|
| Set asset relationship | YouTube has attempted to associate two assets by indicating that one asset contains the other. For this action, the <in_file> tag will identify the relationship that associates the two assets in your feed. | <in_file> <status> <status_detail>? <timestamp> |
|
| Set playlist | YouTube has created, updated, or deleted a playlist based on instructions in your feed. The <id> tag reported for this action will specify the playlist ID that YouTube uses to uniquely identify the playlist, and the <in_file> tag contains an XPath that identifies the playlist in your XML feed. | <command> <id> <in_file> <status> <status_detail>? <timestamp> |
|
| Report error | Your feed contained one or more non-fatal errors. A non-fatal error is essentially ignored by the parser. For example, a non-fatal error would occur if you included an unexpected metadata tag for an asset and did not set the strictattribute to true for your feed. In this case, YouTube would just ignore the unexpected tag. | <status> <status_detail>? <timestamp> |
Sample status report
The features described in this article are available only to partners who use YouTube’s Content Manager to manage their copyrighted content.
The XML below shows a sample status report for a feed that creates an asset and sets its metadata, ownership, and match policy. The feed also uploads a video file and associates it with the asset to create a reference. Finally, it associates the file with video metadata, which was also included in the feed, to create a YouTube video, and claims the YouTube video.
<Feed version="2"> <uploader_name>PartnerFoo</uploader_name> <timestamp>2010-06-31T20:12:36</timestamp> <upload_control_id>Fx1BalvV991</upload_control_id> <filename>2010-07-10-USXYZ0518151.xml</filename> <action name="Parse"> <status>Success</status> <timestamp>2010-06-24T19:16:35</timestamp> </action> <action name="Process asset"> <command>Insert</command> <id type="Asset ID">f05zKsLbbc4</id> <in_file>/feed/asset[1]</in_file> <status>Success</status> <timestamp>2010-06-31T19:59:36</timestamp> <action name="Set metadata"> <status>Success</status> <timestamp>2010-06-31T20:03:36</timestamp> </action> <action name="Set ownership"> <in_file>/feed/ownership[1]</in_file> <status>Success</status> <timestamp>2010-06-31T20:04:36</timestamp> </action> <action name="Set rights policy"> <in_file>/feed/relationship[1]</in_file> <policy> <name>Monetize US CA</name> </policy> <status>Success</status> <timestamp>2010-06-31T20:04:36</timestamp> </action> </action> <action name="Process file"> <filename>USXYZ0518151.mp4</filename> <in_file>/feed/file[1]</in_file> <status>Success</status> <timestamp>2010-06-31T20:09:36</timestamp> <action name="Submit reference"> <command>Insert</command> <id type="Reference ID">uhz1568-V8_</id> <id type="Video ID">B26F-Tw70Kx</id> <id type="Asset ID">f05zKsLbbc4</id> <status>Success</status> <timestamp>2010-06-31T20:10:36</timestamp> </action> <action name="Submit video"> <command>Insert</command> <id type="Video ID">B26F-Tw70Kx</id> <status>Success</status> <status_detail>Live!</status_detail> <timestamp>2010-06-31T20:11:36</timestamp> </action> </action> <action name="Process claim"> <command>Insert</command> <id type="Video ID">B26F-Tw70Kx</id> <in_file>/feed/video[1]</in_file> <status>Success</status> <timestamp>2010-06-31T20:06:36</timestamp> <action name="Set rights policy"> <id type="Asset ID">f05zKsLbbc4</id> <policy> <name>Monetize everywhere</name> </policy> <status>Success</status> <timestamp>2010-06-31T20:04:36</timestamp> </action> <action name="Claim video"> <status>Success</status> <timestamp>2010-06-31T20:08:36</timestamp> </action> </action> </Feed>
For more information on Multi Channel Network’s and YouTube how to videos please check back weekly or subscribe here.
