Accounts API を使用すると、Merchant Center アカウントと他のサービス プロバイダとの関係を管理できます。関係とは、プロバイダが特定のサービスをビジネスに提供できるようにする正式な接続のことです。サービスは、プロバイダに付与される権限と機能(商品管理やキャンペーン管理など)を定義します。たとえば、Merchant Center アカウントを Google 広告アカウントにリンクすると、広告アカウントは商品データを使用して広告キャンペーンを実施できます。
関係は次の属性で構成されます。
- サービスを受ける Merchant Center アカウント
- サービス提供者
- Merchant Center アカウントに提供されるサービスまたはサービスのセット
エイリアス
サービス プロバイダは、サービスを提供しているアカウントにエイリアスを関連付けることができます(これは、
seller_id フィールドに相当します。このフィールドは、Content API for Shopping の
アカウント
リソースにありました)。エイリアスは、AccountRelationship リソース内のオプションの account_id_alias フィールドを使用して割り当てることができ、カスタム識別子として機能します。エイリアスは、ASCII 文字、10 進数字、ハイフン、アンダースコア、ピリオド、チルダ([A-Za-z0-9_~.-]{1,50})から選択した 1 ~ 50 文字で構成する必要があります。
エイリアスを使用してアカウントにアクセスするための URL 構造は GET /accounts/v1/accounts/{provider}~{account_id_alias} です。
サービス
Accounts API では、アカウントは次のサービスを利用できます。これらのサービスの多くは、 アカウントの作成時に 追加できます。
アカウントの集約: このサービスは、 アドバンス アカウントを別のアカウントにリンクし、アドバンス アカウントに完全な無制限のアクセス権を付与します。 通常、ネストされたアカウントを一元的に管理する必要があるマーケットプレイス、マルチブランドの小売業者、海外の小売業者が使用します。 e コマース プラットフォームまたはチャネル パートナーの場合は、代わりに
accountManagementを使用することをおすすめします。アカウントの集約を使用して アカウントを作成する 場合は、externalAccountIdを省略する必要があります。キャンペーン管理: このサービスは、 Merchant Center アカウントと Google 広告アカウントのリンクをモデル化し、広告アカウントに 広告キャンペーンの実施に必要な商品データとアカウント データへのアクセス権を付与します。この場合のサービス プロバイダは
GOOGLE_ADSで、externalAccountIdは Google 広告アカウントの ID です。このサービスは既存のアカウントにも提案できます。
比較ショッピング: Merchant Center アカウントを運営する Comparison Shopping Service(CSS)との関係を表します。
ローカル リスティングの管理: Google ビジネス プロフィールを使用してローカル在庫とリスティングを管理する店舗 管理者との関係を表します。
アカウント管理: このサービスを使用すると、プロバイダは Merchant Center アカウントに対して 管理アクション(アカウント設定の構成、ユーザーの管理、ビジネス情報の 更新など)を実行できます。ビジネスは、付与されるアクセス権を制限することもできます。 アカウントの作成時に使用すると、 このサービスはプロバイダにリンクされたアカウントを作成します。これは、 e コマース プラットフォームとチャネル パートナーにおすすめの方法です。既存のアカウントにも提案できます。
商品管理: このサービスを使用すると、プロバイダは商品 と、データソースやルールなどの関連機能を管理できます。アカウントの作成時に追加する場合は、通常、
accountManagementまたはaccountAggregationと組み合わせて使用します。このサービスは既存のアカウントにも提案できます。
握手
サービスを確立するには、サービスを提供するアカウントとサービスを受けるアカウントの両方が接続を承認する必要があります。この承認プロセスはハンドシェイクと呼ばれます。
ハンドシェイクは 2 つのステップで構成されます。
- 一方の当事者がサービスリンクを提案します。
- もう一方の当事者が提案を承認または拒否します。
提案が承認されると、サービスが承認され、完全に確立されたと見なされます。サービス提供者に付与されたアクセス権 は、資格のあるユーザーに付与されます(下記のアクセス権をご覧ください)。
提案を作成、拒否、承認するユーザーは、プロセスを開始するアカウントに対する
ADMIN アクセス
権
を持っている必要があります。そのため、サービス プロバイダがサービスを提案する場合、提案を行うユーザーはサービス プロバイダのアカウントの ADMIN であり、提案を承認または拒否するユーザーは受信アカウントの ADMIN である必要があります。
次のサンプルは、アカウント サービスを提案する方法を示しています。
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.AccountName;
import com.google.shopping.merchant.accounts.v1.AccountService;
import com.google.shopping.merchant.accounts.v1.AccountServicesServiceClient;
import com.google.shopping.merchant.accounts.v1.AccountServicesServiceSettings;
import com.google.shopping.merchant.accounts.v1.ProductsManagement;
import com.google.shopping.merchant.accounts.v1.ProposeAccountServiceRequest;
import shopping.merchant.samples.utils.Authenticator;
/** This class demonstrates how to propose a service to an existing Merchant Center account. */
public class ProposeServiceSample {
public static void proposeService(long accountId, long providerId, String externalAccountId)
throws Exception {
// Obtains OAuth token based on the user's configuration.
// The user that authenticates should have access to the account.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
AccountServicesServiceSettings accountServicesServiceSettings =
AccountServicesServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Calls the API and catches and prints any network failures/errors.
try (AccountServicesServiceClient accountServicesServiceClient =
AccountServicesServiceClient.create(accountServicesServiceSettings)) {
// The service to be proposed.
// This sample shows how to propose product management.
// For more information about the different services, see:
// https://developers.google.com/merchant/api/guides/accounts/services
AccountService accountService =
AccountService.newBuilder()
.setProductsManagement(ProductsManagement.newBuilder().build())
.setExternalAccountId(externalAccountId)
.build();
String accountName =
AccountName.newBuilder().setAccount(String.valueOf(accountId)).build().toString();
ProposeAccountServiceRequest request =
ProposeAccountServiceRequest.newBuilder()
.setParent(accountName)
.setProvider("accounts/" + providerId)
.setAccountService(accountService)
.build();
System.out.println("Sending Propose Service request:");
AccountService response = accountServicesServiceClient.proposeAccountService(request);
System.out.println("Proposed Service below");
System.out.println(response);
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
// The ID of the account to propose the service to.
long accountId = 123L;
// This is the provider ID of the e-commerce platform.
long providerId = 456L;
// An external ID that uniquely identifies the account service.
String externalAccountId = "ext-acc-id-123";
proposeService(accountId, providerId, externalAccountId);
}
}
PHP
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\AccountAggregation;
use Google\Shopping\Merchant\Accounts\V1\AccountService;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountServicesServiceClient;
use Google\Shopping\Merchant\Accounts\V1\ProposeAccountServiceRequest;
/**
* This class demonstrates how to propose an account service.
*/
class ProposeAccountServiceSample
{
/**
* A helper function to create the account name string.
*
* @param string $accountId The ID of the account.
*
* @return string The account name has the format: `accounts/{account_id}`
*/
private static function toAccountName(string $accountId): string
{
return sprintf('accounts/%s', $accountId);
}
/**
* Proposes a new account service.
*
* @param array $config The configuration data used for authentication and
* getting the account ID.
* @param string $providerId The ID of the provider account.
*/
public static function proposeAccountService(
array $config,
string $providerId
): 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.
$accountServicesServiceClient = new AccountServicesServiceClient($options);
// Calls the API and catches and prints any network failures/errors.
try {
$accountAggregation = new AccountAggregation();
$accountService = (new AccountService())
->setAccountAggregation($accountAggregation);
$request = (new ProposeAccountServiceRequest())
->setParent(self::toAccountName($config['accountId']))
->setProvider(self::toAccountName($providerId))
->setAccountService($accountService);
print "Sending Propose AccountService request\n";
$response = $accountServicesServiceClient->proposeAccountService($request);
print "Proposed AccountService below\n";
print $response->serializeToJsonString(true) . PHP_EOL;
} catch (ApiException $e) {
printf("An error has occurred: %s%s", $e->getMessage(), PHP_EOL);
}
}
/**
* Helper to execute the sample.
*/
public function callSample(): void
{
$config = Config::generateConfig();
// Update this with the Merchant Center provider ID you want to get the
// relationship for.
$providerId = 111;
self::proposeAccountService($config, $providerId);
}
}
// Run the script
$sample = new ProposeAccountServiceSample();
$sample->callSample();
Python
"""This class demonstrates how to propose an account service."""
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import AccountAggregation
from google.shopping.merchant_accounts_v1 import AccountService
from google.shopping.merchant_accounts_v1 import AccountServicesServiceClient
from google.shopping.merchant_accounts_v1 import ProposeAccountServiceRequest
_ACCOUNT = configuration.Configuration().read_merchant_info()
_PARENT = f"accounts/{_ACCOUNT}"
def propose_account_service(provider_id: int) -> None:
"""Proposes an account service.
Args:
provider_id: The Merchant Center ID of the provider.
"""
# Gets OAuth Credentials.
credentials = generate_user_credentials.main()
# Creates a client.
client = AccountServicesServiceClient(credentials=credentials)
# Creates the provider resource name from the provider ID.
provider = f"accounts/{provider_id}"
# Creates an AccountService object.
# For this request, only `account_aggregation` is needed.
account_service = AccountService()
account_service.account_aggregation = AccountAggregation()
# Creates the request.
request = ProposeAccountServiceRequest(
parent=_PARENT,
provider=provider,
account_service=account_service,
)
# Makes the request and catches and prints any error messages.
try:
print("Sending Propose AccountService request")
response = client.propose_account_service(request=request)
print("Proposed AccountService below")
print(response)
except RuntimeError as e:
print(e)
if __name__ == "__main__":
# Update this with the Merchant Center provider ID you want to get the
# relationship for.
provider_id_ = 111
propose_account_service(provider_id_)
サービス固有のハンドシェイクの動作
以下に、各サービス固有のハンドシェイク要件を示します。
アカウントの集約: このサービスは、 アカウントの作成の一部としてのみ確立できます。サービス提供者はアドバンス アカウントであることが想定されており、アドバンス アカウントのユーザーは作成されるアカウントに対する完全な
ADMINアクセス権を持っているため、サービスは自動的に承認されます。比較ショッピング: このサービスは、 アカウントの作成時に
createAndConfigureを使用して追加すると、自動的に承認されます。キャンペーン管理: これは通常のハンドシェイク プロセスに従いますが、 提案は 1 つのシステム(Google 広告など)で行われ、承認は 別のシステム(Merchant Center または Merchant API など)で行われます。
ローカル リスティングの管理: このサービスでは、 専用の方法でハンドシェイクが提案され、承認は別のシステム(たとえば Google ビジネス プロフィール)で行われます。詳しい手順については、 Google ビジネス プロフィールをリンクするガイドをご覧ください。
アカウント管理: このサービスでは、通常のハンドシェイク プロセス が適用されます。
proposecreateAndConfigureを使用してアカウントの作成時にサービスを追加すると、自動的に承認されます。商品管理: このサービスでは、通常のハンドシェイク プロセス が適用されます(一方の当事者が提案し、もう一方の当事者が承認します)。
アクセス権
各サービスタイプは、サービス プロバイダのユーザーに、サービス対象のアカウントに対する特定のレベルのアクセス権を付与します。
アカウントの集約: このサービスは、完全な
ADMIN権限を付与します。キャンペーン管理: このサービスは、関連付けられた広告アカウントが商品と基本アカウント情報にアクセスできるようにする、制限付きのアクセス権を付与します。
比較ショッピング: このサービスは、デフォルトで完全な
ADMIN権限を付与します。ただし、ビジネスは Merchant Center で付与されるアクセス権を制限できます。ローカル リスティングの管理: このサービスは、直接的なアクセス権を付与しません。 代わりに、リスティングが商品を Merchant Center アカウントと同期できるようにします。
重要: 次のサービスタイプで説明するアクセス権は、
承認されたサービス プロバイダにのみ適用されます。サービス提供者でこの機能を使用する場合は、サポート
チームにお問い合わせください。Content API for Shopping の商品管理で accounts.link メソッドがすでに承認されている場合は、Merchant API でこのサービスを承認なしで使用できます。
アカウント管理: このサービスは、デフォルトで完全な
ADMIN権限を付与します。商品管理: このサービスは、完全な
ADMIN権限を付与します。なお、今後、これは商品関連のアクセス権のみに制限されます。
サードパーティ プラットフォームでの関係の適用方法
他のビジネスに代わってアカウントを管理するサードパーティ プラットフォームの場合は、次の表に、さまざまなコンセプトがアカウント構造にどのようにマッピングされるかを示します。
- サービス提供者: アドバンス アカウント。
- サービスを受けるアカウント: 管理するビジネスを表す Merchant Center アカウント。
- サービス:
accountManagement: 販売者に代わって新しいアカウントを作成する e コマース プラットフォームとチャネル パートナーにおすすめのサービスです。販売者が所有し、管理のためにリンクされたアカウントを作成します。これは、このユースケースに適した Merchant Center の構造に沿っています。accountAggregation: このサービスは、アドバンス アカウントを別のアカウントにリンクします。サポートされていますが、e コマース プラットフォームとチャネル パートナーにはおすすめしません。
アドバンス アカウントを設定して新しい Merchant Center アカウントにリンクする方法について詳しくは、アカウントを作成するをご覧ください。