用于删除线上退货政策的 Merchant API 代码示例。
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.onlinereturnpolicy.v1;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.DeleteOnlineReturnPolicyRequest;
import com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyName;
import com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceClient;
import com.google.shopping.merchant.accounts.v1.OnlineReturnPolicyServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/**
* This class demonstrates how to delete the OnlineReturnPolicy for a given Merchant Center account.
*/
public class DeleteOnlineReturnPolicySample {
public static void deleteOnlineReturnPolicy(Config config, String returnPolicyId)
throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
OnlineReturnPolicyServiceSettings onlineReturnPolicyServiceSettings =
OnlineReturnPolicyServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates OnlineReturnPolicy name to identify OnlineReturnPolicy.
String name =
OnlineReturnPolicyName.newBuilder()
.setAccount(config.getAccountId().toString())
.setReturnPolicy(returnPolicyId)
.build()
.toString();
// Calls the API and catches and prints any network failures/errors.
try (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
OnlineReturnPolicyServiceClient.create(onlineReturnPolicyServiceSettings)) {
// The name has the format: accounts/{account}/onlineReturnPolicies/{return_policy}
DeleteOnlineReturnPolicyRequest request =
DeleteOnlineReturnPolicyRequest.newBuilder().setName(name).build();
System.out.println("Sending Delete OnlineReturnPolicy request:");
onlineReturnPolicyServiceClient.deleteOnlineReturnPolicy(request);
System.out.println("Deleted OnlineReturnPolicy successfully.");
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// Replace with the actual return policy ID you want to delete.
String returnPolicyId = "<SET_RETURN_POLICY_ID>";
deleteOnlineReturnPolicy(config, returnPolicyId);
}
}
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\Shopping\Merchant\Accounts\V1\Client\OnlineReturnPolicyServiceClient;
use Google\Shopping\Merchant\Accounts\V1\DeleteOnlineReturnPolicyRequest;
/**
* This class demonstrates how to delete an OnlineReturnPolicy for a given
* Merchant Center account.
*/
class DeleteOnlineReturnPolicySample
{
/**
* A helper function to create the name string.
*
* @param string $accountId The merchant account ID.
* @param string $returnPolicyId The return policy ID.
*
* @return string The name has the format:
* `accounts/{account}/onlineReturnPolicies/{return_policy}`
*/
private static function getName(
string $accountId,
string $returnPolicyId
): string {
return sprintf(
'accounts/%s/onlineReturnPolicies/%s',
$accountId,
$returnPolicyId
);
}
/**
* Deletes an online return policy from your Merchant Center account.
*
* @param array $config The configuration data for authentication and account ID.
* @param string $returnPolicyId The ID of the return policy to delete.
*/
public static function deleteOnlineReturnPolicy(
array $config,
string $returnPolicyId
): void {
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a client.
$onlineReturnPolicyServiceClient =
new OnlineReturnPolicyServiceClient($options);
// Creates the name of the return policy to delete.
$name = self::getName($config['accountId'], $returnPolicyId);
// Calls the API and catches and prints any network failures/errors.
try {
// Creates the request object.
$request = new DeleteOnlineReturnPolicyRequest(['name' => $name]);
printf("Sending Delete OnlineReturnPolicy request:%s", PHP_EOL);
$onlineReturnPolicyServiceClient->deleteOnlineReturnPolicy(
$request
);
printf('Deleted OnlineReturnPolicy successfully.%s', PHP_EOL);
} catch (ApiException $e) {
printf('%s%s', $e->getMessage(), PHP_EOL);
}
}
/**
* Helper to execute the sample.
*/
public function callSample(): void
{
$config = Config::generateConfig();
// Replace with the actual return policy ID you want to delete.
$returnPolicyId = '<SET_RETURN_POLICY_ID>';
self::deleteOnlineReturnPolicy($config, $returnPolicyId);
}
}
// Runs the script.
$sample = new DeleteOnlineReturnPolicySample();
$sample->callSample();
Python
# -*- coding: utf-8 -*-
# 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
#
# 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.
"""Sample for deleting an online return policy."""
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import DeleteOnlineReturnPolicyRequest
from google.shopping.merchant_accounts_v1 import OnlineReturnPolicyServiceClient
_ACCOUNT = configuration.Configuration().read_merchant_info()
def delete_online_return_policy(account_id: str, return_policy_id: str) -> None:
"""Deletes an online return policy.
Args:
account_id: The merchant account ID.
return_policy_id: The ID of the return policy to delete.
"""
# Gets OAuth Credentials.
credentials = generate_user_credentials.main()
# Creates a client.
client = OnlineReturnPolicyServiceClient(credentials=credentials)
# The name has the format:
# accounts/{account}/onlineReturnPolicies/{return_policy}
name = f"accounts/{account_id}/onlineReturnPolicies/{return_policy_id}"
# Creates the request.
request = DeleteOnlineReturnPolicyRequest(name=name)
# Makes the request and catches and prints any error messages.
try:
print("Sending Delete OnlineReturnPolicy request:")
client.delete_online_return_policy(request=request)
print("Deleted OnlineReturnPolicy successfully.")
except RuntimeError as e:
print(e)
if __name__ == "__main__":
# The ID of the account from which to delete the return policy.
account_id_ = _ACCOUNT
# The ID of the return policy to delete.
# This is the `returnPolicyId` field of the `OnlineReturnPolicy` resource.
return_policy_id_ = "<SET_RETURN_POLICY_ID>"
delete_online_return_policy(account_id_, return_policy_id_)