* $analyticsadminService = new Google\Service\GoogleAnalyticsAdmin(...); * $accounts = $analyticsadminService->accounts; * */ class Accounts extends \Google\Site_Kit_Dependencies\Google\Service\Resource { /** * Marks target Account as soft-deleted (ie: "trashed") and returns it. This API * does not have a method to restore soft-deleted accounts. However, they can be * restored using the Trash Can UI. If the accounts are not restored before the * expiration time, the account and all child resources (eg: Properties, * GoogleAdsLinks, Streams, UserLinks) will be permanently purged. * https://support.google.com/analytics/answer/6154772 Returns an error if the * target is not found. (accounts.delete) * * @param string $name Required. The name of the Account to soft-delete. Format: * accounts/{account} Example: "accounts/100" * @param array $optParams Optional parameters. * @return GoogleProtobufEmpty */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = \array_merge($params, $optParams); return $this->call('delete', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleProtobufEmpty::class); } /** * Lookup for a single Account. (accounts.get) * * @param string $name Required. The name of the account to lookup. Format: * accounts/{account} Example: "accounts/100" * @param array $optParams Optional parameters. * @return GoogleAnalyticsAdminV1alphaAccount */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = \array_merge($params, $optParams); return $this->call('get', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaAccount::class); } /** * Get data sharing settings on an account. Data sharing settings are * singletons. (accounts.getDataSharingSettings) * * @param string $name Required. The name of the settings to lookup. Format: * accounts/{account}/dataSharingSettings Example: * "accounts/1000/dataSharingSettings" * @param array $optParams Optional parameters. * @return GoogleAnalyticsAdminV1alphaDataSharingSettings */ public function getDataSharingSettings($name, $optParams = []) { $params = ['name' => $name]; $params = \array_merge($params, $optParams); return $this->call('getDataSharingSettings', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaDataSharingSettings::class); } /** * Returns all accounts accessible by the caller. Note that these accounts might * not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are * excluded by default. Returns an empty list if no relevant accounts are found. * (accounts.listAccounts) * * @param array $optParams Optional parameters. * * @opt_param int pageSize The maximum number of resources to return. The * service may return fewer than this value, even if there are additional pages. * If unspecified, at most 50 resources will be returned. The maximum value is * 200; (higher values will be coerced to the maximum) * @opt_param string pageToken A page token, received from a previous * `ListAccounts` call. Provide this to retrieve the subsequent page. When * paginating, all other parameters provided to `ListAccounts` must match the * call that provided the page token. * @opt_param bool showDeleted Whether to include soft-deleted (ie: "trashed") * Accounts in the results. Accounts can be inspected to determine whether they * are deleted or not. * @return GoogleAnalyticsAdminV1alphaListAccountsResponse */ public function listAccounts($optParams = []) { $params = []; $params = \array_merge($params, $optParams); return $this->call('list', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaListAccountsResponse::class); } /** * Updates an account. (accounts.patch) * * @param string $name Output only. Resource name of this account. Format: * accounts/{account} Example: "accounts/100" * @param GoogleAnalyticsAdminV1alphaAccount $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Required. The list of fields to be updated. * Field names must be in snake case (e.g., "field_to_update"). Omitted fields * will not be updated. To replace the entire entity, use one path with the * string "*" to match all fields. * @return GoogleAnalyticsAdminV1alphaAccount */ public function patch($name, \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaAccount $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = \array_merge($params, $optParams); return $this->call('patch', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaAccount::class); } /** * Requests a ticket for creating an account. (accounts.provisionAccountTicket) * * @param GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest $postBody * @param array $optParams Optional parameters. * @return GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse */ public function provisionAccountTicket(\Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest $postBody, $optParams = []) { $params = ['postBody' => $postBody]; $params = \array_merge($params, $optParams); return $this->call('provisionAccountTicket', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse::class); } /** * Searches through all changes to an account or its children given the * specified set of filters. (accounts.searchChangeHistoryEvents) * * @param string $account Required. The account resource for which to return * change history resources. * @param GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest $postBody * @param array $optParams Optional parameters. * @return GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse */ public function searchChangeHistoryEvents($account, \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest $postBody, $optParams = []) { $params = ['account' => $account, 'postBody' => $postBody]; $params = \array_merge($params, $optParams); return $this->call('searchChangeHistoryEvents', [$params], \Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. \class_alias(\Google\Site_Kit_Dependencies\Google\Service\GoogleAnalyticsAdmin\Resource\Accounts::class, 'Google\\Site_Kit_Dependencies\\Google_Service_GoogleAnalyticsAdmin_Resource_Accounts');