Add properties_list and test

Author: jradcliff

CONTRIBUTING.md

@@ -35,15 +35,14 @@ accept your pull requests.
 
 Write samples according to the [sample style guide](https://googlecloudplatform.github.io/samples-style-guide/).
 
-## Testing your code changes.
+## Testing your code changes
 
 ### Install dependencies
 
-To run the tests in a samples directory, you will need to install
-[Composer](http://getcomposer.org/doc/00-intro.md).
-
-First install dependencies as described in the
-[README.md](google-analytics-data/README.md).
+Change into the directory of the project you want to test (either
+`google-analytics-admin` or `google-analytics-data`), configure
+[Composer](http://getcomposer.org/doc/00-intro.md) and install dependencies as
+described in the directory's `README.md`.
 
 ### Environment variables
 Some tests require specific environment variables to run. PHPUnit will skip the tests
@@ -54,12 +53,15 @@ to run against any sample project as follows:
 ```
 export GOOGLE_PROJECT_ID=YOUR_PROJECT_ID
 export GA_TEST_PROPERTY_ID=YOUR_GA4_PROPERTY_ID
+# This value is only required by Admin API samples tests.
+export GA_TEST_ACCOUNT_ID=
 ```
 
 ### Run the tests
 
 Once the dependencies are installed and the environment variables set, you can run the
-tests in a samples directory.
+tests in a samples directory. For example:
+
 ```
 cd google-analytics-data
 # Execute the "phpunit" installed for the shared dependencies

README.md

@@ -2,8 +2,10 @@
 
 PHP samples for [Google Analytics APIs][ga].
 
-Check out the [`README.md`](google-analytics-data/README.md) in the
-`google-analytics-data` directory to get started.
+Check out the `README.md` in one of the following directories to get started:
+
+- Admin API: [README.md](google-analytics-admin/README.md)
+- Data API: [README.md](google-analytics-data/README.md)
 
 ## Contributing
 

google-analytics-admin/quickstart.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2021 Google LLC.
+ * Copyright 2024 Google LLC.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,19 +15,20 @@
  * limitations under the License.
  */
 
-/* Google Analytics Admin API sample quickstart application.
-
-This application demonstrates the usage of the Analytics Admin API to list
-all Google Analytics accounts available to the authenticated user, using
-service account credentials.
-
-Before you start the application, please review the comments starting with
-"TODO(developer)" and update the code to use the correct values.
-
-Usage:
-  composer update
-  php quickstart.php
- */
+/**
+ * Google Analytics Admin API sample quickstart application.
+ *
+ * This application demonstrates the usage of the Analytics Admin API to list
+ * all Google Analytics accounts available to the authenticated user, using
+ * service account credentials.
+ *
+ * Before you start the application, please review the comments starting with
+ * "TODO(developer)" and update the code to use the correct values.
+ *
+ * Usage:
+ * composer update
+ * php quickstart.php
+*/
 
 // [START analytics_admin_quickstart]
 require 'vendor/autoload.php';

google-analytics-admin/src/properties_list.php

@@ -0,0 +1,69 @@
+<?php
+
+/**
+ * Copyright 2024 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Google Analytics Admin API sample application which prints Google Analytics 4
+ * properties under the specified parent account that are available to the
+ * current user.
+ *
+ * See
+ * https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties/list
+ * for more information.
+ */
+
+namespace Google\Analytics\Admin\Samples;
+
+// [START analyticsadmin_properties_list]
+use Google\Analytics\Admin\V1beta\Client\AnalyticsAdminServiceClient;
+use Google\Analytics\Admin\V1beta\ListPropertiesRequest;
+
+/**
+ * @param string $accountId Your GA-4 Account ID
+ */
+function properties_list(string $accountId)
+{
+    // Create an instance of the Google Analytics Admin API client library.
+    $client = new AnalyticsAdminServiceClient();
+
+    // Make an API call.
+    $request = (new ListPropertiesRequest())
+        ->setFilter('parent:accounts/' . $accountId)
+        ->setShowDeleted(true);
+    $response = $client->listProperties($request);
+
+    print 'Result:' . PHP_EOL;
+    $i = 0;
+    foreach($response->iterateAllElements() as $property) {
+        printf('Property #%d resource name: %s, parent: %s, display name: "%s", currency: %s, time zone: %s, create time: %s, update time: %s%s',
+            $i++,
+            $property->getName(),
+            $property->getParent(),
+            $property->getDisplayName(),
+            $property->getCurrencyCode(),
+            $property->getTimeZone(),
+            $property->getCreateTime()->getSeconds(),
+            $property->getUpdateTime()->getSeconds(),
+            PHP_EOL,
+        );
+    }
+}
+// [END analyticsadmin_properties_list]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../testing/sample_helpers.php';
+return \Google\Analytics\Admin\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

google-analytics-admin/test/analyticsAdminTest.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * Copyright 2022 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\Analytics\Admin\Samples\Tests;
+
+use Google\Cloud\TestUtils\TestTrait;
+use PHPUnit\Framework\TestCase;
+
+class AnalyticsAdminTest extends TestCase
+{
+    use TestTrait;
+
+    public function testPropertiesList()
+    {
+        $accountId = self::requireEnv('GA_TEST_ACCOUNT_ID');
+        $output = $this->runFunctionSnippet('properties_list', [$accountId]);
+
+        $this->assertStringContainsString('Result:', $output);
+    }
+
+}