google_api_android_enterprise v0.0.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. 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 details of a product for display to an enterprise admin
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
Retrieves the Android app permissions required by this app
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
androidenterprise_products_approve(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, nil} | {: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 (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- product_id (String): The ID of the product.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :body (ProductsApproveRequest):
Returns
{:ok, %{}} on success {:error, info} on failure
androidenterprise_products_generate_approval_url(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.ProductsGenerateApprovalUrlResponse.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 (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- product_id (String): The ID of the product.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :language_code (String): The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US".
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.ProductsGenerateApprovalUrlResponse{}} on success {:error, info} on failure
androidenterprise_products_get(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.Product.t} | {:error, Tesla.Env.t}
Retrieves details of a product for display to an enterprise admin.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- product_id (String): The ID of the product, e.g. "app:com.google.android.gm".
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :language (String): The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.Product{}} on success {:error, info} on failure
androidenterprise_products_get_app_restrictions_schema(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.AppRestrictionsSchema.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 (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- product_id (String): The ID of the product.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :language (String): The BCP47 tag for the user's preferred language (e.g. "en-US", "de").
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.AppRestrictionsSchema{}} on success {:error, info} on failure
androidenterprise_products_get_permissions(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.ProductPermissions.t} | {:error, Tesla.Env.t}
Retrieves the Android app permissions required by this app.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- product_id (String): The ID of the product.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.ProductPermissions{}} on success {:error, info} on failure
androidenterprise_products_list(Tesla.Env.client, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.ProductsListResponse.t} | {:error, Tesla.Env.t}
Finds approved products that match a query, or all approved products if there is no query.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :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.
- :max_results (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.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.ProductsListResponse{}} on success {:error, info} on failure
androidenterprise_products_unapprove(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, nil} | {:error, Tesla.Env.t}
Unapproves the specified product (and the relevant app permissions, if any)
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- product_id (String): The ID of the product.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %{}} on success {:error, info} on failure