Google_Service_AndroidEnterprise_Products_Resource Class Reference

The "products" collection of methods. More...

Inheritance diagram for Google_Service_AndroidEnterprise_Products_Resource:

Public Member Functions
	approve ($enterpriseId, $productId, Google_Service_AndroidEnterprise_ProductsApproveRequest $postBody, $optParams=array())
	Approves the specified product (and the relevant app permissions, if any).
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	generateApprovalUrl ($enterpriseId, $productId, $optParams=array())
	Generates a URL that can be rendered in an iframe to display the permissions (if any) of a product.
	get ($enterpriseId, $productId, $optParams=array())
	Retrieves details of a product for display to an enterprise admin.
	getAppRestrictionsSchema ($enterpriseId, $productId, $optParams=array())
	Retrieves the schema defining app restrictions configurable for this product.
	getPermissions ($enterpriseId, $productId, $optParams=array())
	Retrieves the Android app permissions required by this app.
	updatePermissions ($enterpriseId, $productId, Google_Service_AndroidEnterprise_ProductPermissions $postBody, $optParams=array())
	Updates the set of Android app permissions for this app that have been accepted by the enterprise.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "products" collection of methods.

Typical usage is: $androidenterpriseService = new Google_Service_AndroidEnterprise(...); $products = $androidenterpriseService->products;

Member Function Documentation

approve()

Google_Service_AndroidEnterprise_Products_Resource::approve	(		$enterpriseId,
			$productId,
		Google_Service_AndroidEnterprise_ProductsApproveRequest	$postBody,
			$optParams = array() )

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

(products.approve)

Parameters

string	$enterpriseId	The ID of the enterprise.
string	$productId	The ID of the product.
Google_ProductsApproveRequest	$postBody
array	$optParams	Optional parameters.

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

generateApprovalUrl()

Google_Service_AndroidEnterprise_Products_Resource::generateApprovalUrl	(		$enterpriseId,
			$productId,
			$optParams = array() )

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. (products.generateApprovalUrl)

Parameters

string	$enterpriseId	The ID of the enterprise.
string	$productId	The ID of the product.
array	$optParams	Optional parameters.

@opt_param string languageCode The BCP 47 language code used for permission names and descriptions in the returned iframe, for instance "en-US".

Return values

Google_Service_AndroidEnterprise_ProductsGenerateApprovalUrlResponse

get()

Google_Service_AndroidEnterprise_Products_Resource::get	(		$enterpriseId,
			$productId,
			$optParams = array() )

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

(products.get)

Parameters

string	$enterpriseId	The ID of the enterprise.
string	$productId	The ID of the product, e.g. "app:com.google.android.gm".
array	$optParams	Optional parameters.

@opt_param string language The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

Return values

Google_Service_AndroidEnterprise_Product

getAppRestrictionsSchema()

Google_Service_AndroidEnterprise_Products_Resource::getAppRestrictionsSchema	(		$enterpriseId,
			$productId,
			$optParams = array() )

Retrieves the schema defining app restrictions configurable for this product.

All products have a schema, but this may be empty if no app restrictions are defined. (products.getAppRestrictionsSchema)

Parameters

string	$enterpriseId	The ID of the enterprise.
string	$productId	The ID of the product.
array	$optParams	Optional parameters.

@opt_param string language The BCP47 tag for the user's preferred language (e.g. "en-US", "de").

Return values

Google_Service_AndroidEnterprise_AppRestrictionsSchema

getPermissions()

Google_Service_AndroidEnterprise_Products_Resource::getPermissions	(		$enterpriseId,
			$productId,
			$optParams = array() )

Retrieves the Android app permissions required by this app.

(products.getPermissions)

Parameters

string	$enterpriseId	The ID of the enterprise.
string	$productId	The ID of the product.
array	$optParams	Optional parameters.

Return values

Google_Service_AndroidEnterprise_ProductPermissions

updatePermissions()

Google_Service_AndroidEnterprise_Products_Resource::updatePermissions	(		$enterpriseId,
			$productId,
		Google_Service_AndroidEnterprise_ProductPermissions	$postBody,
			$optParams = array() )

Updates the set of Android app permissions for this app that have been accepted by the enterprise.

(products.updatePermissions)

Parameters

string	$enterpriseId	The ID of the enterprise.
string	$productId	The ID of the product.
Google_ProductPermissions	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_AndroidEnterprise_ProductPermissions

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/AndroidEnterprise.php