Testing your Code in Sandbox
Microsoft Advertising does not provide a sandbox for the Content API where you can test your application before you deploy it to the production environment.
However, you can use the following options to test your application in production without affecting live data. These options apply only to the Product and Inventory resources and not to the Catalog resource.
Using dry-run query parameter
To test your code in production without modifying your live feed and impacting served ads, include the dry-run query parameter in the endpoint URL as shown below.
dry-run will not change your live feed, but it will return validation errors.
Because data is not stored in the database when using the dry-run parameter, consider the following limitations when using this option:
- Insert operations will not return an ID
- The service will not generate and return secondary error messages such as data quality, editorial issues, and database related validations
Note that the Catalogs resource does not support the
dry-run query parameter.
Another option is to disable a catalog's ability to publish content. Catalogs that are disabled will not serve ads. This allows you to perform operations against the catalog and capture any errors that occur.
To disable a catalog in the Microsoft Advertising web application, select the catalog from the Catalog management tab. Then, on the Catalog settings tab, deselect Enable publishing.
As with using the
dry-run query parameter, secondary error messages such as data quality, editorial issues, and database related validations are not generated and will not be returned. However, Insert operations will return IDs.
Products are unique within a store, not a catalog. If you have a product with the same id in more than one catalog, then any changes that you make to the product in the disabled catalog will also occur in the enabled catalogs. This means that even with publishing disabled in one catalog, another catalog may serve ads for that product.
You may not update a store's default catalog. If you try to update the default catalog, the request fails.