Get product stats using the Merchant Center report query

src/API/Google/MerchantReport.php

@@ -6,6 +6,7 @@
 use Automattic\WooCommerce\Admin\API\Reports\TimeInterval;
 use Automattic\WooCommerce\GoogleListingsAndAds\API\Google\Query\MerchantFreeListingReportQuery;
 use Automattic\WooCommerce\GoogleListingsAndAds\API\Google\Query\MerchantProductReportQuery;
+use Automattic\WooCommerce\GoogleListingsAndAds\API\Google\Query\MerchantProductViewReportQuery;
 use Automattic\WooCommerce\GoogleListingsAndAds\Exception\InvalidValue;
 use Automattic\WooCommerce\GoogleListingsAndAds\Options\OptionsAwareInterface;
 use Automattic\WooCommerce\GoogleListingsAndAds\Options\OptionsAwareTrait;
@@ -14,6 +15,8 @@
 use Automattic\WooCommerce\GoogleListingsAndAds\Vendor\Google\Service\ShoppingContent;
 use Automattic\WooCommerce\GoogleListingsAndAds\Vendor\Google\Service\ShoppingContent\ReportRow;
 use Automattic\WooCommerce\GoogleListingsAndAds\Vendor\Google\Service\ShoppingContent\Segments;
+use Automattic\WooCommerce\GoogleListingsAndAds\Value\MCStatus;
+use Automattic\WooCommerce\GoogleListingsAndAds\API\Google\ShoppingContentDateTrait;
 use DateTime;
 use Exception;
 
@@ -26,6 +29,7 @@ class MerchantReport implements OptionsAwareInterface {
 
 	use OptionsAwareTrait;
 	use ReportTrait;
+	use ShoppingContentDateTrait;
 
 	/**
 	 * The shopping service.
@@ -52,6 +56,87 @@ public function __construct( ShoppingContent $service, ProductHelper $product_he
 		$this->product_helper = $product_helper;
 	}
 
+	/**
+	 * Get ProductView Query response.
+	 *
+	 * @param string|null $next_page_token The next page token.
+	 * @return array Associative array with product statuses and the next page token.
+	 *
+	 * @throws Exception If the product view report data can't be retrieved.
+	 */
+	public function get_product_view_report( $next_page_token = null ): array {
+		$batch_size = apply_filters( 'woocommerce_gla_product_view_report_page_size', 1000 );
+
+		try {
+			$product_view_data = [
+				'statuses'  => [],
+				'next_page' => null,
+			];
+
+			$query = new MerchantProductViewReportQuery(
+				[
+					'next_page' => $next_page_token,
+					'per_page'  => $batch_size,
+				]
+			);
+
+			$response = $query
+			->set_client( $this->service, $this->options->get_merchant_id() )
+			->get_results();
+
+			foreach ( $response->getResults() as $row ) {
+
+				/** @var ProductView $product_view  */
+				$product_view = $row->getProductView();
+
+				$wc_product_id     = $this->product_helper->get_wc_product_id( $product_view->getId() );
+				$mc_product_status = $this->convert_aggregated_status_to_mc_status( $product_view->getAggregatedDestinationStatus() );
+
+				// Skip if the product id does not exist
+				if ( ! $wc_product_id ) {
+					continue;
+				}
+
+				$product_view_data['statuses'][] = [
+					'product_id'      => $wc_product_id,
+					'status'          => $mc_product_status,
+					'expiration_date' => $this->convert_shopping_content_date( $product_view->getExpirationDate() ),
+				];
+
+			}
+
+			$product_view_data['next_page'] = $response->getNextPageToken();
+
+			return $product_view_data;
+		} catch ( GoogleException $e ) {
+			do_action( 'woocommerce_gla_mc_client_exception', $e, __METHOD__ );
+			throw new Exception( __( 'Unable to retrieve Product View Report.', 'google-listings-and-ads' ) . $e->getMessage(), $e->getCode() );
+		}
+	}
+
+	/**
+	 * Convert the product view aggregated status to the MC status.
+	 *
+	 * @param string $status The aggregated status of the product.
+	 *
+	 * @return string The MC status.
+	 */
+	protected function convert_aggregated_status_to_mc_status( string $status ): string {
+		switch ( $status ) {
+			case 'ELIGIBLE':
+				return MCStatus::APPROVED;
+			case 'ELIGIBLE_LIMITED':
+				return MCStatus::PARTIALLY_APPROVED;
+			case 'NOT_ELIGIBLE_OR_DISAPPROVED':
+				return MCStatus::DISAPPROVED;
+			case 'PENDING':
+				return MCStatus::PENDING;
+			default:
+				return MCStatus::NOT_SYNCED;
+		}
+	}
+
+
 	/**
 	 * Get report data for free listings.
 	 *

src/API/Google/Query/MerchantProductViewReportQuery.php

@@ -0,0 +1,54 @@
+<?php
+declare( strict_types=1 );
+
+namespace Automattic\WooCommerce\GoogleListingsAndAds\API\Google\Query;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Class MerchantProductViewReportQuery
+ *
+ * @package Automattic\WooCommerce\GoogleListingsAndAds\API\Google\Query
+ */
+class MerchantProductViewReportQuery extends MerchantQuery {
+
+	use ReportQueryTrait;
+
+	/**
+	 * Query constructor.
+	 *
+	 * @param array $args Query arguments.
+	 */
+	public function __construct( array $args ) {
+		parent::__construct( 'ProductView' );
+		$this->set_initial_columns();
+		$this->handle_query_args( $args );
+	}
+
+
+	/**
+	 * Filter the query by a list of ID's.
+	 *
+	 * @param array $ids list of ID's to filter by.
+	 *
+	 * @return $this
+	 */
+	public function filter( array $ids ): QueryInterface {
+		// No filtering used for product view report.
+		return $this;
+	}
+
+	/**
+	 * Set the initial columns for this query.
+	 */
+	protected function set_initial_columns() {
+		$this->columns(
+			[
+				'id'              => 'product_view.id',
+				'offer_id'        => 'product_view.offer_id',
+				'expiration_date' => 'product_view.expiration_date',
+				'status'          => 'product_view.aggregated_destination_status',
+			]
+		);
+	}
+}

src/API/Google/ShoppingContentDateTrait.php

@@ -0,0 +1,28 @@
+<?php
+declare( strict_types=1 );
+
+namespace Automattic\WooCommerce\GoogleListingsAndAds\API\Google;
+
+use Automattic\WooCommerce\GoogleListingsAndAds\Vendor\Google\Service\ShoppingContent\Date as ShoppingContentDate;
+use DateTime;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Trait ShoppingContentDateTrait
+ *
+ * @package Automattic\WooCommerce\GoogleListingsAndAds\API\Google
+ */
+trait ShoppingContentDateTrait {
+
+	/**
+	 * Convert ShoppingContentDate to DateTime.
+	 *
+	 * @param ShoppingContentDate $date The Google date.
+	 *
+	 * @return DateTime|false The date converted or false if the date is invalid.
+	 */
+	protected function convert_shopping_content_date( ShoppingContentDate $date ) {
+		return DateTime::createFromFormat( 'Y-m-d|', "{$date->getYear()}-{$date->getMonth()}-{$date->getDay()}" );
+	}
+}

src/Internal/DependencyManagement/JobServiceProvider.php

@@ -9,6 +9,7 @@
 use Automattic\WooCommerce\GoogleListingsAndAds\ActionScheduler\ActionSchedulerInterface;
 use Automattic\WooCommerce\GoogleListingsAndAds\ActionScheduler\AsyncActionRunner;
 use Automattic\WooCommerce\GoogleListingsAndAds\API\Google\Settings as GoogleSettings;
+use Automattic\WooCommerce\GoogleListingsAndAds\API\Google\MerchantReport;
 use Automattic\WooCommerce\GoogleListingsAndAds\Exception\InvalidClass;
 use Automattic\WooCommerce\GoogleListingsAndAds\Exception\ValidateInterface;
 use Automattic\WooCommerce\GoogleListingsAndAds\Infrastructure\Service;
@@ -33,6 +34,7 @@
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\Update\PluginUpdate;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\UpdateShippingSettings;
 use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\UpdateSyncableProductsCount;
+use Automattic\WooCommerce\GoogleListingsAndAds\Jobs\UpdateMerchantProductStatuses;
 use Automattic\WooCommerce\GoogleListingsAndAds\MerchantCenter\MerchantCenterService;
 use Automattic\WooCommerce\GoogleListingsAndAds\Coupon\CouponHelper;
 use Automattic\WooCommerce\GoogleListingsAndAds\Coupon\CouponSyncer;
@@ -42,6 +44,7 @@
 use Automattic\WooCommerce\GoogleListingsAndAds\Product\ProductSyncer;
 use Automattic\WooCommerce\GoogleListingsAndAds\Event\StartProductSync;
 use Automattic\WooCommerce\GoogleListingsAndAds\Coupon;
+use Automattic\WooCommerce\GoogleListingsAndAds\MerchantCenter\MerchantStatuses;
 use Automattic\WooCommerce\GoogleListingsAndAds\Product;
 use Automattic\WooCommerce\GoogleListingsAndAds\Proxies\WC;
 use Automattic\WooCommerce\GoogleListingsAndAds\Shipping;
@@ -144,6 +147,8 @@ public function register(): void {
 
 		// Share update syncable products count job
 		$this->share_action_scheduler_job( UpdateSyncableProductsCount::class, ProductRepository::class, ProductHelper::class );
+
+		$this->share_action_scheduler_job( UpdateMerchantProductStatuses::class, MerchantCenterService::class, MerchantReport::class, MerchantStatuses::class );
 	}
 
 	/**

src/Jobs/UpdateMerchantProductStatuses.php

@@ -0,0 +1,118 @@
+<?php
+declare( strict_types=1 );
+
+namespace Automattic\WooCommerce\GoogleListingsAndAds\Jobs;
+
+use Automattic\WooCommerce\GoogleListingsAndAds\ActionScheduler\ActionSchedulerInterface;
+use Automattic\WooCommerce\GoogleListingsAndAds\MerchantCenter\MerchantCenterService;
+use Automattic\WooCommerce\GoogleListingsAndAds\API\Google\MerchantReport;
+use Automattic\WooCommerce\GoogleListingsAndAds\MerchantCenter\MerchantStatuses;
+
+defined( 'ABSPATH' ) || exit;
+
+/**
+ * Class UpdateMerchantProductStatuses
+ *
+ * Update Product Stats
+ *
+ * Note: The job will not start if it is already running or if the Google Merchant Center account is not connected.
+ *
+ * @package Automattic\WooCommerce\GoogleListingsAndAds\Jobs
+ *
+ * @since x.x.x
+ */
+class UpdateMerchantProductStatuses extends AbstractActionSchedulerJob {
+	/**
+	 * @var MerchantCenterService
+	 */
+	protected $merchant_center;
+
+	/**
+	 * @var MerchantReport
+	 */
+	protected $merchant_report;
+
+	/**
+	 * @var MerchantStatuses
+	 */
+
+	protected $merchant_statuses;
+
+	/**
+	 * UpdateShippingSettings constructor.
+	 *
+	 * @param ActionSchedulerInterface  $action_scheduler
+	 * @param ActionSchedulerJobMonitor $monitor
+	 * @param MerchantCenterService     $merchant_center
+	 * @param MerchantReport            $merchant_report
+	 * @param MerchantStatuses          $merchant_statuses
+	 */
+	public function __construct( ActionSchedulerInterface $action_scheduler, ActionSchedulerJobMonitor $monitor, MerchantCenterService $merchant_center, MerchantReport $merchant_report, MerchantStatuses $merchant_statuses ) {
+		parent::__construct( $action_scheduler, $monitor );
+		$this->merchant_center   = $merchant_center;
+		$this->merchant_report   = $merchant_report;
+		$this->merchant_statuses = $merchant_statuses;
+	}
+
+	/**
+	 * Get the name of the job.
+	 *
+	 * @return string
+	 */
+	public function get_name(): string {
+		return 'update_merchant_product_statuses';
+	}
+
+	/**
+	 * Can the job be scheduled.
+	 *
+	 * @param array|null $args
+	 *
+	 * @return bool Returns true if the job can be scheduled.
+	 */
+	public function can_schedule( $args = [] ): bool {
+		return parent::can_schedule( $args ) && $this->merchant_center->is_connected();
+	}
+
+	/**
+	 * Process the job.
+	 *
+	 * @param int[] $items An array of job arguments.
+	 *
+	 * @throws JobException If the shipping settings cannot be synced.
+	 */
+	public function process_items( array $items ) {
+		$next_page_token = null;
+
+		do {
+			$results = $this->merchant_report->get_product_view_report( $next_page_token );
+
+			$this->merchant_statuses->process_product_statuses( $results['statuses'] );
+
+			$next_page_token = $results['next_page'];
+
+		} while ( $next_page_token );
+
+		$this->merchant_statuses->update_product_stats();
+	}
+
+	/**
+	 * Schedule the job.
+	 *
+	 * @param array $args - arguments.
+	 */
+	public function schedule( array $args = [] ) {
+		if ( $this->can_schedule() ) {
+			$this->action_scheduler->schedule_immediate( $this->get_process_item_hook() );
+		}
+	}
+
+	/**
+	 * The job is considered to be scheduled if the "process_item" action is currently pending or in-progress.
+	 *
+	 * @return bool
+	 */
+	public function is_scheduled(): bool {
+		return $this->is_running();
+	}
+}