Google Apps Platform

Listing Manifest

Note: There's a new Google Apps Marketplace experience! Beginning November 19, 2013, new listings may only be created using the new version: existing developers may need to create a new Chrome Web Store account to publish new listings. Refer to the new documentation for more information.

This document explains how to create a listing manifest for a Google Apps Marketplace application. Create a listing manifest to register your Google Checkout merchant account with the Google Apps Marketplace and, optionally, to specify which payment choices will appear in the Marketplace listing. Each choice appears as a radio button below the Add It Now button.

The listing manifest is used while creating a listing.

Warning: This is a developer preview of the billing and licensing features of the Google Apps Marketplace. Use of this API is not required for participation in the Google Apps Marketplace at this time. These APIs will change.

Contents

Audience

This document is intended for programmers who are listing applications in the Google Apps Marketplace. It provides an overview of the listing manifest XML syntax and examples.

Example

The listing manifest consists of a single <ListingManifest> tag that contains:

  • One or more <SubListing> tags that specify the pricing levels you want to offer
  • A <Merchant> tag that specifies the Google Checkout sandbox account you will use to accept payments

The following is an example listing manifest that describes a free listing with 5 seats and a paid listing.

<!-- LISTING MANIFEST
     Configures pricing levels and Checkout account. -->
<ListingManifest>
  <SubListings>
    <!-- SUBLISTING
         Configures a pricing level. Add one <SubListing> tag for each
         pricing option. Pricing options do not always map 1:1 to editions.
         editionId - use only when <PaymentModel> is FREE. Use a value from
         the id attribute of an <Edition> tag in the application manifest.
         <PaymentModel> - FREE or PAID.
         <SeatCount> - Optional. Use only if <PaymentModel> is FREE. Specify how many
           user licenses are included if the buyer chooses this sublisting.
           For PAID editions, use seatCount in the shopping cart instead.
         <PurchaseUrl> - URL of your shopping web page. Use only when
           PaymentModel is PAID. &edition= is optional and is used to alert
           your shopping page as to what sort of purchase is being requested. 
    -->
    <SubListing>
      <DisplayName>Free edition</DisplayName>
      <EditionId>free</EditionId>
      <PaymentModel>FREE</PaymentModel>
      <SeatCount>5</SeatCount>
      <PurchaseUrl>http://example.com/purchase?edition=free</PurchaseUrl>
    </SubListing>
    <SubListing>
      <DisplayName>Pro edition</DisplayName>
      <PaymentModel>PAID</PaymentModel>
      <PurchaseUrl>http://example.com/purchase?edition=pro</PurchaseUrl>
    </SubListing>
  </SubListings>
  <Merchants>
    <!-- MERCHANT
         Configures a Google Checkout account.
         currency - an ISO 4217 currency code (currently supports only USD)
         email - the email address associated with the sandbox Checkout account
         you set up in the previous step. 
    -->
    <Merchant>
      <CurrencyCode>USD</CurrencyCode>
      <MerchantEmailAddress>vendor@example.com</MerchantEmailAddress>
    </Merchant>
  </Merchants>
</ListingManifest>

XML Tag Definitions

This section contains definitions for the XML tags used in the application manifest.

CurrencyCode
Definition

The <CurrencyCode> tag defines what currency is accepted by the merchant account. Currently USD is the only accepted value.

Example <CurrencyCode>USD</CurrencyCode>
Subtag of Merchant
Content Format String
DisplayName
Definition

The <DisplayName> tag defines the name of the sublisting as it will appear in the Marketplace "Add it now" section.

Example <DisplayName>Pro Edition $50/year</DisplayName>
Subtag of SubListing
Content Format String
EditionId
Definition

The <EditionId> tag defines the edition ID corresponding to the sublisting. This tag should be used only for FREE sublistings.

Example <EditionId>free</EditionId>
Subtag of SubListing
Content Format String
ListingManifest
Definition

The <ListingManifest> tag encapsulates the listing manifest definition.

Example <ListingManifest>
Subtags SubListings, Merchants
Content Format Container
Merchant
Definition

The <Merchant> tag encapsulates a single Merchant definition, including the currency supported for the vendor account and the vendor's email address.

Example <Merchant>
Subtag of Merchants
Subtags CurrencyCode, MerchantEmailAddress
Content Format Container
MerchantEmailAddress
Definition

The <MerchantEmailAddress> tag defines the email address of the merchant. This is the email address of the account registered with Google Checkout.

Example <MerchantEmailAddress>vendor@example.com</MerchantEmailAddress>
Subtag of Merchant
Content Format String
Merchants
Definition

The <Merchants> tag encapsulates one or more Merchant definitions.

Example <Merchants>
Subtags Merchant
Content Format Container
PaymentModel
Definition

The <PaymentModel> tag defines whether or not the sublisting requires payment. Acceptable values are FREE and PAID.

Example <PaymentModel>PAID</PaymentModel>
Subtag of SubListing
Content Format String
PurchaseUrl
Definition

The <PurchaseUrl> tag defines the URL where customers will be redirected to configure their purchase.

Example <PurchaseUrl>http://example.com/purchase?edition=pro</PurchaseUrl>
Subtag of SubListing
Content Format String
SeatCount
Definition

The <SeatCount> tag defines the number of seats included with the sublisting. This tag should be used only for FREE sublistings.

Example <SeatCount>5</SeatCount>
Subtag of SubListing
Content Format String
SubListing
Definition

The <SubListing> tag encapsulates a single SubListing definition, including the name of the listing, whether the listing is paid or free, the number of seats and where the URL where the purchase may be completed.

Example <SubListing>
Subtag of SubListings
Subtags DisplayName, EditionId, PaymentModel, SeatCount, PurchaseUrl
Content Format Container
SubListings
Definition

The <SubListings> tag encapsulates one or more SubListing definitions.

Example <SubListings>
Subtags SubListing
Content Format Container

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.