UcpSettingsService

Service for Universal Commerce Protocol (UCP) settings management.

Allows businesses and service providers to programmatically provision and manage the UCP profile URL for themselves or their clients' Merchant Center accounts. For step-by-step instructions, see the UCP checkout setup guide.

This service uses two resources:

  • UcpSettings: Represents the persistent UCP enablement state, configuration, and validated profile for a Merchant Center account's ucp-integration program.
  • Operation: Represents the asynchronous long-running validation operation returned by UpdateUcpSettings.
GetUcpSettings

rpc GetUcpSettings(GetUcpSettingsRequest) returns (UcpSettings)

Retrieves the currently stored, validated UcpSettings for a Merchant Center account.

To check the status of an asynchronous validation operation initiated by UpdateUcpSettings, use GetOperation instead.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
UpdateUcpSettings

rpc UpdateUcpSettings(UpdateUcpSettingsRequest) returns (Operation)

Patches the UCP settings for a Merchant Center account.

This is a non-blocking method that queues asynchronous validation of the UCP profile at the well_known_uri and immediately returns a long-running Operation with done set to false and metadata set to UcpSettingsOperationMetadata.

You can poll the operation status using GetOperation with the returned operation name (formatted as accounts/{account}/programs/ucp-integration/ucpSettings/operations/{operation}). When validation finishes (done is true):

  • If validation succeeds, the settings are stored and the operation's response field contains the updated UcpSettings resource, including the parsed ucp_profile.
  • If validation fails, the settings are not updated and the operation's error field contains a Status message describing the validation failure.

For more information, see the UCP checkout setup guide.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.