Package google.shopping.merchant.datasources.v1beta

Index

DataSourcesService

Service permettant de gérer les sources de données principales, supplémentaires, d'inventaire et autres. Pour en savoir plus, consultez l'article d'aide Merchant Center.

CreateDataSource

rpc CreateDataSource(CreateDataSourceRequest) returns (DataSource)

Crée la configuration de la nouvelle source de données pour le compte donné.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.
DeleteDataSource

rpc DeleteDataSource(DeleteDataSourceRequest) returns (Empty)

Supprime une source de données de votre compte Merchant Center.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.
FetchDataSource

rpc FetchDataSource(FetchDataSourceRequest) returns (Empty)

Effectue la récupération des données immédiatement (même en dehors du calendrier de récupération) sur une source de données de votre compte Merchant Center. Si vous devez appeler cette méthode plus d'une fois par jour, utilisez plutôt le service Products pour mettre à jour vos données produit. Cette méthode ne fonctionne que sur les sources de données pour lesquelles une entrée de fichier est définie.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.
GetDataSource

rpc GetDataSource(GetDataSourceRequest) returns (DataSource)

Récupère la configuration de la source de données pour le compte donné.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.
ListDataSources

rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse)

Répertorie les configurations des sources de données pour le compte donné.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.
UpdateDataSource

rpc UpdateDataSource(UpdateDataSourceRequest) returns (DataSource)

Met à jour la configuration de la source de données existante. Les champs définis dans le masque de mise à jour, mais non fournis dans la ressource, seront supprimés.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

FileUploadsService

Service permettant de gérer les importations de fichiers de sources de données.

GetFileUpload

rpc GetFileUpload(GetFileUploadRequest) returns (FileUpload)

Récupère la dernière importation de fichier de source de données. Seul l'alias latest est accepté pour l'importation de fichiers.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/content

Pour en savoir plus, consultez OAuth 2.0 Overview.

CreateDataSourceRequest

Message de requête pour la méthode CreateDataSource.

Champs
parent

string

Obligatoire. Compte dans lequel cette source de données sera créée. Format : accounts/{account}
data_source

DataSource

Obligatoire. Source de données à créer.

DataSource

Source de données du compte Merchant Center.

Champs
name

string

Identifiant. Nom de la source de données. Format : {datasource.name=accounts/{account}/dataSources/{datasource}}
data_source_id

int64

Uniquement en sortie. ID de la source de données.
display_name

string

Obligatoire. Nom de la source de données affiché dans l'interface utilisateur de Merchant Center.
input

Input

Uniquement en sortie. Détermine le type d'entrée de la source de données. En fonction de la valeur saisie, il est possible que certains paramètres ne fonctionnent pas. Seules les sources de données génériques peuvent être créées via l'API.
file_input

FileInput

Facultatif. Ce champ n'est utilisé que lorsque les données sont gérées via un fichier.
Champ d'union Type. Obligatoire. Type de source de données. Type ne peut être qu'un des éléments suivants :
primary_product_data_source

PrimaryProductDataSource

Source de données principale pour les produits en magasin et en ligne.
supplemental_product_data_source

SupplementalProductDataSource

Source de données supplémentaire pour les produits en magasin et en ligne.
local_inventory_data_source

LocalInventoryDataSource

Source de données d'inventaire en magasin.
regional_inventory_data_source

RegionalInventoryDataSource

Source de données d'inventaire régional.
promotion_data_source

PromotionDataSource

Source de données de la promotion.
product_review_data_source

ProductReviewDataSource

Source de données des avis sur les produits.
merchant_review_data_source

MerchantReviewDataSource

Source de données des avis sur les marchands.

Entrée

Détermine le type d'entrée de la source de données. En fonction de la valeur saisie, certains paramètres peuvent ne pas être acceptés.

Enums
INPUT_UNSPECIFIED Entrée non spécifiée.
API Représente les sources de données pour lesquelles les données sont principalement fournies via l'API.
FILE Représente les sources de données pour lesquelles les données sont principalement fournies via l'entrée de fichiers. Vous pouvez toujours fournir des données via l'API.
UI

Source de données des produits ajoutés directement dans Merchant Center.

Ce type de source de données ne peut pas être créé ni mis à jour via cette API, mais uniquement via l'interface utilisateur de Merchant Center.

Ce type de source de données est en lecture seule.
AUTOFEED Il s'agit également des flux automatiques utilisés pour créer automatiquement vos données produit. Vous pouvez activer ou désactiver ce type de source de données via le lot "Comptes".

DataSourceReference

La référence de la source de données peut être utilisée pour gérer les sources de données associées dans le service de source de données.

Champs

Champ d'union data_source_id.

data_source_id ne peut être qu'un des éléments suivants :
self

bool

Self doit être utilisé pour faire référence à la source de données principale elle-même.
primary_data_source_name

string

Facultatif. Nom de la source de données principale. Format : accounts/{account}/dataSources/{datasource}
supplemental_data_source_name

string

Facultatif. Nom de la source de données supplémentaire. Format : accounts/{account}/dataSources/{datasource}

DeleteDataSourceRequest

Message de requête pour la méthode DeleteDataSource.

Champs
name

string

Obligatoire. Nom de la source de données à supprimer. Format : accounts/{account}/dataSources/{datasource}

FetchDataSourceRequest

Message de requête pour la méthode FetchDataSource.

Champs
name

string

Obligatoire. Nom de la ressource de la source de données à extraire. Format : accounts/{account}/dataSources/{datasource}

FileInput

Données spécifiques aux sources de données de fichiers. Ce champ est vide pour les autres entrées de source de données.

Champs
fetch_settings

FetchSettings

Facultatif. Extrayez les détails pour fournir la source de données. Il contient des paramètres pour les types d'entrée de fichiers FETCH et GOOGLE_SHEETS. Les champs obligatoires varient en fonction de la fréquence d'extraction.
file_name

string

Facultatif. Nom du fichier de la source de données. Obligatoire pour le type d'entrée de fichier UPLOAD.
file_input_type

FileInputType

Uniquement en sortie. Type de fichier d'entrée.

FetchSettings

Extrayez les détails pour fournir la source de données.

Champs
enabled

bool

Facultatif. Active ou met en pause la planification de la récupération.
day_of_month

int32

Facultatif. Jour du mois où le fichier de la source de données doit être extrait (1 à 31). Ce champ ne peut être défini que sur une fréquence mensuelle.
time_of_day

TimeOfDay

Facultatif. Heure de la journée à laquelle le fichier de la source de données doit être extrait. Les minutes et les secondes ne sont pas acceptées et seront ignorées.
day_of_week

DayOfWeek

Facultatif. Jour de la semaine auquel le fichier de la source de données doit être extrait. Ce champ ne peut être défini que pour la fréquence hebdomadaire.
time_zone

string

Facultatif. Fuseau horaire utilisé pour la planification. UTC par défaut. Par exemple, "Amérique/Los_Angeles".
frequency

Frequency

Obligatoire. Fréquence décrivant la planification de la récupération.
fetch_uri

string

Facultatif. URL à partir de laquelle le fichier de la source de données peut être extrait. Google Merchant Center accepte les importations planifiées automatiques à l'aide des protocoles HTTP, HTTPS ou SFTP. La valeur doit donc être un lien valide utilisant l'un de ces trois protocoles. Il est immuable pour les fichiers Google Sheets.
username

string

Facultatif. Nom d'utilisateur facultatif pour fetch_uri. Permet d'envoyer des sources de données via SFTP.
password

string

Facultatif. Mot de passe facultatif pour fetch_uri. Permet d'envoyer des sources de données via SFTP.

Fréquence

Les champs obligatoires varient en fonction de la fréquence d'extraction. Pour une planification de récupération mensuelle, les valeurs [jour du mois][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] et [heure de la journée][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] sont obligatoires. Pour une planification de récupération hebdomadaire, les valeurs [jour de la semaine][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week] et [heure de la journée][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] sont obligatoires. Pour une planification quotidienne de la récupération, seule une [heure de la journée][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] est requise.

Enums
FREQUENCY_UNSPECIFIED Fréquence non spécifiée.
FREQUENCY_DAILY La récupération a lieu tous les jours.
FREQUENCY_WEEKLY La récupération a lieu toutes les semaines.
FREQUENCY_MONTHLY La récupération a lieu tous les mois.

FileInputType

Mode de diffusion du fichier.

Enums
FILE_INPUT_TYPE_UNSPECIFIED Type d'entrée de fichier non spécifié.
UPLOAD Le fichier est importé via SFTP, Google Cloud Storage ou manuellement dans Merchant Center.
FETCH Le fichier est extrait de la fetch_uri configurée.
GOOGLE_SHEETS Le fichier est extrait de Google Sheets, comme indiqué dans le fichier fetch_uri.

FileUpload

Importation de fichier d'une source de données spécifique, c'est-à-dire résultat de la récupération de la source de données à un certain code temporel calculé de manière asynchrone lorsque le traitement de la source de données est terminé. Ne s'applique qu'aux sources de données de fichiers.

Champs
name

string

Identifiant. Nom de l'importation du fichier de la source de données. Format : {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}
data_source_id

int64

Uniquement en sortie. ID de la source de données.
processing_state

ProcessingState

Uniquement en sortie. État de traitement de la source de données.
issues[]

Issue

Uniquement en sortie. Liste des problèmes rencontrés dans la source de données.
items_total

int64

Uniquement en sortie. Nombre d'éléments de la source de données traités.
items_created

int64

Uniquement en sortie. Nombre d'éléments créés dans la source de données.
items_updated

int64

Uniquement en sortie. Nombre d'éléments de la source de données qui ont été mis à jour.
upload_time

Timestamp

Uniquement en sortie. Date à laquelle le fichier de la source de données a été importé.

Problème

Une erreur s'est produite dans la source de données, par exemple "Prix non valide".

Champs
title

string

Uniquement en sortie. Titre du problème (par exemple, "Élément trop volumineux").
description

string

Uniquement en sortie. La description de l'erreur, par exemple : "Votre source de données contient des éléments qui sont trop volumineux ou comportent trop d'attributs. Ces éléments seront supprimés."
code

string

Uniquement en sortie. Code de l'erreur (par exemple, "validation/invalid_value"). Renvoie "?" si le code est inconnu.
count

int64

Uniquement en sortie. Nombre d'occurrences de l'erreur lors de l'importation du fichier.
severity

Severity

Uniquement en sortie. Gravité du problème.
documentation_uri

string

Uniquement en sortie. Lien vers la documentation expliquant le problème plus en détail, le cas échéant.

Gravité

Gravité du problème.

Enums
SEVERITY_UNSPECIFIED Gravité non spécifiée.
WARNING Le problème est l'avertissement.
ERROR Il s'agit d'une erreur.

ProcessingState

État de traitement de la source de données.

Enums
PROCESSING_STATE_UNSPECIFIED État de traitement non spécifié.
FAILED La source de données n'a pas pu être traitée ou tous les éléments comportaient des erreurs.
IN_PROGRESS La source de données est en cours de traitement.
SUCCEEDED La source de données a bien été traitée, mais des erreurs peuvent s'être produites pour certains éléments.

GetDataSourceRequest

Message de requête pour la méthode GetDataSource.

Champs
name

string

Obligatoire. Nom de la source de données à récupérer. Format : accounts/{account}/dataSources/{datasource}

GetFileUploadRequest

Message de requête pour la méthode GetFileUploadRequest.

Champs
name

string

Obligatoire. Nom de l'importation de fichier de la source de données à récupérer. Format : accounts/{account}/dataSources/{datasource}/fileUploads/latest

ListDataSourcesRequest

Message de requête pour la méthode ListDataSources.

Champs
parent

string

Obligatoire. Compte pour lequel lister les sources de données. Format : accounts/{account}
page_size

int32

Facultatif. Nombre maximal de sources de données à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000. Si ce paramètre n'est pas spécifié, le nombre maximal de sources de données est renvoyé.
page_token

string

Facultatif. Jeton de page reçu d'un appel ListDataSources précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListDataSources doivent correspondre à l'appel ayant fourni le jeton de page.

ListDataSourcesResponse

Message de réponse pour la méthode ListDataSources.

Champs
data_sources[]

DataSource

Sources de données du compte spécifié.
next_page_token

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

LocalInventoryDataSource

Source de données d'inventaire en magasin.

Champs
feed_label

string

Obligatoire. Immuable. Libellé du flux des offres auxquelles l'inventaire en magasin est fourni.

Doit comporter 20 caractères au maximum et ne peut contenir que des lettres majuscules (A-Z), des chiffres (0-9) et des tirets (-).

Consultez également la section Migration vers les libellés de flux.
content_language

string

Obligatoire. Immuable. Code de langue ISO 639-1 à deux lettres des articles pour lesquels l'inventaire local est fourni.

MerchantReviewDataSource

Ce type ne comporte aucun champ.

Source des données des avis sur les marchands.

PrimaryProductDataSource

Source de données principale pour les produits en magasin et en ligne.

Champs
channel

Channel

Obligatoire. Immuable. Spécifie le type de canal de la source de données.
countries[]

string

Facultatif. Pays dans lesquels les articles peuvent être affichés. Représenté par un code de territoire CLDR.
default_rule

DefaultRule

Facultatif. Gestion des règles par défaut de la source de données. Si cette valeur est définie, les sources de données associées seront remplacées.
feed_label

string

Facultatif. Immuable. Étiquette du flux spécifiée au niveau de la source de données.

Doit comporter 20 caractères au maximum et ne peut contenir que des lettres majuscules (A-Z), des chiffres (0-9) et des tirets (-).

Consultez également la section Migration vers les libellés de flux.

feedLabel et contentLanguage doivent être tous deux définis ou non pour les sources de données avec le type de contenu produit. Ils doivent être définis pour les sources de données avec une entrée de fichier.

Si cette valeur est définie, la source de données n'acceptera que les produits correspondant à cette combinaison. Si cette valeur n'est pas définie, la source de données acceptera les produits sans cette restriction.
content_language

string

Facultatif. Immuable. Langue ISO 639-1 à deux lettres des éléments de la source de données.

feedLabel et contentLanguage doivent être tous les deux définis ou non. Vous ne pouvez définir les champs que pour les sources de données sans importation de fichier.

Si cette valeur est définie, la source de données n'acceptera que les produits correspondant à cette combinaison. Si cette valeur n'est pas définie, la source de données acceptera les produits sans cette restriction.

Chaîne

Canal de la source de données.

Le canal permet de distinguer les sources de données pour différents secteurs de produits.

Enums
CHANNEL_UNSPECIFIED Non spécifié.
ONLINE_PRODUCTS Produit en ligne.
LOCAL_PRODUCTS Produit en magasin
PRODUCTS Source de données unifiée pour les produits en magasin et en ligne. Remarque: La gestion des produits via l'API n'est pas possible pour ce canal.

DefaultRule

Gestion des règles par défaut de la source de données.

Champs
take_from_data_sources[]

DataSourceReference

Obligatoire. Liste des sources de données associées dans la règle par défaut. Cette liste est triée en fonction de la priorité par défaut de la règle de jointure des données. Il peut ne contenir aucune référence à self et aux sources de données supplémentaires, ou plusieurs références.

La liste ne doit pas être vide.

Pour associer la source de données à la règle par défaut, vous devez ajouter une référence à cette liste (dans l'ordre séquentiel).

Pour dissocier la source de données de la règle par défaut, vous devez supprimer la référence donnée de cette liste.

Si vous modifiez l'ordre de cette liste, la priorité des sources de données dans la règle par défaut sera modifiée.

Par exemple, si vous indiquez la liste suivante: [1001, self], les valeurs d'attribut seront extraites de la source de données supplémentaire 1001 et self sera utilisé si l'attribut n'est pas défini dans 1001.

ProductReviewDataSource

Ce type ne comporte aucun champ.

Source de données des avis sur les produits.

PromotionDataSource

Source de données de la promotion.

Champs
target_country

string

Obligatoire. Immuable. Pays cible utilisé dans l'identifiant unique. Représenté par un code de territoire CLDR.

Les promotions ne sont disponibles que dans certains pays.
content_language

string

Obligatoire. Immuable. Langue ISO 639-1 à deux lettres des éléments de la source de données.

RegionalInventoryDataSource

Source de données d'inventaire régional.

Champs
feed_label

string

Obligatoire. Immuable. Libellé du flux des offres auxquelles l'inventaire régional est fourni.

Doit comporter 20 caractères au maximum et ne peut contenir que des lettres majuscules (A-Z), des chiffres (0-9) et des tirets (-).

Consultez également la section Migration vers les libellés de flux.
content_language

string

Obligatoire. Immuable. Code de langue ISO 639-1 à deux lettres des articles pour lesquels l'inventaire régional est fourni.

SupplementalProductDataSource

Source de données supplémentaire pour les produits en magasin et en ligne. Une fois la source de données produit supplémentaire créée, assurez-vous de l'associer à une ou plusieurs sources de données produit principales.

Champs
referencing_primary_data_sources[]

DataSourceReference

Uniquement en sortie. Liste (non ordonnée et dédupliquée) de toutes les sources de données principales associées à cette source de données dans des règles par défaut ou personnalisées. Vous ne pouvez pas supprimer une source de données supplémentaire avant d'avoir supprimé tous les liens.
feed_label

string

Facultatif. Immuable. Étiquette du flux spécifiée au niveau de la source de données.

Doit comporter 20 caractères au maximum et ne peut contenir que des lettres majuscules (A-Z), des chiffres (0-9) et des tirets (-).

Consultez également la section Migration vers les libellés de flux.

feedLabel et contentLanguage doivent être tous deux définis ou non pour les sources de données avec le type de contenu produit.

Ils doivent être définis pour les sources de données avec un file input. Les champs ne doivent pas être définis pour les sources de données sans file input.

Si cette valeur est définie, la source de données n'acceptera que les produits correspondant à cette combinaison. Si cette valeur n'est pas définie, la source de données acceptera les produits sans cette restriction.
content_language

string

Facultatif. Immuable. Langue ISO 639-1 à deux lettres des éléments de la source de données.

feedLabel et contentLanguage doivent être tous les deux définis ou non. Vous ne pouvez définir les champs que pour les sources de données sans importation de fichier.

Si cette valeur est définie, la source de données n'acceptera que les produits correspondant à cette combinaison. Si cette valeur n'est pas définie, la source de données acceptera les produits sans cette restriction.

UpdateDataSourceRequest

Message de requête pour la méthode UpdateDataSource.

Champs
data_source

DataSource

Obligatoire. Ressource de la source de données à mettre à jour.
update_mask

FieldMask

Obligatoire. Liste des champs de la source de données à mettre à jour.

Les champs spécifiés dans le masque de mise à jour sans valeur spécifiée dans le corps seront supprimés de la source de données.

Il n'est pas possible de fournir une valeur spéciale "*" pour le remplacement complet de la source de données.