Booklet Metadata Annotations

<booklet>

Booklet (required if delivering a booklet)

Identifies a booklet within the metadata. Any number of booklets may be included in a package and in any order among the tracks.

<vendor_id>

Booklet Vendor Identifier (required)

A unique and unchanging identifier for this booklet. Only has to be unique with respect to the vendor identifiers of any other booklets included in the same package.

Important: Vendor identifiers can only contain alphanumeric characters and the underscore mark; they cannot contain spaces, other punctuation or symbols, and must not start with an underscore. The vendor identifier is case- sensitive.

<title>Digital Booklet - Dracula</title>

Booklet Title (required)

The title of the booklet, as it should appear on Apple Books.

The naming convention for PDF booklets is "Digital Booklet - Audiobook name"

For single-byte characters (such as those drawn from the ASCII character set), there is a limit of 256 characters for album titles. For multiple-byte characters (for example, Japanese), the limit is 1024 bytes, which can equate to as many as 256 characters.

<copyright>2008 Apple Publishing Group</copyright>

Booklet Copyright (required)

The copyright of the booklet, as it should appear on Apple Books.

<track_number>2</track_number>

Booklet Track Number (required)

The track number identifies the order in which the booklet appears. A booklet can be any track in the audiobook.

The booklet track number must be numbered sequentially over the entire audiobook, which means that the booklet starts with whatever the next track number would have been on the audiobook. The audiobook in this example has one track audio file; the track number for the booklet is 2.

<explicit_content>none</explicit_content>

Booklet Parental Advisory (optional; can be updated)

Denotes whether or not a booklet contains explicit content. May be clean, explicit, or none. If omitted, none (that is, a booklet for which neither a clean or explicit version exists) is assumed.

Important: A booklet must only be marked clean if it is an edited version of the original explicit form of the booklet.

<artists>

  <artist>

    <artist_name>Bram Stoker</artist_name>

    <apple_id>2683478</apple_id>

    <roles>

      <role>Author</role>

    </roles>

    <primary>true</primary>

  </artist>

    <artist_name>Christopher Saul</artist_name>

    <apple_id>301336965</apple_id>

    <roles>

      <role>Narrator</role>

    </roles>

    <primary>false</primary>

  </artist>

</artists>

Booklet Artists (required)

Name, primary status, and roles for each artist. In this context, "artist" may be any contributor including the book author or narrator. Individual artists, such as co-authors, should be listed separately and not grouped together (for example, "Walter Isaacson", "Dylan Baker" should each have their own <artist> block instead of "Walter Isaacson and Dylan Baker" listed in one <artist> block).

Artist

You can refer to the artist by Apple identifier (using the <apple_id> tag) or by name (using the <artist_name> tag). Apple assigns every artist a unique Apple identifier; Apple recommends that artists be delivered with the Apple identifier to avoid the ambiguity in cases where audiobook artists share the same name as other authors, music artists, actors, or crew members. You can supply the <apple_id>, the <artist_name>, or both the <apple_id> and <artist_name>. If you supply both tags, the <artist_name> tag is ignored in favor of the Apple identifier. If you do not know the audiobook artist's Apple identifier, you can do a metadata lookup on an existing audiobook and look for the <apple_id> tag. For any subsequent updates, you can use the <apple_id> tag instead of or in addition to the name, to avoid ambiguity.

For single-byte characters (such as those drawn from the ASCII character set), there is a limit of 256 characters for artist names. For multiple-byte characters (for example, Japanese), the limit is 1024 bytes, which can equate to as many as 256 characters.

Role

The following roles are required for booklets:

• Author

• Narrator

Other roles may be provided if appropriate. See Contributor Roles for a complete list of accepted roles.

Apple strongly recommends that you list the authors before the narrators in the metadata.

The role names must be in English in order to be imported. But the names are localized if needed when displayed on Apple Books.

Primary Status

Primary status indicates whether the booklet appears on the artist’s page in Apple Books. Typically, there are one or two primary (lead) artists (such as the author or co-authors). For booklets without an author (for example, a booklet that has an editor or translator instead of an author), the primary status should be set to true (<primary>true</primary>) for that contributor.

Artist names appear in the order in which they are specified in the provided metadata.

<file>

  <file_name>booklet.pdf</file_name>

  <size>7243623</size>

  <checksum type="md5">ddfe4b8ab433e43e7dde429df86cabb2</checksum>

</file>

Booklet File (optional; can be updated)

Information identifying the file within the package that contains the actual booklet asset (downloadable file).

This tag and all sub-tags are optional as it is permitted to initially deliver the booklet metadata and then deliver the asset in a subsequent package update.

When the <file> element is present, the <file_name>, <size>, and <checksum> tags are required. See the annotations in Basic Audiobook Metadata Annotated for details of their contents.

</booklet>