List
|
|||||
|
|
||||
Finds approved products that match a query, or all approved products if there is no query
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage corporate Android devices
Input
This building block consumes 6 input parameters
| Name | Format | Description |
|---|---|---|
enterpriseId Required |
STRING |
The ID of the enterprise |
approved |
BOOLEAN |
Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified |
language |
STRING |
The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language |
maxResults |
INTEGER |
Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response |
query |
STRING |
The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps) |
token |
STRING |
A pagination token is contained in a request's response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request |
= Parameter name
= Format
|
enterpriseId STRING Required The ID of the enterprise |
|
approved BOOLEAN Specifies whether to search among all products (false) or among only products that have been approved (true). Only "true" is supported, and should be specified |
|
language STRING The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results are returned in the language best matching the preferred language |
|
maxResults INTEGER Specifies the maximum number of products that can be returned per request. If not specified, uses a default value of 100, which is also the maximum retrievable within a single response |
|
query STRING The search query as typed in the Google Play store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps) |
|
token STRING A pagination token is contained in a request's response when there are more products. The token can be used in a subsequent request to obtain more products, and so forth. This parameter cannot be used in the initial request |
Output
This building block provides 44 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productsListResponse" |
pageInfo |
OBJECT |
|
pageInfo.resultPerPage |
INTEGER |
|
pageInfo.startIndex |
INTEGER |
|
pageInfo.totalResults |
INTEGER |
|
product[] |
OBJECT |
A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface |
product[].appTracks[] |
OBJECT |
Id to name association of a track |
product[].appTracks[].trackAlias |
STRING |
A modifiable name for a track. This is the visible name in the play developer console |
product[].appTracks[].trackId |
STRING |
Unmodifiable, unique track identifier. This identifier is the releaseTrackId in the url of the play developer console page that displays the track information |
product[].appVersion[] |
OBJECT |
This represents a single version of the app |
product[].appVersion[].isProduction |
BOOLEAN |
True if this version is a production APK |
product[].appVersion[].track |
STRING |
Deprecated, use trackId instead |
product[].appVersion[].trackId[] |
STRING |
|
product[].appVersion[].versionCode |
INTEGER |
Unique increasing identifier for the app version |
product[].appVersion[].versionString |
STRING |
The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4") |
product[].authorName |
STRING |
The name of the author of the product (for example, the app developer) |
product[].availableCountries[] |
STRING |
|
product[].availableTracks[] |
STRING |
|
product[].category |
STRING |
The app category (e.g. RACING, SOCIAL, etc.) |
product[].contentRating |
STRING |
The content rating for this app |
product[].description |
STRING |
The localized promotional description, if available |
product[].detailsUrl |
STRING |
A link to the (consumer) Google Play details page for the product |
product[].distributionChannel |
STRING |
How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted |
product[].iconUrl |
STRING |
A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px |
product[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product" |
product[].lastUpdatedTimestampMillis |
INTEGER |
The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch |
product[].minAndroidSdkVersion |
INTEGER |
The minimum Android SDK necessary to run the app |
product[].permissions[] |
OBJECT |
A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted |
product[].permissions[].permissionId |
STRING |
An opaque string uniquely identifying the permission |
product[].permissions[].state |
STRING |
Whether the permission has been accepted or not |
product[].productId |
STRING |
A string of the form app: |
product[].productPricing |
STRING |
Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it) |
product[].recentChanges |
STRING |
A description of the recent changes made to the app |
product[].requiresContainerApp |
BOOLEAN |
Deprecated |
product[].screenshotUrls[] |
STRING |
|
product[].signingCertificate |
OBJECT |
|
product[].signingCertificate.certificateHashSha1 |
STRING |
The base64 urlsafe encoded SHA1 hash of the certificate. (This field is deprecated in favor of SHA2-256. It should not be used and may be removed at any time.) |
product[].signingCertificate.certificateHashSha256 |
STRING |
The base64 urlsafe encoded SHA2-256 hash of the certificate |
product[].smallIconUrl |
STRING |
A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px |
product[].title |
STRING |
The name of the product |
product[].workDetailsUrl |
STRING |
A link to the managed Google Play details page for the product, for use by an Enterprise admin |
tokenPagination |
OBJECT |
|
tokenPagination.nextPageToken |
STRING |
|
tokenPagination.previousPageToken |
STRING |
= Parameter name
= Format
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "androidenterprise#productsListResponse" |
|
pageInfo OBJECT |
|
pageInfo.resultPerPage INTEGER |
|
pageInfo.startIndex INTEGER |
|
pageInfo.totalResults INTEGER |
|
product[] OBJECT A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface |
|
product[].appTracks[] OBJECT Id to name association of a track |
|
product[].appTracks[].trackAlias STRING A modifiable name for a track. This is the visible name in the play developer console |
|
product[].appTracks[].trackId STRING Unmodifiable, unique track identifier. This identifier is the releaseTrackId in the url of the play developer console page that displays the track information |
|
product[].appVersion[] OBJECT This represents a single version of the app |
|
product[].appVersion[].isProduction BOOLEAN True if this version is a production APK |
|
product[].appVersion[].track STRING Deprecated, use trackId instead |
|
product[].appVersion[].trackId[] STRING |
|
product[].appVersion[].versionCode INTEGER Unique increasing identifier for the app version |
|
product[].appVersion[].versionString STRING The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be "1.4") |
|
product[].authorName STRING The name of the author of the product (for example, the app developer) |
|
product[].availableCountries[] STRING |
|
product[].availableTracks[] STRING |
|
product[].category STRING The app category (e.g. RACING, SOCIAL, etc.) |
|
product[].contentRating STRING The content rating for this app |
|
product[].description STRING The localized promotional description, if available |
|
product[].detailsUrl STRING A link to the (consumer) Google Play details page for the product |
|
product[].distributionChannel STRING How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted |
|
product[].iconUrl STRING A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px |
|
product[].kind STRING Identifies what kind of resource this is. Value: the fixed string "androidenterprise#product" |
|
product[].lastUpdatedTimestampMillis INTEGER The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch |
|
product[].minAndroidSdkVersion INTEGER The minimum Android SDK necessary to run the app |
|
product[].permissions[] OBJECT A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted |
|
product[].permissions[].permissionId STRING An opaque string uniquely identifying the permission |
|
product[].permissions[].state STRING Whether the permission has been accepted or not |
|
product[].productId STRING A string of the form app: |
|
product[].productPricing STRING Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it) |
|
product[].recentChanges STRING A description of the recent changes made to the app |
|
product[].requiresContainerApp BOOLEAN Deprecated |
|
product[].screenshotUrls[] STRING |
|
product[].signingCertificate OBJECT |
|
product[].signingCertificate.certificateHashSha1 STRING The base64 urlsafe encoded SHA1 hash of the certificate. (This field is deprecated in favor of SHA2-256. It should not be used and may be removed at any time.) |
|
product[].signingCertificate.certificateHashSha256 STRING The base64 urlsafe encoded SHA2-256 hash of the certificate |
|
product[].smallIconUrl STRING A link to a smaller image that can be used as an icon for the product. This image is suitable for use at up to 128px x 128px |
|
product[].title STRING The name of the product |
|
product[].workDetailsUrl STRING A link to the managed Google Play details page for the product, for use by an Enterprise admin |
|
tokenPagination OBJECT |
|
tokenPagination.nextPageToken STRING |
|
tokenPagination.previousPageToken STRING |