التسجيل كمطور برامج

التسجيل كمطوّر هو عملية إعداد إلزامية تتم لمرة واحدة وتربط مشروعك على Google Cloud بحسابك على Merchant Center، كما تسجّل معلومات الاتصال الخاصة بالمطوّر لدى Google. يسمح هذا الإعداد لشركة Google بإرسال إشعارات مهمة عن الخدمة وتحديثات إلزامية إلى جهات الاتصال الفنية ذات الصلة التي تقدّمها.

هذا المستند هو جزء من سلسلة متعددة الأجزاء حول بدء استخدام Merchant API. إذا سبق لك التسجيل في Merchant API، يمكنك الانتقال إلى القسم التالي: إدراج منتجك الأول

المتطلبات الأساسية

قبل التسجيل لاستخدام Merchant API، تأكَّد من استيفاء المتطلبات التالية:

  • حساب Merchant Center: يجب أن يكون لديك حساب حالي على Merchant Center.
  • إذن وصول إداري إلى حساب Merchant Center: يجب أن يكون لحساب البريد الإلكتروني أو حساب الخدمة الذي تستخدمه لتفويض طلب التسجيل نوع إذن الوصول ADMIN في حساب Merchant Center الذي تسجّل فيه. لمزيد من المعلومات، يُرجى الاطّلاع على تفويض الطلبات إلى Merchant API.
  • رقم تعريف مشروع Google Cloud: يجب ربط تطبيقك بمشروع Google Cloud مخصّص لتوفير بيانات الاعتماد اللازمة للمصادقة. للحصول على تفاصيل حول مكان العثور على رقم تعريف المشروع، راجِع مقالة العثور على اسم المشروع ورقمه ورقم تعريفه.
  • عنوان بريد إلكتروني صالح مرتبط بحساب Google تقدّمه كجهة تواصل مع المطوّرين لتلقّي الإشعارات من Google يجب ألا يكون عنوان بريد إلكتروني لحساب خدمة. يمكنك استخدام عنوان بريد إلكتروني يشكّل جزءًا من حساب Merchant Center أو عنوان بريد إلكتروني جديد.

التسجيل كمطوّر باستخدام Merchant API

لاستخدام Merchant API، يجب تسجيل معلومات الاتصال الخاصة بالمطوّر ومشروع Google Cloud مع حسابك على Merchant Center من خلال طريقة registerGcp.

سواء كنت تعمل مع حسابات تجار متعددة أم لا، عليك إجراء عملية التسجيل مرة واحدة لكل مشروع على السحابة الإلكترونية تنوي استخدامه. إذا كنت تعمل على مشاريع متعددة على Google Cloud، يمكنك تسجيل أيّ منها أو جميعها في حساب Merchant Center نفسه.

مزايا التسجيل

يوفّر التسجيل المزايا التالية:

  • إنشاء جهة اتصال فنية: يتم إنشاء جهة اتصال فنية في Merchant Center. ترسل Google تحديثات مهمة خاصة بواجهة برمجة التطبيقات إلى جهة الاتصال الفنية، مثل إشعارات الخدمة ومعلومات الميزات الجديدة.
  • إدارة حسابات تجارية متعددة: تتيح لك تمثيل جهة الاتصال الخاصة بالمطوّرين لجميع الحسابات التجارية التي تديرها.

باستثناء عملية التسجيل، يتم حظر أي طلبات بيانات من Merchant API من مشروع على السحابة الإلكترونية غير مسجّل على Google Cloud، ويتم عرض رمز الخطأ 401 مع الحالة UNAUTHENTICATED ورسالة الخطأ التالية:

GCP project with id {GCP_ID} and number {GCP_NUMBER} is not registered with the merchant account.
Please follow these steps https://developers.google.com/merchant/api/guides/quickstart#register_as_a_developer
to register the GCP project with the merchant account then try calling the API again in 5 minutes.

اعتبارات مهمة

  • الإعداد لمرة واحدة لكل مشروع على Google Cloud: التسجيل هو عملية إعداد لمرة واحدة لكل مشروع على Google Cloud، وينطبق على جميع المستخدمين وحسابات الخدمة ضِمن مشروع Google Cloud. تأكَّد من تفعيل Merchant API في مشروعك على Google Cloud.
  • لا يمكن تسجيل كل مشروع على Google Cloud إلا باستخدام حساب واحد على Merchant Center في أي وقت: إذا حاولت تسجيل مشروع واحد على Google Cloud باستخدام عدة حسابات على Merchant Center في الوقت نفسه، ستتلقّى الخطأ ALREADY_REGISTERED. استخدِم عنوان البريد الإلكتروني نفسه الذي استخدمته للتسجيل. يُرجى العِلم أنّه يمكن تسجيل مشاريع متعددة على Google Cloud في حساب Merchant Center نفسه.
  • تحديد الحساب المناسب للجهات الخارجية التي تدير عدة تجار: على الجهات الخارجية التي تمثّل عدة تجار أو تدير حساباتهم استخدام بنية الحساب المناسبة ضمن نظام Google المتكامل. يعتمد المعرّف الصحيح الذي يجب استخدامه على نوع نشاطك التجاري:
    • الأسواق التي لديها حساب بامتيازات متقدّمة حالي: إذا كان نشاطك التجاري يعمل كسوق ولديه حساب بامتيازات متقدّمة يمثّل المنصة بأكملها، عليك استخدام رقم تعريف هذا الحساب الحالي.
    • خدمات مقارنة الأسعار (CSS): إذا كنت من مقدّمي خدمات مقارنة الأسعار، عليك استخدام رقم تعريف حسابك الفريد أو رقم تعريف حساب مجموعة CSS.
    • الوكالات والمطوّرون والجهات الخارجية الأخرى: إذا كنت تدير نشاطًا تجاريًا تابعًا لجهة خارجية، مثل وكالة أو مطوّر تابع لجهة خارجية، وتدير حسابات تجّار متعدّدة وليس لديك معرّف Merchant Center واحد يمثّل نشاطك التجاري، عليك إنشاء حساب Merchant Center أساسي جديد وطلب تحويله إلى حساب بامتيازات متقدّمة. يمكن للحسابات المتقدّمة إدارة الحسابات الفرعية وتوفير البنية اللازمة لعمليات الجهات الخارجية.
  • إجراء عملية التسجيل لحسابك الأساسي على Merchant Center فقط: يمكنك إجراء عملية تسجيل المطوّر باستخدام حسابك الأساسي فقط على Merchant Center، وستصبح جهة الاتصال الخاصة بالمطوّرين لجميع الحسابات الفرعية المرتبطة على Merchant Center. لا تُجري عملية التسجيل لكل حساب فرعي من حساباتك على Merchant Center.

النص البديل لتسهيل الاستخدام

يوضّح المخطط البياني السابق عملية إعداد التسجيل عند استخدام مشاريع متعددة على Google Cloud وحساب رئيسي واحد على Merchant Center مع إمكانية استخدام حسابات فرعية متعددة على Merchant Center.

  • بعد تسجيل عنوان بريد إلكتروني للمطوِّر:
    • يمكنك تنفيذ طلبات بيانات من Merchant API في غضون 5 دقائق من التسجيل.
    • إذا كان عنوان البريد الإلكتروني يخص مستخدمًا حاليًا في Merchant Center، سيتم منحه دور API_DEVELOPER. بخلاف ذلك، سيتم إنشاء مستخدم جديد في Merchant Center، وعليه قبول الدعوة خلال 14 يومًا لتجنُّب انتهاء صلاحيتها وتجنُّب الاضطرار إلى إعادة بدء عملية التسجيل. لا تُكمل عملية التسجيل إلا بعد أن ينقر المستخدم على رابط الدعوة.

إجراء مكالمة التسجيل

يمكنك التسجيل من خلال استدعاء طريقة registerGcp. يتوفّر خياران لإجراء مكالمة التسجيل:

  • الخيار 1: طلبات البيانات المباشرة من واجهة برمجة التطبيقات يمكنك إرسال طلبات أولية إلى نقاط نهاية واجهة برمجة التطبيقات مباشرةً، عادةً عبر HTTP(S). يمكنك التعامل يدويًا مع جوانب مثل إنشاء نص الطلب وتحديد العناوين (بما في ذلك المصادقة) وتحليل الرد.
  • الخيار 2: مكتبات العميل يمكنك استخدام المكتبات المُنشأة مسبقًا التي توفّر طريقة أكثر ملاءمة ومتوافقة مع اللغة للتفاعل مع Merchant API. وتتعامل مع المصادقة والتفويض، وتوفّر طريقة ملائمة لتجريد عملية التواصل الأساسية عبر HTTP. تتوفّر عينات من الرموز البرمجية الرسمية لمساعدتك على البدء بسرعة.

تفويض إجراء مكالمة التسجيل

كما هو موضّح في خطوة تفويض الطلبات إلى Merchant API، لديك سيناريوهان مختلفان للمصادقة:

  • بروتوكول OAuth 2.0: لمقدّمي الخدمات الخارجيين أو الوكالات التي تدير حسابات تجارية متعدّدة
  • حسابات الخدمة: للوصول إلى حسابك على Merchant Center

لمزيد من المعلومات حول تفويض مكالمة التسجيل، يُرجى الاطّلاع على كيف يمكنني إجراء المصادقة والتفويض لمكالمة التسجيل؟

مكالمة التسجيل

في الأمثلة التالية، يمكنك تنفيذ طلب التسجيل باستخدام طلبات مباشرة من واجهة برمجة التطبيقات أو مكتبات العميل.

يمكنك إجراء مكالمة التسجيل باستخدام طريقة registerGcp.

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/developerRegistration:registerGcp
Content-Type: application/json
Authorization: Bearer {ACCESS_TOKEN}"

{
  "developerEmail": "{DEVELOPER_EMAIL}"
}

غيِّر القيم في السلسلة على الشكل التالي:

  • ACCOUNT_ID: معرّف Merchant Center
  • ACCESS_TOKEN: رمز التفويض لإجراء طلب البيانات من واجهة برمجة التطبيقات
  • DEVELOPER_EMAIL: عنوان البريد الإلكتروني لجهة الاتصال الفنية الأساسية

يعرض الطلب الناجح مورد DeveloperRegistration، يؤكّد حالة الربط الناجح:

  "name": "accounts/{ACCOUNT_ID}/developerRegistration",
  "gcpIds": ["{GOOGLE_CLOUD_PROJECT_ID}"]

Python

نزِّل النماذج واتّبِع الإرشادات الواردة في نماذج Google Merchant API بلغة Python لإعداد مكتبات برامج Python.

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import DeveloperRegistrationServiceClient
from google.shopping.merchant_accounts_v1 import RegisterGcpRequest


def register_gcp(account_id: str, developer_email: str) -> None:
  """Registers the GCP project used to call the Merchant API with a developer email.

  Args:
    account_id: The ID of your Merchant Center account.
    developer_email: The email address of the developer to register.
  """
  # Get OAuth credentials.
  credentials = generate_user_credentials.main()

  # Create a client to the Developer Registration Service.
  client = DeveloperRegistrationServiceClient(credentials=credentials)

  # The name has the format: accounts/{account}/developerRegistration
  name = f"accounts/{account_id}/developerRegistration"

  # Create the request to register the GCP project.
  request = RegisterGcpRequest(
      name=name,
      developer_email=developer_email,
  )

  # Make the API call and handle potential errors.
  try:
    print("Sending RegisterGcp request:")
    response = client.register_gcp(request=request)
    print("Registered GCP project successfully:")
    print(response)
  except RuntimeError as e:
    print(f"An error occurred: {e}")


if __name__ == "__main__":

  # Your Merchant Center account ID.
  # This can be found in the Merchant Center UI.
  _account_id = configuration.Configuration().read_merchant_info()

  # The developer email to associate with the GCP project.
  _developer_email = "YOUR_EMAIL_HERE"

  register_gcp(_account_id, _developer_email)
register_gcp_sample.py

جافا

نزِّل النماذج واتّبِع الإرشادات الواردة في نماذج Google Merchant API للغة Java لإعداد مكتبات برامج Java.

import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.DeveloperRegistration;
import com.google.shopping.merchant.accounts.v1.DeveloperRegistrationName;
import com.google.shopping.merchant.accounts.v1.DeveloperRegistrationServiceClient;
import com.google.shopping.merchant.accounts.v1.DeveloperRegistrationServiceSettings;
import com.google.shopping.merchant.accounts.v1.RegisterGcpRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;

/**
 * This class demonstrates how to register the GCP project used to call the Merchant API with a
 * developer email.
 */
public class RegisterGcpSample {

  public static void registerGcp(Config config, String developerEmail) throws Exception {

    // Obtains OAuth token based on the user's configuration.
    GoogleCredentials credential = new Authenticator().authenticate();

    // Creates service settings using the credentials retrieved above.
    DeveloperRegistrationServiceSettings developerRegistrationServiceSettings =
        DeveloperRegistrationServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    // Creates DeveloperRegistration name to identify the DeveloperRegistration.
    // The name has the format: accounts/{account}/developerRegistration
    String name =
        DeveloperRegistrationName.newBuilder()
            .setAccount(config.getAccountId().toString())
            .build()
            .toString();

    // Calls the API and catches and prints any network failures/errors.
    try (DeveloperRegistrationServiceClient developerRegistrationServiceClient =
        DeveloperRegistrationServiceClient.create(developerRegistrationServiceSettings)) {

      // Creates a request to register the GCP project with the developer email.
      RegisterGcpRequest request =
          RegisterGcpRequest.newBuilder().setName(name).setDeveloperEmail(developerEmail).build();

      System.out.println("Sending RegisterGcp request:");
      DeveloperRegistration response = developerRegistrationServiceClient.registerGcp(request);

      System.out.println(response);
    } catch (Exception e) {
      System.out.println(e);
    }
  }

  public static void main(String[] args) throws Exception {
    Config config = Config.load();
    String developerEmail = "YOUR_EMAIL_HERE"; // Replace with your email
    registerGcp(config, developerEmail);
  }
}
RegisterGcpSample.java

PHP

نزِّل النماذج واتّبِع الإرشادات الواردة في نماذج Google Merchant API للغة PHP لإعداد مكتبات برامج 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\Client\DeveloperRegistrationServiceClient;
use Google\Shopping\Merchant\Accounts\V1\RegisterGcpRequest;

/**
 * This class demonstrates how to register the GCP project used to call the
 * Merchant API with a developer email.
 */
class RegisterGcpSample
{
    /**
     * A helper function to create the name string for the
     * DeveloperRegistration.
     *
     * @param string $accountId The merchant account ID.
     * @return string The name, which has the format:
     *     `accounts/{account}/developerRegistration`
     */
    private static function getName(string $accountId): string
    {
        return sprintf("accounts/%s/developerRegistration", $accountId);
    }

    /**
     * Registers the GCP project with a developer email.
     *
     * @param array $config The configuration data for authentication and account ID.
     * @param string $developerEmail The email of the developer to register.
     */
    public static function registerGcpSample(array $config, string $developerEmail): void
    {
        // Obtains OAuth credentials from the configuration file.
        $credentials = Authentication::useServiceAccountOrTokenFile();

        // Creates a configuration object for the client.
        $options = ['credentials' => $credentials];

        // Creates the DeveloperRegistrationServiceClient.
        $developerRegistrationServiceClient = new DeveloperRegistrationServiceClient($options);

        // Creates the name of the developer registration to identify it.
        $name = self::getName($config['accountId']);

        // Calls the API and handles any network failures.
        try {
            // Creates a request to register the GCP project with the developer email.
            $request = new RegisterGcpRequest([
                'name' => $name,
                'developer_email' => $developerEmail
            ]);

            printf("Sending RegisterGcp request:%s", PHP_EOL);
            // The `registerGcp` method returns a `DeveloperRegistration` object
            // upon success.
            $response = $developerRegistrationServiceClient->registerGcp($request);
            print "Successfully registered developer email '$developerEmail' for account {$config['accountId']}.\n";
            print_r($response);
        } catch (ApiException $e) {
            printf("An error occurred: %s%s", $e->getMessage(), PHP_EOL);
        }
    }

    /**
     * Helper to execute the sample.
     */
    public function callSample(): void
    {
        $config = Config::generateConfig();
        // An email address for a developer to register for the API.
        $developerEmail = 'YOUR_EMAIL_HERE'; // Replace with your email
        self::registerGcpSample($config, $developerEmail);
    }
}

// Executes the sample.
$sample = new RegisterGcpSample();
$sample->callSample();
RegisterGcpSample.php

cURL

curl -X POST "https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/developerRegistration:registerGcp" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-d '{
  "developerEmail": "{DEVELOPER_EMAIL}"
}'

أفضل الممارسات بعد التسجيل

للاستفادة من إدارة الوصول الفعّالة وتجنُّب انقطاع الخدمة في المستقبل، ننصحك باتّباع مجموعة من أفضل الممارسات بعد إكمال عملية التسجيل الأولية:

منح أذونات إضافية لمطوّر واجهة برمجة التطبيقات

عند تسجيل جهة اتصال خاصة بالمطوّر، يتم تلقائيًا منحها دور API_DEVELOPER. لا يتضمّن هذا الدور أذونات أخرى ضرورية لإدارة حساب Merchant Center أو تنفيذ جميع طلبات البيانات من واجهة برمجة التطبيقات. ننصحك بإضافة أدوار ADMIN أو STANDARD إلى حسابات المطوّرين لمنحهم إذن وصول شامل.

لتعديل حقوق وصول مستخدم، استخدِم طريقة accounts.users.patch. يمكنك تحديد أذونات الوصول في الحقل updateMask الخاص بنص الطلب لإضافة أدوار أو إزالتها:

PATCH https://merchantapi.googleapis.com/accounts/v1/{ACCOUNT_ID}/users/{DEVELOPER_EMAIL}?update_mask=access_rights
Content-Type: application/json
Authorization: Bearer {ACCESS_TOKEN}"

{
  "name": "accounts/{ACCOUNT_ID}/users/{DEVELOPER_EMAIL}",
  "access_rights": [ "ADMIN", "API_DEVELOPER" ]
}

Python

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.protobuf import field_mask_pb2
from google.shopping.merchant_accounts_v1 import AccessRight
from google.shopping.merchant_accounts_v1 import UpdateUserRequest
from google.shopping.merchant_accounts_v1 import User
from google.shopping.merchant_accounts_v1 import UserServiceClient

FieldMask = field_mask_pb2.FieldMask

_ACCOUNT = configuration.Configuration().read_merchant_info()


def update_user(user_email, user_access_right):
  """Updates a user to make it an admin of the MC account."""

  credentials = generate_user_credentials.main()

  client = UserServiceClient(credentials=credentials)

  # Create user name string
  name = "accounts/" + _ACCOUNT + "/users/" + user_email

  user = User(name=name, access_rights=[user_access_right])

  field_mask = FieldMask(paths=["access_rights"])

  try:
    request = UpdateUserRequest(user=user, update_mask=field_mask)

    print("Sending Update User request")
    response = client.update_user(request=request)
    print("Updated User Name below")
    print(response.name)
  except RuntimeError as e:
    print(e)


if __name__ == "__main__":
  # Modify this email to update the right user
  email = "USER_MAIL_ACCOUNT"
  access_right = AccessRight.ADMIN
  update_user(email, access_right)

update_user_sample.py

لغة Java

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.AccessRight;
import com.google.shopping.merchant.accounts.v1.UpdateUserRequest;
import com.google.shopping.merchant.accounts.v1.User;
import com.google.shopping.merchant.accounts.v1.UserName;
import com.google.shopping.merchant.accounts.v1.UserServiceClient;
import com.google.shopping.merchant.accounts.v1.UserServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;

/** This class demonstrates how to update a user to make it an admin of the MC account. */
public class UpdateUserSample {

  public static void updateUser(Config config, String email, AccessRight accessRight)
      throws Exception {

    GoogleCredentials credential = new Authenticator().authenticate();

    UserServiceSettings userServiceSettings =
        UserServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    // Creates user name to identify user.
    String name =
        UserName.newBuilder()
            .setAccount(config.getAccountId().toString())
            .setEmail(email)
            .build()
            .toString();

    // Create a user with the updated fields.
    User user = User.newBuilder().setName(name).addAccessRights(accessRight).build();

    FieldMask fieldMask = FieldMask.newBuilder().addPaths("access_rights").build();

    try (UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings)) {

      UpdateUserRequest request =
          UpdateUserRequest.newBuilder().setUser(user).setUpdateMask(fieldMask).build();

      System.out.println("Sending Update User request");
      User response = userServiceClient.updateUser(request);
      System.out.println("Updated User Name below");
      System.out.println(response.getName());
    } catch (Exception e) {
      System.out.println(e);
    }
  }

  public static void main(String[] args) throws Exception {
    Config config = Config.load();
    String email = "testUser@gmail.com";
    // Give the user admin rights. Note that all other rights, like
    // PERFORMANCE_REPORTING, would be overwritten in this example
    // if the user had those access rights before the update.
    AccessRight accessRight = AccessRight.ADMIN;

    updateUser(config, email, accessRight);
  }
}
UpdateUserSample.java

PHP

use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;
use Google\Shopping\Merchant\Accounts\V1\AccessRight;
use Google\Shopping\Merchant\Accounts\V1\UpdateUserRequest;
use Google\Shopping\Merchant\Accounts\V1\User;
use Google\Shopping\Merchant\Accounts\V1\Client\UserServiceClient;


/**
 * Updates a user.
 *
 * @param array $config The configuration data.
 * @param string $email The email address of the user.
 * @param int $accessRight The access right to grant the user.
 * @return void
 */
function updateUser($config, $email, $accessRights): void
{
    // Gets the OAuth credentials to make the request.
    $credentials = Authentication::useServiceAccountOrTokenFile();

    // Creates options config containing credentials for the client to use.
    $options = ['credentials' => $credentials];

    // Creates a client.
    $userServiceClient = new UserServiceClient($options);

    // Creates user name to identify user.
    $name = 'accounts/' . $config['accountId'] . "/users/" . $email;

    $user = (new User())
        ->setName($name)
        ->setAccessRights($accessRights);

    $fieldMask = (new FieldMask())->setPaths(['access_rights']);

    // Calls the API and catches and prints any network failures/errors.
    try {
        $request = new UpdateUserRequest([
            'user' => $user,
            'update_mask' => $fieldMask,
        ]);

        print "Sending Update User request\n";
        $response = $userServiceClient->updateUser($request);
        print "Updated User Name below\n";
        print $response->getName() . "\n";
    } catch (ApiException $e) {
        print $e->getMessage();
    }
}


$config = Config::generateConfig();
$email = "testUser@gmail.com";
$accessRights = [AccessRight::ADMIN];

updateUser($config, $email, $accessRights);
UpdateUserSample.php

cURL

curl -X PATCH \
"https://merchantapi.googleapis.com/accounts/v1/{ACCOUNT_ID}/users/{USER_EMAIL}?update_mask=access_rights" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-d '{
  "access_rights": [
    "ADMIN",
    "API_DEVELOPER"
  ]
}'

إضافة المزيد من جهات الاتصال الخاصة بالمطوِّر

لتجنُّب تعطُّل النشاط التجاري في حال مغادرة جهة الاتصال الأساسية للمطوّر أو فقدانها إذن الوصول، من المهم توفير جهات اتصال احتياطية. ننصحك بإضافة مستخدم واحد على الأقل لديه دور API_DEVELOPER في Merchant Center ليكون بديلاً.

يمكنك إضافة مستخدم أو تعديل مستخدم حالي باستخدام خدمة accounts.users في Merchant API أو صفحة الوصول والخدمات في واجهة مستخدم Merchant Center. من خلال إضافة مطوّرين احتياطيين بشكل استباقي، يمكنك إنشاء عملية دمج أكثر مرونة لا تعتمد على شخص واحد.

PATCH https://merchantapi.googleapis.com/products/v1/accounts/{ACCOUNT_ID}/users
Content-Type: application/json
Authorization: Bearer {ACCESS_TOKEN}"
{
  "user_id": {USER_EMAIL},
  "user": { "access_rights": [ "API_DEVELOPER", "ADMIN" ] }
}

Python

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import AccessRight
from google.shopping.merchant_accounts_v1 import CreateUserRequest
from google.shopping.merchant_accounts_v1 import User
from google.shopping.merchant_accounts_v1 import UserServiceClient

_ACCOUNT = configuration.Configuration().read_merchant_info()


def get_parent(account_id):
  return f"accounts/{account_id}"


def create_user(user_email):
  """Creates a user for a Merchant Center account."""

  # Get OAuth credentials
  credentials = generate_user_credentials.main()

  # Create a UserServiceClient
  client = UserServiceClient(credentials=credentials)

  # Create parent string
  parent = get_parent(_ACCOUNT)

  # Create the request
  request = CreateUserRequest(
      parent=parent,
      user_id=user_email,
      user=User(
          access_rights=[AccessRight.ADMIN, AccessRight.PERFORMANCE_REPORTING]
      ),
  )

  try:
    print("Sending Create User request")
    response = client.create_user(request=request)
    print("Inserted User Name below")
    print(response.name)
  except RuntimeError as e:
    print(e)


if __name__ == "__main__":
  # Modify this email to create a new user
  email = "USER_MAIL_ACCOUNT"
  create_user(email)

create_user_sample.py

لغة Java

import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.AccessRight;
import com.google.shopping.merchant.accounts.v1.CreateUserRequest;
import com.google.shopping.merchant.accounts.v1.User;
import com.google.shopping.merchant.accounts.v1.UserServiceClient;
import com.google.shopping.merchant.accounts.v1.UserServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;

/** This class demonstrates how to create a user for a Merchant Center account. */
public class CreateUserSample {

  private static String getParent(String accountId) {
    return String.format("accounts/%s", accountId);
  }

  public static void createUser(Config config, String email) throws Exception {

    // Obtains OAuth token based on the user's configuration.
    GoogleCredentials credential = new Authenticator().authenticate();

    // Creates service settings using the credentials retrieved above.
    UserServiceSettings userServiceSettings =
        UserServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    // Creates parent to identify where to insert the user.
    String parent = getParent(config.getAccountId().toString());

    // Calls the API and catches and prints any network failures/errors.
    try (UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings)) {

      CreateUserRequest request =
          CreateUserRequest.newBuilder()
              .setParent(parent)
              // This field is the email address of the user.
              .setUserId(email)
              .setUser(
                  User.newBuilder()
                      .addAccessRights(AccessRight.ADMIN)
                      .addAccessRights(AccessRight.PERFORMANCE_REPORTING)
                      .build())
              .build();

      System.out.println("Sending Create User request");
      User response = userServiceClient.createUser(request);
      System.out.println("Inserted User Name below");
      // The last part of the user name will be the email address of the user.
      // Format: `accounts/{account}/user/{user}`
      System.out.println(response.getName());
    } catch (Exception e) {
      System.out.println(e);
    }
  }

  public static void main(String[] args) throws Exception {
    Config config = Config.load();
    // The email address of this user.
    String email = "testUser@gmail.com";

    createUser(config, email);
  }
}
CreateUserSample.java

PHP

use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\AccessRight;
use Google\Shopping\Merchant\Accounts\V1\CreateUserRequest;
use Google\Shopping\Merchant\Accounts\V1\User;
use Google\Shopping\Merchant\Accounts\V1\Client\UserServiceClient;


/**
 * Creates a user.
 *
 * @param array $config The configuration data.
 * @param string $email The email address of the user.
 * @return void
 */
function createUser($config, $email): void
{
    // Gets the OAuth credentials to make the request.
    $credentials = Authentication::useServiceAccountOrTokenFile();

    // Creates options config containing credentials for the client to use.
    $options = ['credentials' => $credentials];

    // Creates a client.
    $userServiceClient = new UserServiceClient($options);

    // Creates parent to identify where to insert the user.
    $parent = sprintf("accounts/%s", $config['accountId']);

    // Calls the API and catches and prints any network failures/errors.
    try {
        $request = new CreateUserRequest([
            'parent' => $parent,
            'user_id' => $email,
            'user' => (new User())
                ->setAccessRights([AccessRight::ADMIN,AccessRight::PERFORMANCE_REPORTING])
        ]);

        print "Sending Create User request\n";
        $response = $userServiceClient->createUser($request);
        print "Inserted User Name below\n";
        print $response->getName() . "\n";
    } catch (ApiException $e) {
        print $e->getMessage();
    }
}

$config = Config::generateConfig();
$email = "testUser@gmail.com";

createUser($config, $email);
CreateUserSample.php

cURL

curl -X PATCH \
"https://merchantapi.googleapis.com/products/v1/accounts/{ACCOUNT_ID}/users/{USER_EMAIL}?update_mask=access_rights" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-d '{
  "access_rights": [
    "ADMIN",
    "API_DEVELOPER"
  ]
}'
السابق
Set up authentication
التالي
Insert your first product