GoogleApi.ContentWarehouse.V1.Model.OceanVolumeImprint
Table of Contents ▼
Jump to a specific part of the page:
Description
Commercial information for a volume (data from the Imprint PublishersVolumeInfo table in the db). An imprint is a subdivision of a publisher (for example, Bantam Books is an imprint of Randon House), or can even be just a grouping of volumes with common commercial attributes.
Attributes List
This module has the following attributes (case-insensitive ascending order):
View Attributes
- accessRights
- adsId
- allowAddingFrontmatterToPreview
- allowContinuousBrowse
- allowRetailSyndication
- author
- bibkey
- buyTheBookText
- buyTheBookUrl
- canDownloadEpub
- canDownloadPdf
- canShowLibraryLinks
- canUseMetadataCover
- disableOtherBuyTheBookLinks
- displayDetails
- geBibkey
- imprintId
- imprintName
- imprintUrl
- logoHeight
- logoLocation
- logoWidth
- percentBookShown
- promotionalText
- promotionalUrl
- publishedImprintName
- pviRowid
- title
- useBibdata
- verticalType
Attributes
-
accessRights
(type:GoogleApi.ContentWarehouse.V1.Model.OceanVolumeAccessRights
, default:nil
)
- These capture "commercial" contract related access rights provided by partners for a volume. -
adsId
(type:String.t
, default:nil
)
- Id used in the google ads system -
allowAddingFrontmatterToPreview
(type:boolean()
, default:nil
)
- Are we allowed to add all the front matter to the preview in addition to the preview amount that is from percent_book_shown? -
allowContinuousBrowse
(type:boolean()
, default:nil
)
- By default, we allow continuous browse. PFE provides a means for partners to opt out entirely or just specific books. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. -
allowRetailSyndication
(type:boolean()
, default:nil
)
- By default, we allow retailer syndication. PFE provides a means for partner to opt out. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. -
bibkey
(type:String.t
, default:nil
)
- Commercial info comes with book identifiers like ISBN(or some bibkey), Title, Author. Passing these along as well with the commercials for better book identification/link up with rights. -
buyTheBookText
(type:String.t
, default:nil
)
- Text to display in the buy-the-book blurb -
buyTheBookUrl
(type:String.t
, default:nil
)
- ISBN/ISSN-parameterized URL to the imprint's site for buying a book. For ISBN-parameterized links, the ISBN value will be substituted in the cannonical 13-digit form. -
canDownloadEpub
(type:boolean()
, default:nil
)
- iff true volume is available as Google Edition. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. -
canDownloadPdf
(type:boolean()
, default:nil
)
- iff true and VIEW_TYPE=FULL_VIEW, then we will allow PDF download This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. -
canShowLibraryLinks
(type:boolean()
, default:nil
)
- Whether to show library links for the books in this imprint. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. -
canUseMetadataCover
(type:boolean()
, default:nil
)
- It should be OK to use metadata covers normally, but we allow publishers to explicitly disallow them. This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. -
disableOtherBuyTheBookLinks
(type:boolean()
, default:nil
)
- Whether to disable other btb links for the books in this imprint. Show only btb link from this partner and remove everything else. -
displayDetails
(type:GoogleApi.ContentWarehouse.V1.Model.OceanVolumeDisplayDetails
, default:nil
)
- Volume display specific attributes are kept in display_details This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. -
geBibkey
(type:String.t
, default:nil
)
- The ISBN supplied by publisher (or Google) for the Google Edition e-book. One day it should be an attribute of the tome cluster. -
imprintId
(type:String.t
, default:nil
)
- The imprint id from the ocean devel db for this imprint. -
imprintName
(type:String.t
, default:nil
)
- -
imprintUrl
(type:String.t
, default:nil
)
- URL to the imprint's website, to go to upon a click on the logo -
logoHeight
(type:integer()
, default:nil
)
- -
logoLocation
(type:String.t
, default:nil
)
- URL/location for the imprint's logo to display -
logoWidth
(type:integer()
, default:nil
)
- The logo image's geometry -
percentBookShown
(type:integer()
, default:nil
)
- Percentage of book we are allowed to display This will be deprecated once UpdateVolumesReqHandler returns VolumeViewability. -
promotionalText
(type:String.t
, default:nil
)
- -
promotionalUrl
(type:String.t
, default:nil
)
- We may allow imprints to run promotional campaigns. The following fields capture the blurb to display and the URL (ISBN-parameterized) link to provide. -
publishedImprintName
(type:String.t
, default:nil
)
- Sometimes the Publisher/Imprint Name the book is published under is different from the current name and we may have this information. -
pviRowid
(type:String.t
, default:nil
)
- Need a unique identifier for PFE records, using PVI ID -
title
(type:String.t
, default:nil
)
- -
useBibdata
(type:boolean()
, default:nil
)
- Some records are deactivated, suppressed or excluded; we still want to hear about them, but we aren't going to be using their bibdata -
verticalType
(type:String.t
, default:nil
)
-
Type
@type t() :: %GoogleApi.ContentWarehouse.V1.Model.OceanVolumeImprint{
accessRights: GoogleApi.ContentWarehouse.V1.Model.OceanVolumeAccessRights.t() | nil,
adsId: String.t() | nil,
allowAddingFrontmatterToPreview: boolean() | nil,
allowContinuousBrowse: boolean() | nil,
allowRetailSyndication: boolean() | nil,
author: String.t() | nil,
bibkey: String.t() | nil,
buyTheBookText: String.t() | nil,
buyTheBookUrl: String.t() | nil,
canDownloadEpub: boolean() | nil,
canDownloadPdf: boolean() | nil,
canShowLibraryLinks: boolean() | nil,
canUseMetadataCover: boolean() | nil,
disableOtherBuyTheBookLinks: boolean() | nil,
displayDetails: GoogleApi.ContentWarehouse.V1.Model.OceanVolumeDisplayDetails.t() | nil,
geBibkey: String.t() | nil,
imprintId: String.t() | nil,
imprintName: String.t() | nil,
imprintUrl: String.t() | nil,
logoHeight: integer() | nil,
logoLocation: String.t() | nil,
logoWidth: integer() | nil,
percentBookShown: integer() | nil,
promotionalText: String.t() | nil,
promotionalUrl: String.t() | nil,
publishedImprintName: String.t() | nil,
pviRowid: String.t() | nil,
title: String.t() | nil,
useBibdata: boolean() | nil,
verticalType: String.t() | nil
}
accessRights: GoogleApi.ContentWarehouse.V1.Model.OceanVolumeAccessRights.t() | nil,
adsId: String.t() | nil,
allowAddingFrontmatterToPreview: boolean() | nil,
allowContinuousBrowse: boolean() | nil,
allowRetailSyndication: boolean() | nil,
author: String.t() | nil,
bibkey: String.t() | nil,
buyTheBookText: String.t() | nil,
buyTheBookUrl: String.t() | nil,
canDownloadEpub: boolean() | nil,
canDownloadPdf: boolean() | nil,
canShowLibraryLinks: boolean() | nil,
canUseMetadataCover: boolean() | nil,
disableOtherBuyTheBookLinks: boolean() | nil,
displayDetails: GoogleApi.ContentWarehouse.V1.Model.OceanVolumeDisplayDetails.t() | nil,
geBibkey: String.t() | nil,
imprintId: String.t() | nil,
imprintName: String.t() | nil,
imprintUrl: String.t() | nil,
logoHeight: integer() | nil,
logoLocation: String.t() | nil,
logoWidth: integer() | nil,
percentBookShown: integer() | nil,
promotionalText: String.t() | nil,
promotionalUrl: String.t() | nil,
publishedImprintName: String.t() | nil,
pviRowid: String.t() | nil,
title: String.t() | nil,
useBibdata: boolean() | nil,
verticalType: String.t() | nil
}
Function
@spec decode(struct(), keyword()) :: struct()Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.OceanVolumeImprint