Feature Description

Issue 1/3 to fix the bug #8888.

Add the new Audience_Settings class and datapoints, and corresponding GET/POST REST endpoints.

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• A new Audience_Settings PHP settings class should be created.
• The settings should be site-wide, i.e. it should use the options DB table for persistence.
• It should manage the audience settings that are currently handled in the Modules\Analytics_4\Settings class:
  • availableAudiences
  • availableAudiencesLastSyncedAt
  • audienceSegmentationSetupCompletedBy
• REST endpoints GET:audience-settings and POST:save-audience-settings for fetching and updating the settings should be added to the Analytics_4 module.
• Use of the existing settings needn't be replaced as part of this issue, this will happen via Syncing audiences and custom dimensions in parallel can result in the cached audiences not being persisted #8888.

Implementation Brief

Extract Audience Settings to new Options Key

Note: this ticket creates the new settings store but does not yet implement it. This will be done later in #8888

• Create a new settings class includes/Modules/Analytics_4/Audience_Settings.php, extending Core\Storage\Setting and implementing Setting_With_ViewOnly_Keys_Interface, using the standard settings class pattern:

  • The OPTION should be googlesitekit_analytics-4_audience_settings.
  • get_view_only_keys should return an array containing availableAudiences and audienceSegmentationSetupCompletedBy.
  • get_default should return an array containing:
    

    site-kit-wp/includes/Modules/Analytics_4/Settings.php

    Lines 109 to 111 in ea76d2b

    	'availableAudiences' => null,
    	'availableAudiencesLastSyncedAt' => 0,
    	'audienceSegmentationSetupCompletedBy' => null,

  • get_sanitize_callback should implement the standard pattern copying these key setting conditions:
    

    site-kit-wp/includes/Modules/Analytics_4/Settings.php

    Lines 199 to 215 in ea76d2b

    	if ( isset( $option['availableAudiences'] ) ) {
    	if ( ! is_array( $option['availableAudiences'] ) ) {
    	$option['availableAudiences'] = null;
    	}
    	}
    	if ( isset( $option['availableAudiencesLastSyncedAt'] ) ) {
    	if ( ! is_int( $option['availableAudiencesLastSyncedAt'] ) ) {
    	$option['availableAudiencesLastSyncedAt'] = 0;
    	}
    	}
    	if ( isset( $option['audienceSegmentationSetupCompletedBy'] ) ) {
    	if ( ! is_int( $option['audienceSegmentationSetupCompletedBy'] ) ) {
    	$option['audienceSegmentationSetupCompletedBy'] = null;
    	}
    	}

• Update includes/Modules/Analytics_4.php:

  • Create a new const $audience_settings.
  • Within the register method:
    • Keep this line which will preload the GET:audience-settings datapoint.
  • Update the get_datapoint_definitions method adding two new REST datapoints:
    • GET:audience-settings, setting 'shareable' => true.
    • POST:save-audience-settings
  • Update the create_data_request method:
    • For GET:audience-settings requests:
      • Check for plugin manage options permissions using current_user_can( Permissions::MANAGE_OPTIONS );:
        • If true, return all of the settings field.
        • If false, use array_intersect_key and $audience_settings->get_view_only_keys() to filter and return only the view only keys.
    • For POST:save-audience-settings requests, update the value of audienceSegmentationSetupCompletedBy.
  • Update parse_data_response method to parse and return the responses for each of the new endpoints.

Test Coverage

• Create new Settings tests for the includes/Modules/Analytics_4/Audience_Settings.php class modelled on other settings tests.

QA Brief

1. Ensure that Basic Authentication plugin is installed and activated.

2. Open POSTman or any similar API testing tool. Set the Authorization to basic auth and add username and password.

3. Trigger a GET request to https://example.com/wp-json/google-site-kit/v1/modules/analytics-4/data/audience-settings, replace domain name with appropriate one. It should return following response.

  {
      "availableAudiences": null,
      "audienceSegmentationSetupCompletedBy": null,
      "availableAudiencesLastSyncedAt": 0
  }

4. Similarly, setup a POST request to https://example.com/wp-json/google-site-kit/v1/modules/analytics-4/data/save-audience-settings, replace domain name with appropriate one and add following body as JSON payload.

  {
    "data": {
        "audienceSegmentationSetupCompletedBy": 9999,
    }
  }

Once successful, you shall receive the following payload.

{
    "availableAudiences": null,
    "availableAudiencesLastSyncedAt": 0,
    "audienceSegmentationSetupCompletedBy": 9999
}

Notice that only audienceSegmentationSetupCompletedBy can currently be updated as per the AC.

5. Hit the GET endpoint mentioned above and there should be audienceSegmentationSetupCompletedBy set as in POST request.

Changelog entry

• Add a new option for audience settings, with REST endpoints to retrieve and update it.