google_api_android_enterprise v0.16.1 GoogleApi.AndroidEnterprise.V1.Api.Products View Source

API calls for all endpoints tagged Products.

Link to this section Summary

Functions

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.

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.

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.

Unapproves the specified product (and the relevant app permissions, if any)

Link to this section Functions

Link to this function

androidenterprise_products_approve(connection, enterprise_id, product_id, optional_params \\ [], opts \\ [])

View Source
androidenterprise_products_approve(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • product_id (type: String.t) - The ID of the product.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.AndroidEnterprise.V1.Model.ProductsApproveRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_products_generate_approval_url(connection, enterprise_id, product_id, optional_params \\ [], opts \\ [])

View Source
androidenterprise_products_generate_approval_url(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AndroidEnterprise.V1.Model.ProductsGenerateApprovalUrlResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • product_id (type: String.t) - The ID of the product.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :languageCode (type: String.t) - The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US".
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.ProductsGenerateApprovalUrlResponse{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_products_get(connection, enterprise_id, product_id, optional_params \\ [], opts \\ [])

View Source
androidenterprise_products_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.Product.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • product_id (type: String.t) - The ID of the product, e.g. "app:com.google.android.gm".
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :language (type: String.t) - The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.Product{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_products_get_app_restrictions_schema(connection, enterprise_id, product_id, optional_params \\ [], opts \\ [])

View Source
androidenterprise_products_get_app_restrictions_schema(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.AppRestrictionsSchema.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • product_id (type: String.t) - The ID of the product.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :language (type: String.t) - The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.AppRestrictionsSchema{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_products_get_permissions(connection, enterprise_id, product_id, optional_params \\ [], opts \\ [])

View Source
androidenterprise_products_get_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.ProductPermissions.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Retrieves the Android app permissions required by this app.

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • product_id (type: String.t) - The ID of the product.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.ProductPermissions{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_products_list(connection, enterprise_id, optional_params \\ [], opts \\ [])

View Source
androidenterprise_products_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AndroidEnterprise.V1.Model.ProductsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :approved (type: 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 (type: String.t) - 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 (type: 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 (type: String.t) - 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 (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AndroidEnterprise.V1.Model.ProductsListResponse{}} on success
  • {:error, info} on failure
Link to this function

androidenterprise_products_unapprove(connection, enterprise_id, product_id, optional_params \\ [], opts \\ [])

View Source
androidenterprise_products_unapprove(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}

Unapproves the specified product (and the relevant app permissions, if any)

Parameters

  • connection (type: GoogleApi.AndroidEnterprise.V1.Connection.t) - Connection to server
  • enterprise_id (type: String.t) - The ID of the enterprise.
  • product_id (type: String.t) - The ID of the product.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure