Google_ManagementProfileUserLinksServiceResource
The "profileUserLinks" collection of methods.
Defined (1)
The class is defined in the following location(s).
- /src/contrib/Google_AnalyticsService.php
- class Google_ManagementProfileUserLinksServiceResource extends Google_ServiceResource {
- /**
- * Removes a user from the given view (profile). (profileUserLinks.delete)
- *
- * @param string $accountId Account ID to delete the user link for.
- * @param string $webPropertyId Web Property ID to delete the user link for.
- * @param string $profileId View (Profile) ID to delete the user link for.
- * @param string $linkId Link ID to delete the user link for.
- * @param array $optParams Optional parameters.
- */
- public function delete($accountId, $webPropertyId, $profileId, $linkId, $optParams = array()) {
- $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'linkId' => $linkId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('delete', array($params));
- return $data;
- }
- /**
- * Adds a new user to the given view (profile). (profileUserLinks.insert)
- *
- * @param string $accountId Account ID to create the user link for.
- * @param string $webPropertyId Web Property ID to create the user link for.
- * @param string $profileId View (Profile) ID to create the user link for.
- * @param Google_EntityUserLink $postBody
- * @param array $optParams Optional parameters.
- * @return Google_EntityUserLink
- */
- public function insert($accountId, $webPropertyId, $profileId, Google_EntityUserLink $postBody, $optParams = array()) {
- $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new Google_EntityUserLink($data);
- } else {
- return $data;
- }
- }
- /**
- * Lists profile-user links for a given view (profile). (profileUserLinks.list)
- *
- * @param string $accountId Account ID which the given view (profile) belongs to.
- * @param string $webPropertyId Web Property ID which the given view (profile) belongs to.
- * @param string $profileId View (Profile) ID to retrieve the profile-user links for
- * @param array $optParams Optional parameters.
- *
- * @opt_param int max-results The maximum number of profile-user links to include in this response.
- * @opt_param int start-index An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
- * @return Google_EntityUserLinks
- */
- public function listManagementProfileUserLinks($accountId, $webPropertyId, $profileId, $optParams = array()) {
- $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Google_EntityUserLinks($data);
- } else {
- return $data;
- }
- }
- /**
- * Updates permissions for an existing user on the given view (profile).
- * (profileUserLinks.update)
- *
- * @param string $accountId Account ID to update the user link for.
- * @param string $webPropertyId Web Property ID to update the user link for.
- * @param string $profileId View (Profile ID) to update the user link for.
- * @param string $linkId Link ID to update the user link for.
- * @param Google_EntityUserLink $postBody
- * @param array $optParams Optional parameters.
- * @return Google_EntityUserLink
- */
- public function update($accountId, $webPropertyId, $profileId, $linkId, Google_EntityUserLink $postBody, $optParams = array()) {
- $params = array('accountId' => $accountId, 'webPropertyId' => $webPropertyId, 'profileId' => $profileId, 'linkId' => $linkId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('update', array($params));
- if ($this->useObjects()) {
- return new Google_EntityUserLink($data);
- } else {
- return $data;
- }
- }
- }