Approves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design.

Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept them on behalf of their organization in order to approve that product. Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to approve the product. This URL can only be used to display permissions for up to 1 day.

Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.

Finds approved products that match a query, or all approved products if there is no query.

Method Details

approve(enterpriseId, productId, body=None, x__xgafv=None)

Args:
enterpriseId: string, The ID of the enterprise. (required)
productId: string, The ID of the product. (required)
body: object, The request body.
The object takes the form of:

{
"approvalUrlInfo": { # Information on an approval URL. # The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated.
"approvalUrl": "A String", # A URL that displays a product's permissions and that can also be used to approve the product with the Products.approve call.
},
"approvedPermissions": "A String", # Sets how new permission requests for the product are handled. "allPermissions" automatically approves all current and future permissions for the product. "currentPermissionsOnly" approves the current set of permissions for the product, but any future permissions added through updates will require manual reapproval. If not specified, only the current set of permissions will be approved.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

close()

Close httplib2 connections.

generateApprovalUrl(enterpriseId, productId, languageCode=None, x__xgafv=None)

Args:
enterpriseId: string, The ID of the enterprise. (required)
productId: string, The ID of the product. (required)
languageCode: string, The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US".
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
"url": "A String", # A URL that can be rendered in an iframe to display the permissions (if any) of a product. This URL can be used to approve the product only once and only within 24 hours of being generated, using the Products.approve call. If the product is currently unapproved and has no permissions, this URL will point to an empty page. If the product is currently approved, a URL will only be generated if that product has added permissions since it was last approved, and the URL will only display those new permissions that have not yet been accepted.
}

get(enterpriseId, productId, language=None, x__xgafv=None)

Retrieves details of a product for display to an enterprise admin.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product, e.g. "app:com.google.android.gm". (required)
  language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  "appTracks": [ # The tracks visible to the enterprise.
    { # Id to name association of a track.
      "trackAlias": "A String", # A modifiable name for a track. This is the visible name in the play developer console.
      "trackId": "A String", # Unmodifiable, unique track identifier. This identifier is the releaseTrackId in the url of the play developer console page that displays the track information.
    },
  ],
  "appVersion": [ # App versions currently available for this product.
    { # This represents a single version of the app.
      "isProduction": True or False, # True if this version is a production APK.
      "track": "A String", # Deprecated, use trackId instead.
      "trackId": [ # Track ids that the app version is published in. Replaces the track field (deprecated), but doesn't include the production track (see isProduction instead).
        "A String",
      ],
      "versionCode": 42, # Unique increasing identifier for the app version.
      "versionString": "A 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").
    },
  ],
  "authorName": "A String", # The name of the author of the product (for example, the app developer).
  "availableCountries": [ # The countries which this app is available in.
    "A String",
  ],
  "availableTracks": [ # Deprecated, use appTracks instead.
    "A String",
  ],
  "category": "A String", # The app category (e.g. RACING, SOCIAL, etc.)
  "contentRating": "A String", # The content rating for this app.
  "description": "A String", # The localized promotional description, if available.
  "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product.
  "distributionChannel": "A 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.
  "features": [ # Noteworthy features (if any) of this product.
    "A String",
  ],
  "iconUrl": "A 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.
  "lastUpdatedTimestampMillis": "A String", # The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch.
  "minAndroidSdkVersion": 42, # The minimum Android SDK necessary to run the app.
  "permissions": [ # A list of permissions required by the app.
    { # 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.
      "permissionId": "A String", # An opaque string uniquely identifying the permission.
      "state": "A String", # Whether the permission has been accepted or not.
    },
  ],
  "productId": "A String", # A string of the form *app:<package name>*. For example, app:com.google.android.gm represents the Gmail app.
  "productPricing": "A 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).
  "recentChanges": "A String", # A description of the recent changes made to the app.
  "requiresContainerApp": True or False, # Deprecated.
  "screenshotUrls": [ # A list of screenshot links representing the app.
    "A String",
  ],
  "signingCertificate": { # The certificate used to sign this product.
    "certificateHashSha1": "A 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.)
    "certificateHashSha256": "A String", # The base64 urlsafe encoded SHA2-256 hash of the certificate.
  },
  "smallIconUrl": "A 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.
  "title": "A String", # The name of the product.
  "workDetailsUrl": "A String", # A link to the managed Google Play details page for the product, for use by an Enterprise admin.
}

getAppRestrictionsSchema(enterpriseId, productId, language=None, x__xgafv=None)

Retrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configurations have been defined. This schema can be used to populate a UI that allows an admin to configure the product. To apply a managed configuration based on the schema obtained using this API, see Managed Configurations through Play.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
  language: string, The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents the list of app restrictions available to be pre-configured for the product.
  "kind": "A String", # Deprecated.
  "restrictions": [ # The set of restrictions that make up this schema.
    { # A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.
      "defaultValue": { # A typed value for the restriction. # The default value of the restriction. bundle and bundleArray restrictions never have a default value.
        "type": "A String", # The type of the value being provided.
        "valueBool": True or False, # The boolean value - this will only be present if type is bool.
        "valueInteger": 42, # The integer value - this will only be present if type is integer.
        "valueMultiselect": [ # The list of string values - this will only be present if type is multiselect.
          "A String",
        ],
        "valueString": "A String", # The string value - this will be present for types string, choice and hidden.
      },
      "description": "A String", # A longer description of the restriction, giving more detail of what it affects.
      "entry": [ # For choice or multiselect restrictions, the list of possible entries' human-readable names.
        "A String",
      ],
      "entryValue": [ # For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction.
        "A String",
      ],
      "key": "A String", # The unique key that the product uses to identify the restriction, e.g. "com.google.android.gm.fieldname".
      "nestedRestriction": [ # For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep.
        # Object with schema name: AppRestrictionsSchemaRestriction
      ],
      "restrictionType": "A String", # The type of the restriction.
      "title": "A String", # The name of the restriction.
    },
  ],
}

getPermissions(enterpriseId, productId, x__xgafv=None)

Retrieves the Android app permissions required by this app.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  productId: string, The ID of the product. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Information about the permissions required by a specific app and whether they have been accepted by the enterprise.
  "permission": [ # The permissions required by the app.
    { # 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.
      "permissionId": "A String", # An opaque string uniquely identifying the permission.
      "state": "A String", # Whether the permission has been accepted or not.
    },
  ],
  "productId": "A String", # The ID of the app that the permissions relate to, e.g. "app:com.google.android.gm".
}

list(enterpriseId, approved=None, language=None, maxResults=None, query=None, token=None, x__xgafv=None)

Finds approved products that match a query, or all approved products if there is no query.

Args:
  enterpriseId: string, The ID of the enterprise. (required)
  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, Defines how many results the list operation should return. The default number depends on the resource collection.
  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, Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "pageInfo": { # Information about the current page. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. # General pagination information.
    "resultPerPage": 42, # Maximum number of results returned in one page. ! The number of results included in the API response.
    "startIndex": 42, # Index of the first result returned in the current page.
    "totalResults": 42, # Total number of results available on the backend ! The total number of results in the result set.
  },
  "product": [ # Information about a product (e.g. an app) in the Google Play store, for display to an enterprise admin.
    { # 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.
      "appTracks": [ # The tracks visible to the enterprise.
        { # Id to name association of a track.
          "trackAlias": "A String", # A modifiable name for a track. This is the visible name in the play developer console.
          "trackId": "A String", # Unmodifiable, unique track identifier. This identifier is the releaseTrackId in the url of the play developer console page that displays the track information.
        },
      ],
      "appVersion": [ # App versions currently available for this product.
        { # This represents a single version of the app.
          "isProduction": True or False, # True if this version is a production APK.
          "track": "A String", # Deprecated, use trackId instead.
          "trackId": [ # Track ids that the app version is published in. Replaces the track field (deprecated), but doesn't include the production track (see isProduction instead).
            "A String",
          ],
          "versionCode": 42, # Unique increasing identifier for the app version.
          "versionString": "A 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").
        },
      ],
      "authorName": "A String", # The name of the author of the product (for example, the app developer).
      "availableCountries": [ # The countries which this app is available in.
        "A String",
      ],
      "availableTracks": [ # Deprecated, use appTracks instead.
        "A String",
      ],
      "category": "A String", # The app category (e.g. RACING, SOCIAL, etc.)
      "contentRating": "A String", # The content rating for this app.
      "description": "A String", # The localized promotional description, if available.
      "detailsUrl": "A String", # A link to the (consumer) Google Play details page for the product.
      "distributionChannel": "A 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.
      "features": [ # Noteworthy features (if any) of this product.
        "A String",
      ],
      "iconUrl": "A 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.
      "lastUpdatedTimestampMillis": "A String", # The approximate time (within 7 days) the app was last published, expressed in milliseconds since epoch.
      "minAndroidSdkVersion": 42, # The minimum Android SDK necessary to run the app.
      "permissions": [ # A list of permissions required by the app.
        { # 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.
          "permissionId": "A String", # An opaque string uniquely identifying the permission.
          "state": "A String", # Whether the permission has been accepted or not.
        },
      ],
      "productId": "A String", # A string of the form *app:<package name>*. For example, app:com.google.android.gm represents the Gmail app.
      "productPricing": "A 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).
      "recentChanges": "A String", # A description of the recent changes made to the app.
      "requiresContainerApp": True or False, # Deprecated.
      "screenshotUrls": [ # A list of screenshot links representing the app.
        "A String",
      ],
      "signingCertificate": { # The certificate used to sign this product.
        "certificateHashSha1": "A 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.)
        "certificateHashSha256": "A String", # The base64 urlsafe encoded SHA2-256 hash of the certificate.
      },
      "smallIconUrl": "A 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.
      "title": "A String", # The name of the product.
      "workDetailsUrl": "A String", # A link to the managed Google Play details page for the product, for use by an Enterprise admin.
    },
  ],
  "tokenPagination": { # Pagination information returned by a List operation when token pagination is enabled. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. When using token pagination, clients should use the next/previous token to get another page of the result. The presence or absence of next/previous token indicates whether a next/previous page is available and provides a mean of accessing this page. ListRequest.page_token should be set to either next_page_token or previous_page_token to access another page. # Pagination information for token pagination.
    "nextPageToken": "A String", # Tokens to pass to the standard list field 'page_token'. Whenever available, tokens are preferred over manipulating start_index.
    "previousPageToken": "A String",
  },
}

Google Play EMM API . products

Instance Methods

Method Details