Merchant API code sample to update checkout settings.
Java
// Copyright 2025 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
//
// https://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.
package
shopping.merchant.samples.accounts.checkoutsettings.v1
;
import
com.google.api.gax.core.FixedCredentialsProvider
;
import
com.google.auth.oauth2.GoogleCredentials
;
import
com.google.protobuf.FieldMask
;
import
com.google.shopping.merchant.accounts.v1.CheckoutSettings
;
import
com.google.shopping.merchant.accounts.v1.CheckoutSettingsName
;
import
com.google.shopping.merchant.accounts.v1.CheckoutSettingsServiceClient
;
import
com.google.shopping.merchant.accounts.v1.CheckoutSettingsServiceSettings
;
import
com.google.shopping.merchant.accounts.v1.UpdateCheckoutSettingsRequest
;
import
com.google.shopping.merchant.accounts.v1.UriSettings
;
import
com.google.shopping.type.Destination.DestinationEnum
;
import
shopping.merchant.samples.utils.Authenticator
;
import
shopping.merchant.samples.utils.Config
;
/**
* This class demonstrates how to update the checkout settings for a given Merchant Center account
*/
public
class
UpdateCheckoutSettingsSample
{
public
static
void
updateBusinessInfo
(
Config
config
)
throws
Exception
{
// Obtains OAuth token based on the user's configuration.
GoogleCredentials
credential
=
new
Authenticator
().
authenticate
();
// Creates service settings using the credentials retrieved above.
CheckoutSettingsServiceSettings
checkoutSettingsServiceSettings
=
CheckoutSettingsServiceSettings
.
newBuilder
()
.
setCredentialsProvider
(
FixedCredentialsProvider
.
create
(
credential
))
.
build
();
try
(
CheckoutSettingsServiceClient
checkoutSettingsServiceClient
=
CheckoutSettingsServiceClient
.
create
(
checkoutSettingsServiceSettings
))
{
String
accountId
=
config
.
getAccountId
().
toString
();
// The only valid programId for checkout settings is "checkout"
String
programId
=
"checkout"
;
String
name
=
CheckoutSettingsName
.
newBuilder
()
.
setAccount
(
accountId
)
.
setProgram
(
programId
)
.
build
()
.
toString
();
// Replace this with your checkout URL.
String
checkoutUrl
=
"https://myshopify.com/cart/1234:1"
;
CheckoutSettings
checkoutSettings
=
CheckoutSettings
.
newBuilder
()
.
setName
(
name
)
.
setUriSettings
(
UriSettings
.
newBuilder
().
setCheckoutUriTemplate
(
checkoutUrl
))
.
addEligibleDestinations
(
DestinationEnum
.
SHOPPING_ADS
)
.
build
();
FieldMask
fieldMask
=
FieldMask
.
newBuilder
().
addPaths
(
"uri_settings"
).
addPaths
(
"eligible_destinations"
).
build
();
UpdateCheckoutSettingsRequest
request
=
UpdateCheckoutSettingsRequest
.
newBuilder
()
.
setCheckoutSettings
(
checkoutSettings
)
.
setUpdateMask
(
fieldMask
)
.
build
();
System
.
out
.
println
(
"Sending update checkoutSettings request:"
);
CheckoutSettings
response
=
checkoutSettingsServiceClient
.
updateCheckoutSettings
(
request
);
System
.
out
.
println
(
"Updated Checkout Settings below:"
);
System
.
out
.
println
(
response
);
}
catch
(
Exception
e
)
{
System
.
out
.
println
(
"An error has occurred: "
);
System
.
out
.
println
(
e
);
}
}
public
static
void
main
(
String
[]
args
)
throws
Exception
{
Config
config
=
Config
.
load
();
updateBusinessInfo
(
config
);
}
}
PHP
< ?php
/**
* Copyright 2025 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
*
* https://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.
*/
require_once __DIR__ . '/../../../../vendor/autoload.php';
require_once __DIR__ . '/../../../Authentication/Authentication.php';
require_once __DIR__ . '/../../../Authentication/Config.php';
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;
use Google\Shopping\Merchant\Accounts\V1\CheckoutSettings;
use Google\Shopping\Merchant\Accounts\V1\Client\CheckoutSettingsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\UpdateCheckoutSettingsRequest;
use Google\Shopping\Merchant\Accounts\V1\UriSettings;
use Google\Shopping\Type\Destination\DestinationEnum;
/**
* This class demonstrates how to update the checkout settings for a given
* Merchant Center account.
*/
class UpdateCheckoutSettingsSample
{
/**
* Updates the checkout settings for a given Merchant Center account.
*
* @param array $config The configuration file for the Merchant Center account.
*
* @return void
*/
public static function updateCheckoutSettings(array $config): void
{
// Obtains OAuth credentials from the configuration file.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates a client.
$checkoutSettingsServiceClient = new CheckoutSettingsServiceClient([
'credentials' => $credentials
]);
// The only valid programId for checkout settings is "checkout".
$programId = 'checkout';
// Constructs the resource name format:
// `accounts/{account}/programs/{program}/checkoutSettings`.
$name = sprintf(
'accounts/%s/programs/%s/checkoutSettings',
$config['accountId'],
$programId
);
// Replace this with your checkout URL.
$checkoutUrl = 'https://myshopify.com/cart/1234:1';
// Creates the URI settings with the checkout URL.
$uriSettings = new UriSettings([
'checkout_uri_template' => $checkoutUrl
]);
// Creates the checkout settings with the name, URI settings, and
// eligible destinations. The name is required for an update.
$checkoutSettings = new CheckoutSettings([
'name' => $name,
'uri_settings' => $uriSettings,
'eligible_destinations' => [DestinationEnum::SHOPPING_ADS]
]);
// Creates a field mask to specify which fields to update.
$fieldMask = new FieldMask([
'paths' => ['uri_settings', 'eligible_destinations']
]);
// Creates the request object.
$request = (new UpdateCheckoutSettingsRequest())
->setCheckoutSettings($checkoutSettings)
->setUpdateMask($fieldMask);
// Calls the API and catches and prints any network failures/errors.
try {
printf("Sending update checkoutSettings request:%s", PHP_EOL);
$response = $checkoutSettingsServiceClient->updateCheckoutSettings($request);
printf("Updated Checkout Settings below:%s", PHP_EOL);
print $response->serializeToJsonString(true) . PHP_EOL;
} catch (ApiException $e) {
printf("An error has occurred: %s", PHP_EOL);
print $e->getMessage();
}
}
/**
* Executes the sample.
*
* @return void
*/
public function callSample(): void
{
$config = Config::generateConfig();
self::updateCheckoutSettings($config);
}
}
// Runs the sample.
$sample = new UpdateCheckoutSettingsSample();
$sample->callSample();
