AdvancedListings support (gaming options and trailers) + additional screenshots #100

HowardWolosky · 2018-02-02T07:34:07Z

This adds the following core features to Application Listing updates:

trailers
gaming options
All remaining support image types (including "hero" images)

The PDP schema has been updated to support this new localizable data. There is a new AdditionalAssets node that stores specific-named elements representing all image types that aren't caption-able. There's a new Trailers node that lets you define the trailers (and associated title and screenshot) that should be available for reach language. Convert-FromExistingSubmission has been updated to include these values in the generated PDP files.

Gaming Options are stored in the config file (and New-StoreBrokerConfigFile was updated to capture those values)

Now that we have so many different nodes that might want fallback language support, I've also added FallbackLanguage attribute support directly on the ProductDescription and InAppProductDescription elements as well.

Adds gamingOptions support
- Updated the config file with gamingOptions
- New-StoreBrokerConfigFile now populates those values
- Update-ApplicationSubmission / Patch-ApplicationSubmission updated to
  support -UpdateGamingOptions
- Format-Application updated to print out hasAdvancedListingSupport
- Format-ApplicationSubmission updated to print out gaming options when available
Adds trailers support
- Updated the PDP schema to support trailers
- ConvertFrom-ExistingSubmission now exports trailer info to the PDP's.
- New-SubmissionPackage will coalesce trailer information into the
  generated json
- Update-ApplicationSubmission / Patch-ApplicationSubmission updated to
  support -UpdateTrailers
- Format-ApplicationSubmission updated to print out trailers when available
Adds support for additional image/screenshot types
- Adds support for all remaining "AdditonalAssets" (all of the other
  image types that aren't explicitly screenshots with captions), like
  "hero images".

Resolves #58 - Add Advanced Listing Support
Resolves #85 - StoreBroker cannot upload the full set of possible image types for a listing

danbelcher-MSFT · 2018-02-05T22:00:30Z

Documentation/PDP.md

+
+> Only relevant for Application submissions
+
+There are two different types of 3 different types of images that can be used for a listing:


"There are two different types of 3 different types of images..."

danbelcher-MSFT · 2018-02-05T22:01:29Z

Documentation/PDP.md

+  3. Trailer screenshots (which also don't have captions, but are tied to trailers)
+
+In the [previous section](#screenshots-and-captions), we talked about screenshots
+(and their captions).  Now we will talkabout #2 (Additional Assets).


danbelcher-MSFT · 2018-02-05T22:06:37Z

Documentation/PDP.md

+(and their captions).  Now we will talkabout #2 (Additional Assets).
+
+You can learn more about the specifics of these different images and how they're used by referring to the
+[dev portal's online documentation](https://docs.microsoft.com/en-us/windows/uwp/publish/app-screenshots-and-images).


Because we're talking about API values, it might be worth also including the API documentation: https://docs.microsoft.com/en-us/windows/uwp/monetize/manage-app-submissions#image-object

danbelcher-MSFT · 2018-02-05T22:08:01Z

Documentation/PDP.md

+ * `BackgroundImage1000X800`
+ * `PromotionalArtwork414X180`
+
+Those elements do not have any InnerText/content -- they only have a single attribute


These elements?

"Those" worked too, but changed to "These".

danbelcher-MSFT · 2018-02-05T22:11:22Z

Documentation/USAGE.md

+   (the localized content from the PDP's), deleting any existing data along the way.
+   Please note that your application must have
+   ["Advanced Listing Permission"](https://docs.microsoft.com/en-us/windows/uwp/monetize/manage-app-submissions#advanced-listings)
+   enabled for this to work.  For more info on trailers, review [PDP.md](./PDP.md).


Don't want to link directly to the Trailers section?

improved link. thanks,

danbelcher-MSFT · 2018-02-05T23:06:35Z

StoreBroker/PackageTool.ps1

+                    {
+                        $assetTypeName = $assetType.LocalName
+                        $imageFileName = $assetType.FileName
+                        if (-not [System.String]::IsNullOrWhiteSpace($imageFileName))


According to the schema, this shouldn't ever be false, am I misunderstanding?

Nope, you're right. Removed the check.

danbelcher-MSFT · 2018-02-05T23:08:32Z

StoreBroker/PackageTool.ps1

+
+        [Parameter(Mandatory)]
+        [AllowNull()]
+        [AllowEmptyString()]


[AllowEmptyCollection()]?

Wait, why is this mandatory?

Same feedback for elsewhere in this script, including PDPInclude/PDPExclude parameters

I had the same questions around the other places. I was simply duplicating how we handled the other methods with this new one. I was reticent to make the change to remove mandatory from everywhere because it would increase the testing cost / regression potential.

danbelcher-MSFT · 2018-02-05T23:19:33Z

StoreBroker/PackageTool.ps1

+
+    Write-Log -Message "Converting application trailers metadata." -Level Verbose
+
+    $global:dictionaries = (Get-ChildItem -File $PDPRootPath -Recurse -Include $PDPInclude -Exclude $PDPExclude).FullName |


Thanks for catching that. It was $global temporarily while I was debugging it (so that it left the artifact around), but I neglected to revert it.

danbelcher-MSFT · 2018-02-05T23:23:24Z

StoreBroker/PackageTool.ps1

+    # PowerShell will convert an array of a single object back to a single object.
+    # We need to force it to stay as an array, since the Trailers node in the JSON
+    # is an array of trailers.
+    return (, $trailersArray)


Typically the decision for array or not should be determined by the caller. Why force it here?

Discussed in person. Happy to move this logic down to the caller. Thanks for pointing it out.

danbelcher-MSFT · 2018-02-05T23:24:01Z

StoreBroker/PackageTool.ps1

@@ -1957,7 +2344,7 @@ function Get-FormattedFilename
    # Simplify 'Windows.Universal' to 'Universal'
    $deviceFamilyCollection = $Metadata.targetDeviceFamiliesEx.Name | ForEach-Object { $_ -replace '^Windows\.', '' }

-    $formattedBundleTags = @($Metadata.name, $version, $architectureTag)
+    $formattedBundleTags = @($Metadata.name, $fversion, $architectureTag)


yep. thanks.

danbelcher-MSFT · 2018-02-08T01:15:55Z

StoreBroker/StoreIngestionApplicationApi.ps1

-            $output += "$(" " * $indentLength)isBroadcastingPrivilegeGranted  : $($listings.gamingOptions.isBroadcastingPrivilegeGranted)"
-            $output += "$(" " * $indentLength)isCrossPlayEnabled              : $($listings.gamingOptions.isCrossPlayEnabled)"
-            $output += "$(" " * $indentLength)kinectDataForExternal           : $($listings.gamingOptions.kinectDataForExternal)"
+            $output += "$(" " * $indentLength)Genres                          : $($ApplicationSubmissionData.gamingOptions.genres -join ', ')"


Why don't we create a format string instead of repeating this pattern?

It's an interesting code-cleanup idea for a future patch release. Wouldn't block this submission on it though

danbelcher-MSFT · 2018-02-08T01:18:07Z

StoreBroker/StoreIngestionApplicationApi.ps1

+            }
+            else
+            {
+                $global:trailerByLang = [ordered]@{}


debug data strikes again. good catch, thanks

danbelcher-MSFT · 2018-02-08T01:19:32Z

StoreBroker/StoreIngestionApplicationApi.ps1

+            {
+                $global:trailerByLang = [ordered]@{}
+                $ApplicationSubmissionData.trailers |
+                    ForEach-Object {


I don't see much benefit from pipelining here but do see improved readability from

foreach ($trailer in $ApplicationSubmissionData.trailers) { ... }

danbelcher-MSFT · 2018-02-08T01:20:13Z

StoreBroker/StoreIngestionApplicationApi.ps1

+                        $trailerFileName = $trailer.videoFileName
+                        $trailer.trailerAssets |
+                            Get-Member -type NoteProperty |
+                                ForEach-Object {


nit: should be aligned with Get-Member above, correct?

…creenshots + Adds gamingOptions support * Updated the config file with `gamingOptions` * `New-StoreBrokerConfigFile` now populates those values * `Update-ApplicationSubmission` / `Patch-ApplicationSubmission` updated to support `-UpdateGamingOptions` * `Format-Application` updated to print out hasAdvancedListingSupport * `Format-ApplicationSubmission` updated to print out gaming options when available + Adds trailers support * Updated the PDP schema to support trailers * `ConvertFrom-ExistingSubmission` now exports trailer info to the PDP's. * `New-SubmissionPackage` will coalesce trailer information into the generated json * `Update-ApplicationSubmission` / `Patch-ApplicationSubmission` updated to support `-UpdateTrailers` * `Format-ApplicationSubmission` updated to print out trailers when available + Adds support for additional image/screenshot types * Adds support for all remaining "AdditonalAssets" (all of the other image types that aren't explicitly screenshots with captions), like "hero images".

HowardWolosky requested a review from danbelcher-MSFT February 2, 2018 07:34

HowardWolosky force-pushed the advanced branch from f831e89 to ff56510 Compare February 3, 2018 00:12

danbelcher-MSFT suggested changes Feb 5, 2018

View reviewed changes

HowardWolosky force-pushed the advanced branch from 30ae4a0 to ad348a6 Compare February 6, 2018 17:30

danbelcher-MSFT approved these changes Feb 6, 2018

View reviewed changes

HowardWolosky force-pushed the advanced branch 2 times, most recently from 0b595b2 to 4654327 Compare February 7, 2018 21:46

danbelcher-MSFT suggested changes Feb 8, 2018

View reviewed changes

danbelcher-MSFT approved these changes Feb 8, 2018

View reviewed changes

HowardWolosky force-pushed the advanced branch from 59ef535 to aa21820 Compare February 8, 2018 02:11

HowardWolosky changed the title ~~Advanced Listings Support~~ AdvancedListings support (gaming options and trailers) + additional screenshots Feb 8, 2018

HowardWolosky force-pushed the advanced branch from aa21820 to 4bd928c Compare February 8, 2018 05:08

HowardWolosky merged commit f053418 into microsoft:master Feb 8, 2018

HowardWolosky deleted the advanced branch February 8, 2018 05:13

HowardWolosky mentioned this pull request Feb 9, 2018

Add additional listing metadata for games #107

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AdvancedListings support (gaming options and trailers) + additional screenshots #100

AdvancedListings support (gaming options and trailers) + additional screenshots #100

HowardWolosky commented Feb 2, 2018 •

edited

Loading

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

danbelcher-MSFT Feb 5, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 5, 2018

HowardWolosky Feb 6, 2018

danbelcher-MSFT Feb 8, 2018

HowardWolosky Feb 8, 2018

danbelcher-MSFT Feb 8, 2018

HowardWolosky Feb 8, 2018

danbelcher-MSFT Feb 8, 2018

danbelcher-MSFT Feb 8, 2018


		> Only relevant for Application submissions

		There are two different types of 3 different types of images that can be used for a listing:


		Write-Log -Message "Converting application trailers metadata." -Level Verbose

		$global:dictionaries = (Get-ChildItem -File $PDPRootPath -Recurse -Include $PDPInclude -Exclude $PDPExclude).FullName \|

AdvancedListings support (gaming options and trailers) + additional screenshots #100

AdvancedListings support (gaming options and trailers) + additional screenshots #100

Conversation

HowardWolosky commented Feb 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HowardWolosky commented Feb 2, 2018 •

edited

Loading