Documentation

Google_Service_AndroidEnterprise_Resource_Products extends Google_Service_Resource
in package

Application

The "products" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
approve() : mixed: 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.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
generateApprovalUrl() : Google_Service_AndroidEnterprise_ProductsGenerateApprovalUrlResponse: 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.
get() : Google_Service_AndroidEnterprise_Product: Retrieves details of a product for display to an enterprise admin.
getAppRestrictionsSchema() : Google_Service_AndroidEnterprise_AppRestrictionsSchema: 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. (products.getAppRestrictionsSchema)
getPermissions() : Google_Service_AndroidEnterprise_ProductPermissions: Retrieves the Android app permissions required by this app.
listProducts() : Google_Service_AndroidEnterprise_ProductsListResponse: Finds approved products that match a query, or all approved products if there is no query. (products.listProducts)
unapprove() : mixed: Unapproves the specified product (and the relevant app permissions, if any) (products.unapprove)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

approve()

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.


    public
                approve(string $enterpriseId, string $productId, Google_Service_AndroidEnterprise_ProductsApproveRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed

(products.approve)

Parameters

$enterpriseId : string: The ID of the enterprise.
$productId : string: The ID of the product.
$postBody : Google_Service_AndroidEnterprise_ProductsApproveRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

generateApprovalUrl()

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.


    public
                generateApprovalUrl(string $enterpriseId, string $productId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_ProductsGenerateApprovalUrlResponse

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

$enterpriseId : string: The ID of the enterprise.
$productId : string: The ID of the product.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_ProductsGenerateApprovalUrlResponse —

get()

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


    public
                get(string $enterpriseId, string $productId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_Product

(products.get)

Parameters

$enterpriseId : string: The ID of the enterprise.
$productId : string: The ID of the product, e.g. "app:com.google.android.gm".
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_Product —

getAppRestrictionsSchema()

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


    public
                getAppRestrictionsSchema(string $enterpriseId, string $productId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_AppRestrictionsSchema

Parameters

$enterpriseId : string: The ID of the enterprise.
$productId : string: The ID of the product.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_AppRestrictionsSchema —

getPermissions()

Retrieves the Android app permissions required by this app.


    public
                getPermissions(string $enterpriseId, string $productId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_ProductPermissions

(products.getPermissions)

Parameters

$enterpriseId : string: The ID of the enterprise.
$productId : string: The ID of the product.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_ProductPermissions —

listProducts()

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


    public
                listProducts(string $enterpriseId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_ProductsListResponse

Parameters

$enterpriseId : string: The ID of the enterprise.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_ProductsListResponse —

unapprove()

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


    public
                unapprove(string $enterpriseId, string $productId[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$enterpriseId : string: The ID of the enterprise.
$productId : string: The ID of the product.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —