Librerie client

In questo approccio all'interazione con l'API Merchant utilizzi le librerie predefinite che incapsulano i dettagli di basso livello per effettuare richieste e gestire le risposte, offrendo un modo più comodo e spesso idiomatico per interagire con l'API. Gestiscono l'autenticazione, la serializzazione/deserializzazione di richieste e risposte e altro codice boilerplate.

Passaggio 1: Configurare l'autenticazione e i campioni di codice

Per le istruzioni, vedi Configurazione dell'autenticazione ed esempi di configurazione per l'API Merchant.

Passaggio 2: Scaricare e installare la libreria client e gli esempi di codice

Per istruzioni sul download e sull'installazione della libreria client e sull'utilizzo degli esempi di codice di GitHub, consulta Esempi Python dell'API Google Merchant.

Nota: gli esempi di codice e le istruzioni di accompagnamento sono disponibili per più linguaggi di programmazione. Questa guida fornisce istruzioni ed esempi per Python.

Passaggio 3: Registrati come sviluppatore

Per utilizzare l'API Merchant, devi registrare i dati di contatto dello sviluppatore.

La registrazione esegue le seguenti operazioni:

• Crea un contatto tecnico per il tuo account Merchant Center assegnando il ruolo API developer a un utente. In questo modo, Google può inviare aggiornamenti importanti specifici per l'API e le funzionalità utilizzate dallo sviluppatore, ad esempio annunci di servizio e informazioni sulle nuove funzionalità, che potrebbero essere di interesse minore per i non sviluppatori.
• Consente di lavorare con più account commerciante senza dover eseguire la registrazione più volte. Quando ti registri, l'ID progetto Google Cloud utilizzato per l'autenticazione all'API Merchant è associato al tuo account Merchant Center, che ha i contatti tecnici (i API developer). In questo modo, puoi ricevere aggiornamenti importanti per tutti gli account commerciante che gestisci, a condizione che l'autenticazione venga eseguita con il progetto Google Cloud registrato.

Al momento della registrazione, rispetta i prerequisiti e le limitazioni descritti nella sezione Registrazione.

Per un esempio di come registrare il progetto utilizzando le librerie client, consulta l'esempio Registra un progetto Google Cloud fornendo un indirizzo email dello sviluppatore utilizzando Python:

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
#
#     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.

"""This example registers a GCP project with a developer email."""
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

Passaggio 4: Gestire contatti e autorizzazioni dello sviluppatore

Al momento della registrazione:

• Se l'indirizzo email appartiene a un utente dell'account Merchant Center, a quest'ultimo viene concesso il ruolo API_DEVELOPER.
• Se l'indirizzo email non appartiene a un utente esistente, viene inviato un invito a quell'indirizzo. Il destinatario deve accettare l'invito per essere aggiunto come nuovo utente con il ruolo API_DEVELOPER.

Dopo la registrazione iniziale, ti consigliamo di aggiungere più sviluppatori e concedere loro diritti di accesso aggiuntivi.

Passaggio 4a. Concedere autorizzazioni aggiuntive

Il ruolo API_DEVELOPER è necessario per ricevere notifiche importanti, ma dispone di autorizzazioni minime in Merchant Center. Per consentire a questo utente di effettuare altre chiamate API o gestire le impostazioni nell'interfaccia utente di Merchant Center, devi concedergli ruoli aggiuntivi, come STANDARD o ADMIN. Per saperne di più, consulta Tipi di accesso.

Puoi aggiornare i diritti di accesso di un utente con il metodo accounts.users.patch.

Il codice di esempio mostra come aggiornare un utente per concedergli i ruoli ADMIN e API_DEVELOPER. In questo modo potrà gestire completamente l'account e riceverà anche comunicazioni relative all'API.

Python

# -*- coding: utf-8 -*-
# Copyright 2024 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.
"""A module to update a user."""


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

Passaggio 4b. Aggiungere sviluppatori di backup

Per evitare interruzioni dell'accesso all'API se il contatto sviluppatore principale lascia la tua organizzazione, devi aggiungere almeno uno sviluppatore di backup.

Attenzione :se l'ultimo utente con il ruolo API_DEVELOPER viene rimosso dal tuo account Merchant Center, le chiamate API verranno bloccate dopo un periodo di tolleranza di 30 giorni. Durante questo periodo, gli amministratori account riceveranno avvisi via email.

Puoi aggiungere un utente con il metodo accounts.users.create o aggiornarne uno esistente con il metodo accounts.users.patch. Ti consigliamo di assegnare a questo utente i ruoli ADMIN e API_DEVELOPER.

Passaggio 5: Creare un'origine dati dei prodotti principale

Prima di poter inserire un prodotto, devi disporre di un'origine dati di prodotto principale. Per un codice di esempio che crea un'origine dati, consulta Crea un'origine dati di prodotto principale che supporta più lingue con Python.

Python

# -*- coding: utf-8 -*-
# Copyright 2024 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.
"""This class demonstrates how to create a Primary product datasource all `feedLabel` and `contentLanguage` combinations.

This works only for API primary feeds.
"""

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_datasources_v1 import CreateDataSourceRequest
from google.shopping.merchant_datasources_v1 import DataSource
from google.shopping.merchant_datasources_v1 import DataSourcesServiceClient
from google.shopping.merchant_datasources_v1 import PrimaryProductDataSource

_ACCOUNT = configuration.Configuration().read_merchant_info()
_PARENT = f"accounts/{_ACCOUNT}"


def create_primary_product_data_source_multiple_languages():
  """Creates a `DataSource` resource."""

  # Gets OAuth Credentials.
  credentials = generate_user_credentials.main()

  # Creates a client.
  client = DataSourcesServiceClient(credentials=credentials)

  # Creates a PrimaryProductDataSource.
  primary_datasource = PrimaryProductDataSource()
  primary_datasource.countries = ["GB"]

  # Creates a DataSource and populates its attributes.
  data_source = DataSource()
  data_source.display_name = "Example Multiple Languages Primary DataSource"
  data_source.primary_product_data_source = primary_datasource

  # Creates the request.
  request = CreateDataSourceRequest(parent=_PARENT, data_source=data_source)

  # Makes the request and catches and prints any error messages.
  try:
    response = client.create_data_source(request=request)
    print(f"DataSource successfully created: {response}")
  except RuntimeError as e:
    print("DataSource creation failed")
    print(e)


if __name__ == "__main__":
  create_primary_product_data_source_multiple_languages()

create_primary_product_data_source_multiple_languages_sample.py

Puoi visualizzare questa origine dati nell'interfaccia utente di Merchant Center. Per ulteriori informazioni, vedi Come trovare la scheda Origini dati.

Passaggio 6: Inserisci un prodotto

Dopo aver creato l'origine dati, prova a inserirvi un prodotto. Per un esempio di codice che mostra come eseguire questa operazione con le librerie client, consulta Inserire un esempio di input di prodotto con Python.

Python

# -*- coding: utf-8 -*-
# Copyright 2024 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.
"""A module to insert a Product Input."""

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping import merchant_products_v1
from google.shopping.merchant_products_v1 import Availability
from google.shopping.merchant_products_v1 import Condition
from google.shopping.type import Price

_ACCOUNT = configuration.Configuration().read_merchant_info()
_PARENT = f"accounts/{_ACCOUNT}"

# You can only insert products into datasource types of Input "API" and
# "FILE", and of Type "Primary" or "Supplemental."
_DATA_SOURCE = "[INSERT_DATA_SOURCE_HERE]"
_DATA_SOURCE_NAME = f"accounts/{_ACCOUNT}/dataSources/{_DATA_SOURCE}"


def create_product_input():
  """Creates a `ProductInput` resource."""

  # Creates a shipping setting
  price = Price()
  price.amount_micros = 33_450_000
  price.currency_code = "GBP"

  shipping_option_1 = merchant_products_v1.Shipping()
  shipping_option_1.price = price
  shipping_option_1.country = "GB"
  shipping_option_1.service = "1st class post"

  price2 = Price()
  price2.amount_micros = 33_450_000
  price2.currency_code = "EUR"

  shipping_option_2 = merchant_products_v1.Shipping()
  shipping_option_2.price = price2
  shipping_option_2.country = "FR"
  shipping_option_2.service = "2nd class post"

  # Sets product attributes. Make sure to replace these values with your own.
  attributes = merchant_products_v1.ProductAttributes()
  attributes.title = "A Tale of Two Cities"
  attributes.description = "A classic novel about the French Revolution"
  attributes.link = "https://exampleWebsite.com/tale-of-two-cities.html"
  attributes.image_link = "https://exampleWebsite.com/tale-of-two-cities.jpg"
  attributes.price = price
  attributes.availability = Availability.IN_STOCK
  attributes.condition = Condition.NEW
  attributes.google_product_category = "Media > Books"
  attributes.gtins = ["9780007350896"]
  attributes.shipping = [shipping_option_1, shipping_option_2]

  return merchant_products_v1.ProductInput(
      content_language="en",
      feed_label="GB",
      offer_id="sku123",
      product_attributes=attributes,
  )


def insert_product_input():
  """Inserts the specified `ProductInput` resource."""

  # Gets OAuth Credentials.
  credentials = generate_user_credentials.main()

  # Creates a client.
  client = merchant_products_v1.ProductInputsServiceClient(
      credentials=credentials
  )

  # Creates the request.
  request = merchant_products_v1.InsertProductInputRequest(
      parent=_PARENT,
      # If this product is already owned by another datasource, when
      # re-inserting, the new datasource will take ownership of the product.
      product_input=create_product_input(),
      data_source=_DATA_SOURCE_NAME,
  )

  # Makes the request and catches and prints any error messages.
  try:
    response = client.insert_product_input(request=request)
    # The last part of the product name will be the product ID assigned to a
    # product by Google. Product ID has the format
    # `contentLanguage~feedLabel~offerId`
    print(f"Input successful: {response}")
  except RuntimeError as e:
    print("Input failed")
    print(e)
    # After the product is inserted, the product ID will be returned in the
    # response. We recommend that you check the Merchant Center to ensure that
    # the product is approved and visible to users before using the product ID
    # in any downstream processes.


if __name__ == "__main__":
  insert_product_input()

insert_product_input_sample.py

Passaggio 7. Elenca i tuoi prodotti

Per un esempio di codice che elenca i prodotti nell'origine dei dati, vedi Esempio di elenco dei prodotti con Python.

Python

# -*- coding: utf-8 -*-
# Copyright 2024 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.
"""A module to list Products."""

from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping import merchant_products_v1

_ACCOUNT = configuration.Configuration().read_merchant_info()
_PARENT = f"accounts/{_ACCOUNT}"


def list_products():
  """Lists the `Product` resources for a given account."""

  # Gets OAuth Credentials.
  credentials = generate_user_credentials.main()

  # Creates a client.
  client = merchant_products_v1.ProductsServiceClient(
      credentials=credentials
  )

  # Creates the request. Set the page size to the maximum value.
  request = merchant_products_v1.ListProductsRequest(
      parent=_PARENT, page_size=1000
  )

  # Makes the request and catches and prints any error messages.
  try:
    response = client.list_products(request=request)
    for product in response:
      print(product)
    print("List request successful!")
  except RuntimeError as e:
    print("List request failed")
    print(e)


if __name__ == "__main__":
  list_products()

list_products_sample.py