Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Checklist for submitting Office and SharePoint Add-ins and Office 365 web apps to the Seller Dashboard

Office and SharePoint Add-ins

Prepare to add and submit Office and SharePoint Add-ins and Office 365 web apps using Azure AD to the Seller Dashboard for approval and inclusion in the Office Store.

Last modified: July 21, 2015

Applies to: apps for Office | apps for Office Mix | apps for SharePoint | Office 365 | Office Add-ins | SharePoint Add-ins

Note Note

The names "apps for Office" and "apps for SharePoint" are changing to "Office Add-ins" and "SharePoint Add-ins". During the transition, the documentation and the UI of some Office and SharePoint products and Visual Studio tools might still use the terms "apps for Office" and "apps for SharePoint". For details, see New name for apps for Office and SharePoint.

In this article
Prepare your app or add-in information
Localized Office Store fronts
Next steps
Additional resources

Before you submit Office and SharePoint Add-ins or Office 365 web apps in the Seller Dashboard:

  • Review the current Validation policies for apps and add-ins submitted to the Office Store (version 1.8). This will help you avoid common mistakes and verify that you’re fully compliant with the current validation requirements, and ensure that your app or add-in will pass validation when it is submitted to the Office Store for approval.

  • Check the Regional Information for the Microsoft Seller Dashboard to verify that you reside in a country or region that the Seller Dashboard supports.

  • To submit a SharePoint Add-in that uses OAuth, and that will be distributed in China, you must:

    • Use a separate client ID and client secret for China.

    • Add a separate add-in package specifically for China.

    • Block access for all countries except China.

    • Create a separate add-in listing for China.

    For more information, see Submit apps for Office 365 operated by 21Vianet in China.

  • To offer your app or add-in in languages beyond the primary language, you will need localized metadata for each additional language. The best customer experience is with apps or add-ins that have web services and functionality that support these additional languages. You will also need to create descriptions in each language. For a list of the languages that the Seller Dashboard currently accepts, see Table 2 later in this article.

     

    Note Note

    For information about localizing Office Add-ins, see Localization for Office Add-ins and Build a localized Office Add-in. For information about localizing SharePoint Add-ins, see Localization for Office Add-ins and Localize SharePoint Add-ins.

    To distribute your app or add-in in additional languages, you can edit the details in the Seller Dashboard. After you add other languages, you will need to submit it for approval again.

    In the case of previously approved add-ins, if you updated your manifest, you will need to ensure that you update the add-in version in the manifest and in the submission form. The current add-in version will remain in the Office Store until your new add-in is approved, unless you unpublish the current add-in. For more information, see Update, unpublish, and view app and add-in metrics in the Seller Dashboard.

    Note Note

    You can block customers in a certain country/region from acquiring or using your app or add-in when you add or edit it in the Seller Dashboard.

Before you add apps or add-ins in the Seller Dashboard, prepare the information in the following checklist. For additional tips and examples, see Quick steps to drive more downloads.

Table 1. Checklist for submitting apps or add-ins

Ready

What you need

Notes

Seller Dashboard checklist checkbox

App type

The following Office Types are available:

  • Office Add-in

  • Outlook Add-in

  • SharePoint Add-in

  • Web app using Azure AD

Seller Dashboard checklist checkbox

App title

Your App Title appears in the listing on the Office Store. A shorter title displays well on webpages, so use a title that is no more than 15 characters. The title can be up to 50 characters.

Office Add-ins that are available on iOS cannot include "app" in the App Title.

Tip Tip

The App Title appears on the overview page in the Seller Dashboard. The App Name appears on the details page.

Seller Dashboard checklist checkbox

App name

To offer your apps or add-ins in multiple languages, you can provide an App Name in each language. For a list of the languages that the Seller Dashboard currently accepts, see Table 2 later in this article.

Tip Tip

The App Name appears on the details page for each language in the Seller Dashboard.

Seller Dashboard checklist checkbox

Version

The version number you provide for the Version must exactly match the version number in the add-in manifest file of the add-in you submit. For more information, see Validation policies for apps and add-ins submitted to the Office Store (version 1.8).

Seller Dashboard checklist checkbox

Release date

The date your app or add-in is released and listed in the store. The release date does not determine the date on which the app or add-in is available in the Office Store.

Important note Important

If you are submitting an update and you select a release date that is in the future, your app or add-in will not be discoverable in the Office Store until the date you select. If your app or add-in was available in the Office Store, it will be hidden from users until the release date for the updated version.

Seller Dashboard checklist checkbox

Category

Choose at least one category to use as a filter in the Office Store to help customers find your app or add-in. You can choose up to three categories.

If you choose the Education category for your app or add-in, you'll need to comply with policy 7.17 of the validation policies.

Seller Dashboard checklist checkbox

App logo

Include a picture you want customers to associate with your app or add-in that will appear in the store listing.

  • For Word, Excel, and Project add-ins, you are required to link to an image using the IconUrl element in the add-in manifest. The image specified must be 32 pixels by 32 pixels.

    For more information, see IconUrl.

  • For mail add-ins, you are required to link to an image using the IconUrl element in the add-in manifest. The image specified must be secured with HTTPS. This image is shown as the 64 pixels by 64 pixels image associated with your add-in in the installed apps dialogue. For best customer experience, specify a 64 pixel by 64 pixel image for the IconUrl element. For validation, this image must be between 64 pixels by 64 pixels and 128 pixels by 128 pixels. The image must be in one of the following file formats: .gif, .jpd, .png, .exif, .bmp, or .tiff.

    For more information, see IconUrl.

  • For SharePoint Add-ins, you are required to include an icon in the add-in’s package. The image included must be 96 pixels by 96 pixels. The image that you include must match the image that you submit via the Seller Dashboard form.

  • Scan your logo with a current version of virus detection software, and upload it to the Seller Dashboard only if it passes the virus scan. If you need virus detection software, visit the Microsoft Safety & Security Center.

  • Only one logo is associated with your app or add-in. If your logo requires localization, create separate submissions for each language and use a different logo for each.

Seller Dashboard checklist checkbox

App package

The binary file or manifest file that you upload to the Seller Dashboard.

Your add-in manifest must conform to the add-in manifest schema. Make sure that you have not omitted elements or included incorrect elements, and that the order of the elements is correct.

The ID in your add-in manifest must be unique. The title that you specify in the add-in manifest must be the same as the title you specify in the Seller Dashboard.

For detailed manifest schema information, see Schema reference for apps for Office manifests (v1.1) and App Manifest schema reference (SharePoint Add-ins).

Tip Tip
  • If you have a SharePoint Add-ins, the file name extension should be .app. If you have an Office Add-in, the extension should be .xml (add-in manifest file).

  • Scan your app or add-in with a current version of virus detection software, and upload it to the Seller Dashboard only if it passes the virus scan. If you need virus detection software, visit the Microsoft Safety & Security Center.

For more information about maintaining consistency between the logo image and the one you include in the app package, see Create a consistent visual identity for your app in Create effective Office Store apps and add-ins.

Seller Dashboard checklist checkbox

OAuth Client ID (if required)

If your app or add-in is a service and requires server-to-server authorization, you will need a client ID and client secret. You create the client ID and secret in the Seller Dashboard.

Note Note

To submit a SharePoint Add-in that uses OAuth and that you want to distribute to China, you must:

  • Use a separate client ID and client secret for China.

  • Add a separate add-in package specifically for China.

  • Block access for all countries except China.

  • Create a separate add-in listing for China.

For more information, see Submit apps for Office 365 operated by 21Vianet in China.

For more information, see Create or update client IDs and secrets in the Seller Dashboard.

Seller Dashboard checklist checkbox

Testing notes

Provide instructions, links to resources, or a video demonstrating the app or add-in that will help validation testers validate your submission as part of the approval process.. For example, provide valid credentials or a password if your app requires them. The credentials or password are not for public use and will only be used by Microsoft.

For web apps, use the testing notes to supply the Single Sing-On URL to help the validator find the app.

For apps or add-ins using the Education category, provide subject and age range details. For more information, see policy 7.17 of the validation policies.

Your testing notes are for validation purposes only and will not be published in your store listing. If you provide complete testing notes, they can assist in the validation and approval of your app.

Seller Dashboard checklist checkbox

Cryptography and encryption information

Specify whether your app or add-in calls, supports, contains, or uses cryptography or encryption. For more information about encryption, see EAR Controls For Items That Use Encryption.

Seller Dashboard checklist checkbox

Apple developer ID

If your add-in is iOS-compatible and you want to make it available in the Office Add-in Catalog on iPad, you will need to provide your Apple developer ID.

Seller Dashboard checklist checkbox

App description

This includes a Short Description and a Long Description that will appear in the store listing for your app or add-in. The short description can be up to 100 characters, and the long description can be up to 4,000 characters.

Office Add-ins that are available on iOS cannot include "app" in the Short Description.

If you want a tailored experience for users in a regional store, you can add other languages so that your app or add-in appears in other language stores with localized metadata. If you add a language, you must write a Short Description and a Long Description in that language.

Tip Tip

Seller Dashboard checklist checkbox

Screen shots

Provide at least one screen shot of your app or add-in. You can provide up to five screen shots for customers who want to learn more. Customers will be able to see these images in the store listing, so do not include any private or personal information that you don't want customers to see.

If you add other languages to your app or add-in submission, you can add language-specific screen shots. Screen shots that match each language provide the best customer experience.

  • Your screen shots must be in one of the following file formats: .png, .jpg, .jpeg, or .gif.

  • They must be 512 x 384 pixels, and can be no greater than 300 KB.

  • Screen shots must be unmanipulated images of your app or add-in running in a licensed copy of Office.

  • Scan your images with a current version of virus detection software, and upload them to the Seller Dashboard only if they pass the virus scan. If you need virus detection software, visit the Microsoft Safety & Security Center.

Seller Dashboard checklist checkbox

Support document link

Provide a link to your support documentation, including http:// or https:// in your URL. The support link should include contact details so that users can contact you or a support person about your app.

In addition, make sure that you include the SupportUrl element in your manifest file. You might need to add this element to the manifest file, because it is not included there by default.

This entry should be of the form:

<SupportUrl DefaultValue="http://www.<yoursupportURL>.com/" />

Also see SupportUrl element (OfficeApp complexType) (app manifest schema v1.1).

Seller Dashboard checklist checkbox

Privacy policy notification link (optional)

Provide a link to a privacy policy.

Note Note

If your app or add-in enables access to and use of Internet-based or mobile services, or collects and/or transmits user information to you or a third party, you must provide a link to a privacy statement that contains privacy details that will be published with your app or add-in.

The Seller Dashboard now requires a link to your privacy document. If you submitted your app or add-in before a link to your privacy document was required in the Seller Dashboard, the link to privacy information on the listing page will call out that a privacy statement was not provided: Privacy Statement.

To add the link to a privacy policy to an approved app or add-in, you can edit your Seller Dashboard submission, add the link, and submit it for approval again. For more information, see Update, unpublish, and view app and add-in metrics in the Seller Dashboard.

Seller Dashboard checklist checkbox

Video link (optional)

You can create and submit a link to a video that explains how to use and get the most out of your app or add-in. This video will appear in the listing page for the app.

Make sure that your video walks the user through the most useful features of the app or add-in. We recommend that you keep your video under three minutes.

Seller Dashboard checklist checkbox

Customized end-user license agreement (optional)

If you have a customized license agreement, you can upload it. If you do not, the store will provide a license agreement for your app or add-in. For more information, see Office Store Standard Application License Terms.

For more information about licensing, see License your Office and SharePoint Add-ins, Licensing your apps for SharePoint, and Creating and verifying licensing in a paid app for Office.

Seller Dashboard checklist checkbox

Pricing information

The price is set at the app or add-in level. You don’t set a price for each language. You set a price tier. The price shown to customers is in the currency associated with the store the app or add-in is being sold in.

You can list your app or add-in for free, for a one-time purchase, or as a perpetual monthly subscription. For a paid or subscription app or add-in, you can also choose whether you want to offer it as a trial, and if so, the duration of that trial.

For SharePoint Add-ins, you can also set two additional pricing options:

  • Number of trial users - This limits the total number of users on a given site who can use the add-in as a trial.

  • Price threshold - This sets a limit on the amount a single buyer pays for purchasing multiple add-in licenses. For example, if you set the price threshold at ten users, the user is only charged for the first ten licenses they purchase.

These settings do not apply to Office Add-ins.

You can add this information at any time, so if you decide to list your add-in for purchase at a later date, you can add pricing information at that time.

You can’t change the pricing from subscription to one-time charge, or vice versa, after you have submitted the add-in listing. This includes add-ins you submitted before the subscription pricing option was available.

For more information, see Decide on a pricing model for your Office or SharePoint Add-in or Office 365 web app.

Seller Dashboard checklist checkbox

Trial information

If your app or add-in supports a trial, you will need to specify the duration of the trial, and the number of users.

You also need to consider licensing. For more information about licensing, see License your Office and SharePoint Add-ins, Licensing your apps for SharePoint, and Creating and verifying licensing in a paid app for Office.

Seller Dashboard checklist checkbox

Payout and tax information

To list your app or add-in for purchase, either for one-time purchase or as a subscription, you must also provide payout and tax information. This information must be validated. For more information, see Create Your Account and Add Payout Information in the Microsoft Seller Dashboard.

Seller Dashboard checklist checkbox

App appropriately localized

If your app or add-in supports multiple languages, verify that it has been appropriately localized, or it will not pass validation and won’t be approved.

For more information, see Localization for Office Add-ins, Build a localized Office Add-in, Localization for Office Add-ins, and Localize SharePoint Add-ins.

The Office Store is available in 40 languages in 60 corresponding markets, as listed in Table 2. In each of these markets, the Office Store displays metadata in either English or the corresponding language. When you submit an app or add-in, you can provide metadata (descriptions, screen shots, title) in the languages that you would like to be listed in, and explicitly specify these languages as submission languages in the Seller Dashboard. Verify that the primary submission language is in the add-in manifest, if applicable. If English is the only submission language, by default, your app or add-in will be listed in the Office Store fronts in all 60 markets with English metadata. If any of the non-English languages is a submission language, your app or add-in will be listed in the Office Store fronts in the corresponding markets, with metadata in that language. If English and any of the other non-English languages are submission languages, the app or add-in will be listed in all 60 markets with English metadata, except for those markets for which the corresponding non-English language has been submitted, where the metadata will be in the corresponding language.

In the Seller Dashboard, you can explicitly block markets in which to distribute your app or add-in.

Users can verify whether a market-specific Office Store front is available for a market by selecting that market in the upper-right of the store page, as shown in Figure 1. From there, users either are directed to the market-specific store front, or if that store front is not available, see a message that suggests that they go the Office Store in the United States.

Figure 1. Verify or choose a different market in the Office Store

Choose a different market for the Office Store.

Table 2 lists the submission languages that the Office Store is available in, and the locales and markets that correspond to each of these languages. Language identifiers and OptionState Id values in Office 2013 lists all the languages and locales for which you can localize an app or add-in. For more information, see Localization for Office Add-ins and Build a localized Office Add-in.

Table 2. List of distribution languages and corresponding markets for the Office Store

Submission language

Locale (language tag)

Market (country/region)

English

en-us

United States

English

en-au

Australia

English

en-ca

Canada - English

English

en-gb

United Kingdom

English

en-in

India

English

en-ie

Ireland

English

en-nz

New Zealand

English

en-sg

Singapore

English

en-za

South Africa

English

en-001

International English

French

fr-fr

France

French

fr-be

Belgium

French

fr-ca

Canada - French

French

fr-ch

Switzerland

French

fr-001

International French

German

de-de

Germany

German

de-at

Austria

German

de-ch

Switzerland

Japanese

ja-jp

Japan

Spanish

es-es

Spain

Spanish

es-mx

Mexico

Spanish

es-hn

Honduras

Spanish

es-ar

Argentina

Italian

it-it

Italy

Dutch

nl-be

Belgium

Dutch

nl-nl

The Netherlands

Russian

ru-ru

Russia

Chinese

zh-cn

China (PRC)

Chinese

zh-hk

Chinese (Hong Kong SAR)

Chinese

zh-tw

Taiwan

Portuguese

pt-br

Brazil

Portuguese

pt-pt

Portugal

Arabic

ar-sa

Saudi Arabia

Bulgarian

bg-bg

Bulgaria

Czech

cs-cz

Czech Republic

Danish

da-dk

Denmark

Greek

el-gr

Greece

Estonian

et-ee

Estonia

Finnish

fi-fi

Finland

Hebrew

he-il

Israel

Hindi

hi-in

India

Croatian

hr-hr

Croatia

Hungarian

hu-hu

Hungary

Indonesian

id-id

Indonesia

Kazakh

kk-kz

Kazakhstan

Korean

ko-kr

Korea

Lithuanian

lt-lt

Lithuania

Latvian

lv-lv

Latvia

Malay

ms-my

Malaysia

Norwegian

nb-no

Norway

Polish

pl-pl

Poland

Romanian

ro-ro

Romania

Serbian (Latin)

sr-latn-rs

Serbia

Slovenian

sl-si

Slovenia

Slovak

sk-sk

Slovakia

Swedish

sv-se

Sweden

Thai

th-th

Thailand

Turkish

tr-tr

Turkey

Ukranian

uk-ua

Ukraine

Vietnamese

vi-vn

Vietnam

You can use the Seller Dashboard to submit Office and SharePoint Add-ins and Office 365 web apps to the Office Store. For more information, see Submit Office and SharePoint Add-ins and Office 365 web apps to the Seller Dashboard.

Show:
© 2015 Microsoft