Package google.shopping.merchant.datasources.v1beta

شاخص

DataSourcesService

خدماتی برای مدیریت منابع داده اولیه، تکمیلی، موجودی و سایر منابع. در مقاله راهنمای Merchant Center بیشتر ببینید.

CreateDataSource

rpc CreateDataSource( CreateDataSourceRequest ) returns ( DataSource )

پیکربندی منبع داده جدید را برای حساب داده شده ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

DeleteDataSource

rpc DeleteDataSource( DeleteDataSourceRequest ) returns ( Empty )

یک منبع داده را از حساب Merchant Center شما حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

FetchDataSource

rpc FetchDataSource( FetchDataSourceRequest ) returns ( Empty )

واکشی داده را فوراً (حتی برنامه واکشی خارج از برنامه) در یک منبع داده از حساب Merchant Center شما انجام می دهد. اگر نیاز دارید بیش از یک بار در روز با این روش تماس بگیرید، باید از سرویس محصولات برای به‌روزرسانی اطلاعات محصول خود استفاده کنید. این روش فقط روی منابع داده با مجموعه ورودی فایل کار می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

GetDataSource

rpc GetDataSource( GetDataSourceRequest ) returns ( DataSource )

پیکربندی منبع داده را برای حساب داده شده بازیابی می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

ListDataSources

rpc ListDataSources( ListDataSourcesRequest ) returns ( ListDataSourcesResponse )

تنظیمات منابع داده را برای حساب داده شده فهرست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

UpdateDataSource

rpc UpdateDataSource( UpdateDataSourceRequest ) returns ( DataSource )

پیکربندی منبع داده موجود را به روز می کند. فیلدهایی که در ماسک به روز رسانی تنظیم شده اند اما در منبع ارائه نشده اند حذف خواهند شد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

FileUploadsService

سرویس برای مدیریت بارگذاری فایل منبع داده.

GetFileUpload

rpc GetFileUpload( GetFileUploadRequest ) returns ( FileUpload )

آخرین آپلود فایل منبع داده را دریافت می کند. فقط latest نام مستعار برای آپلود فایل پذیرفته می شود.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .

CreateDataSourceRequest

درخواست پیام برای متد CreateDataSource.

فیلدها
parent

string

مورد نیاز. حسابی که این منبع داده در آن ایجاد خواهد شد. قالب: accounts/{account}

data_ source

DataSource

مورد نیاز. منبع داده برای ایجاد

منبع داده

منبع داده برای حساب Merchant Center.

فیلدها
name

string

شناسه. نام منبع داده قالب: {datasource.name=accounts/{account}/dataSources/{datasource}}

data_ source_ id

int64

فقط خروجی شناسه منبع داده

display_ name

string

مورد نیاز. نام منبع داده نمایش داده شده در رابط کاربری Merchant Center.

input

Input

فقط خروجی نوع ورودی به منبع داده را تعیین می کند. بر اساس ورودی ممکن است برخی از تنظیمات کار نکنند. فقط منابع داده عمومی را می توان از طریق API ایجاد کرد.

file_ input

FileInput

اختیاری. این فیلد فقط زمانی استفاده می شود که داده ها از طریق یک فایل مدیریت شوند.

Type فیلد اتحادیه مورد نیاز. نوع منبع داده Type می تواند تنها یکی از موارد زیر باشد:
primary_ product_ data_ source

PrimaryProductDataSource

منبع داده اولیه برای محصولات محلی و آنلاین.

supplemental_ product_ data_ source

SupplementalProductDataSource

منبع داده تکمیلی برای محصولات محلی و آنلاین.

local_ inventory_ data_ source

LocalInventoryDataSource

منبع داده موجودی محلی

regional_ inventory_ data_ source

RegionalInventoryDataSource

منبع داده های موجودی منطقه ای

promotion_ data_ source

PromotionDataSource

منبع داده های تبلیغاتی

product_ review_ data_ source

ProductReviewDataSource

منبع داده بررسی محصول

merchant_ review_ data_ source

MerchantReviewDataSource

منبع داده بررسی بازرگان .

ورودی

نوع ورودی به منبع داده را تعیین می کند. بر اساس ورودی ممکن است برخی از تنظیمات پشتیبانی نشوند.

Enums
INPUT_UNSPECIFIED ورودی نامشخص است.
API نشان دهنده منابع داده ای است که داده ها عمدتاً از طریق API ارائه می شوند.
FILE نشان دهنده منابع داده ای است که داده ها عمدتاً از طریق ورودی فایل برای آنها ارائه می شود. داده ها همچنان می توانند از طریق API ارائه شوند.
UI

منبع داده برای محصولاتی که مستقیماً در Merchant Center اضافه شده است.

این نوع منبع داده را نمی توان از طریق این API ایجاد یا به روز کرد، فقط توسط Merchant Center UI.

این نوع منبع داده فقط خواندنی است.

AUTOFEED این همچنین به عنوان فیدهای خودکار شناخته می شود که برای ساخت خودکار داده های محصول شما استفاده می شود. این نوع منبع داده را می توان از طریق بسته حساب ها فعال یا غیرفعال کرد.

DataSourceReference

مرجع منبع داده می تواند برای مدیریت منابع داده مرتبط در سرویس منبع داده استفاده شود.

فیلدها

فیلد اتحادیه data_source_id .

data_source_id می تواند تنها یکی از موارد زیر باشد:

self

bool

Self باید برای ارجاع به خود منبع داده اولیه استفاده شود.

primary_ data_ source_ name

string

اختیاری. نام منبع داده اولیه. قالب: accounts/{account}/dataSources/{datasource}

supplemental_ data_ source_ name

string

اختیاری. نام منبع داده تکمیلی. قالب: accounts/{account}/dataSources/{datasource}

DeleteDataSourceRequest

درخواست پیام برای متد DeleteDataSource.

فیلدها
name

string

مورد نیاز. نام منبع داده برای حذف. قالب: accounts/{account}/dataSources/{datasource}

FetchDataSourceRequest

درخواست پیام برای متد FetchDataSource.

فیلدها
name

string

مورد نیاز. نام منبع منبع داده برای واکشی. قالب: accounts/{account}/dataSources/{datasource}

ورودی فایل

داده های خاص برای منابع داده فایل. این فیلد برای سایر ورودی های منبع داده خالی است.

فیلدها
fetch_ settings

FetchSettings

اختیاری. واکشی جزئیات برای ارائه منبع داده. این شامل تنظیماتی برای انواع ورودی فایل FETCH و GOOGLE_SHEETS است. فیلدهای مورد نیاز بر اساس تعداد دفعات واکشی متفاوت است.

file_ name

string

اختیاری. نام فایل منبع داده. برای نوع ورودی فایل UPLOAD مورد نیاز است.

file_ input_ type

FileInputType

فقط خروجی نوع فایل ورودی

FetchSettings

واکشی جزئیات برای ارائه منبع داده.

فیلدها
enabled

bool

اختیاری. برنامه واکشی را فعال یا متوقف می کند.

day_ of_ month

int32

اختیاری. روزی از ماه که فایل منبع داده باید واکشی شود (1-31). این قسمت را فقط می توان برای دفعات ماهانه تنظیم کرد.

time_ of_ day

TimeOfDay

اختیاری. ساعتی از روز که فایل منبع داده باید واکشی شود. دقیقه و ثانیه پشتیبانی نمی شود و نادیده گرفته می شود.

day_ of_ week

DayOfWeek

اختیاری. روزی از هفته که فایل منبع داده باید واکشی شود. این فیلد فقط برای دفعات هفتگی قابل تنظیم است.

time_ zone

string

اختیاری. منطقه زمانی مورد استفاده برای برنامه UTC به صورت پیش فرض به عنوان مثال، "America/Los_Angeles".

frequency

Frequency

مورد نیاز. فرکانس توصیف برنامه واکشی.

fetch_ uri

string

اختیاری. آدرس اینترنتی که فایل منبع داده را می توان واکشی کرد. Google Merchant Center از آپلودهای برنامه ریزی شده خودکار با استفاده از پروتکل های HTTP، HTTPS یا SFTP پشتیبانی می کند، بنابراین مقدار باید یک پیوند معتبر با استفاده از یکی از این سه پروتکل باشد. غیرقابل تغییر برای فایل‌های Google Sheets.

username

string

اختیاری. یک نام کاربری اختیاری برای fetch_uri . برای ارسال منابع داده از طریق SFTP استفاده می شود.

password

string

اختیاری. یک رمز عبور اختیاری برای fetch_uri . برای ارسال منابع داده از طریق SFTP استفاده می شود.

فرکانس

فیلدهای مورد نیاز بر اساس تعداد دفعات واکشی متفاوت است. برای یک برنامه واکشی ماهانه، [روز از ماه][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month] و [ساعت از روز][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day ] مورد نیاز است. برای یک برنامه واکشی هفتگی، [روز هفته][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week] و [ساعت از روز][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day ] مورد نیاز است. برای برنامه واکشی روزانه، فقط یک [ساعت در روز][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day] مورد نیاز است.

Enums
FREQUENCY_UNSPECIFIED فرکانس نامشخص
FREQUENCY_DAILY واکشی هر روز اتفاق می افتد.
FREQUENCY_WEEKLY واکشی هر هفته اتفاق می افتد.
FREQUENCY_MONTHLY واکشی هر ماه اتفاق می افتد.

FileInputType

روش تحویل پرونده

Enums
FILE_INPUT_TYPE_UNSPECIFIED نوع ورودی فایل مشخص نشده است.
UPLOAD فایل از طریق SFTP، Google Cloud Storage یا به صورت دستی در Merchant Center آپلود می شود.
FETCH فایل از fetch_uri پیکربندی شده واکشی شده است.
GOOGLE_SHEETS فایل از کاربرگ‌نگار Google مشخص شده در fetch_uri واکشی شده است.

آپلود فایل

آپلود فایل یک منبع داده خاص، یعنی نتیجه بازیابی منبع داده در یک مُهر زمانی مشخص به‌صورت ناهمزمان محاسبه می‌شود که پردازش منبع داده به پایان رسید. فقط برای منابع داده فایل قابل استفاده است.

فیلدها
name

string

شناسه. نام آپلود فایل منبع داده. قالب: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}

data_ source_ id

int64

فقط خروجی شناسه منبع داده

processing_ state

ProcessingState

فقط خروجی وضعیت پردازش منبع داده

issues[]

Issue

فقط خروجی لیست مشکلاتی که در منبع داده رخ می دهد.

items_ total

int64

فقط خروجی تعداد موارد موجود در منبع داده که پردازش شدند.

items_ created

int64

فقط خروجی تعداد مواردی که در منبع داده ایجاد شده است.

items_ updated

int64

فقط خروجی تعداد موارد موجود در منبع داده که به‌روزرسانی شدند.

upload_ time

Timestamp

فقط خروجی تاریخی که در آن فایل منبع داده آپلود شده است.

موضوع

خطایی در منبع داده رخ می دهد، مانند "قیمت نامعتبر".

فیلدها
title

string

فقط خروجی عنوان شماره، به عنوان مثال، "مورد خیلی بزرگ است".

description

string

فقط خروجی شرح خطا، به عنوان مثال، "منبع داده شما حاوی مواردی است که دارای ویژگی های بیش از حد هستند یا بسیار بزرگ هستند. این موارد حذف خواهند شد".

code

string

فقط خروجی کد خطا، به عنوان مثال، "validation/invalid_value". "?" را برمی گرداند اگر کد ناشناخته باشد

count

int64

فقط خروجی تعداد بروز خطا در آپلود فایل.

severity

Severity

فقط خروجی شدت موضوع.

documentation_ uri

string

فقط خروجی در صورت موجود بودن، به اسنادی پیوند دهید که مشکل را با جزئیات بیشتر توضیح می دهد.

شدت

شدت موضوع.

Enums
SEVERITY_UNSPECIFIED شدت نامشخص
WARNING موضوع هشدار است.
ERROR موضوع یک خطا است.

Processing State

وضعیت پردازش منبع داده

Enums
PROCESSING_STATE_UNSPECIFIED وضعیت پردازش نامشخص است.
FAILED منبع داده قابل پردازش نبود یا همه موارد دارای خطا بودند.
IN_PROGRESS منبع داده در حال پردازش است.
SUCCEEDED منبع داده با موفقیت پردازش شد، اگرچه برخی موارد ممکن است دارای خطا باشند.

GetDataSourceRequest

درخواست پیام برای متد GetDataSource.

فیلدها
name

string

مورد نیاز. نام منبع داده برای بازیابی. قالب: accounts/{account}/dataSources/{datasource}

GetFileUploadRequest

درخواست پیام برای متد GetFileUploadRequest.

فیلدها
name

string

مورد نیاز. نام فایل منبع داده آپلود برای بازیابی. قالب: accounts/{account}/dataSources/{datasource}/fileUploads/latest

ListDataSourcesRequest

درخواست پیام برای متد ListDataSources.

فیلدها
parent

string

مورد نیاز. حسابی برای فهرست کردن منابع داده. قالب: accounts/{account}

page_ size

int32

اختیاری. حداکثر تعداد منابع داده برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند. حداکثر مقدار 1000 است. مقادیر بالای 1000 به 1000 تبدیل می شوند. اگر مشخص نباشد، حداکثر تعداد منابع داده برگردانده می شود.

page_ token

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی ListDataSources . این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به ListDataSources باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

ListDataSourcesResponse

پیام پاسخ برای متد ListDataSources.

فیلدها
data_ sources[]

DataSource

منابع داده از حساب مشخص شده

next_ page_ token

string

یک نشانه، که می تواند به عنوان page_token برای بازیابی صفحه بعدی ارسال شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد.

LocalInventoryDataSource

منبع داده موجودی محلی

فیلدها
feed_ label

string

مورد نیاز. تغییرناپذیر. برچسب خوراک پیشنهادهایی که موجودی محلی به آنها ارائه می شود.

باید کمتر یا مساوی 20 حرف بزرگ (AZ)، اعداد (0-9) و خط تیره (-) باشد.

همچنین مهاجرت به برچسب‌های خوراک را ببینید.

content_ language

string

مورد نیاز. تغییرناپذیر. زبان دو حرفی ISO 639-1 اقلامی که موجودی محلی به آنها ارائه می شود.

MerchantReviewDataSource

این نوع هیچ فیلدی ندارد.

منبع داده بررسی بازرگان.

PrimaryProductDataSource

منبع داده اولیه برای محصولات محلی و آنلاین.

فیلدها
channel

Channel

مورد نیاز. تغییرناپذیر. نوع کانال منبع داده را مشخص می کند.

countries[]

string

اختیاری. کشورهایی که ممکن است موارد نمایش داده شوند. به عنوان کد قلمرو CLDR نشان داده شده است.

default_ rule

DefaultRule

اختیاری. مدیریت قانون پیش فرض منبع داده. در صورت تنظیم، منابع داده مرتبط جایگزین خواهند شد.

feed_ label

string

اختیاری. تغییرناپذیر. برچسب فید که در سطح منبع داده مشخص شده است.

باید کمتر یا مساوی 20 حرف بزرگ (AZ)، اعداد (0-9) و خط تیره (-) باشد.

همچنین مهاجرت به برچسب‌های خوراک را ببینید.

feedLabel و contentLanguage باید برای منابع داده با نوع محتوای محصول هر دو تنظیم یا تنظیم نشده باشند. آنها باید برای منابع داده با ورودی فایل تنظیم شوند.

در صورت تنظیم، منبع داده فقط محصولاتی را می پذیرد که با این ترکیب مطابقت داشته باشند. اگر تنظیم نشود، منبع داده محصولات را بدون آن محدودیت می پذیرد.

content_ language

string

اختیاری. تغییرناپذیر. زبان دو حرفی ISO 639-1 موارد موجود در منبع داده.

feedLabel و contentLanguage باید هر دو تنظیم یا تنظیم نشده باشند. فیلدها را فقط می‌توان برای منابع داده بدون ورودی فایل تنظیم کرد.

در صورت تنظیم، منبع داده فقط محصولاتی را می پذیرد که با این ترکیب مطابقت داشته باشند. اگر تنظیم نشود، منبع داده محصولات را بدون آن محدودیت می پذیرد.

کانال

کانال منبع داده.

کانال برای تمایز بین منابع داده برای عمودهای مختلف محصول استفاده می شود.

Enums
CHANNEL_UNSPECIFIED مشخص نشده است.
ONLINE_PRODUCTS محصول آنلاین.
LOCAL_PRODUCTS محصول محلی
PRODUCTS منبع داده یکپارچه برای محصولات محلی و آنلاین. توجه: مدیریت محصولات از طریق API برای این کانال امکان پذیر نیست.

DefaultRule

مدیریت قانون پیش فرض منبع داده.

فیلدها
take_ from_ data_ sources[]

DataSourceReference

مورد نیاز. فهرست منابع داده‌ای که در قانون پیش‌فرض پیوند داده شده‌اند. این لیست بر اساس اولویت قانون پیش فرض برای پیوستن به داده ها مرتب شده است. ممکن است شامل هیچ یا چندین مرجع به منابع داده self و تکمیلی باشد.

لیست نباید خالی باشد.

برای پیوند دادن منبع داده به قانون پیش فرض، باید یک مرجع جدید به این لیست (به ترتیب متوالی) اضافه کنید.

برای جدا کردن منبع داده از قانون پیش فرض، باید مرجع داده شده را از این لیست حذف کنید.

تغییر ترتیب این لیست منجر به تغییر اولویت منابع داده در قانون پیش فرض می شود.

به عنوان مثال، ارائه لیست زیر: [ 1001 , self ] مقادیر مشخصه را از منبع داده تکمیلی 1001 می گیرد و اگر ویژگی در 1001 تنظیم نشده باشد به self بازگشتی می دهد.

ProductReviewDataSource

این نوع هیچ فیلدی ندارد.

منبع داده بررسی محصول

PromotionData Source

منبع داده های تبلیغاتی

فیلدها
target_ country

string

مورد نیاز. تغییرناپذیر. کشور هدف که به عنوان بخشی از شناسه منحصر به فرد استفاده می شود. به عنوان کد قلمرو CLDR نشان داده شده است.

تبلیغات فقط در کشورهای منتخب موجود است.

content_ language

string

مورد نیاز. تغییرناپذیر. زبان دو حرفی ISO 639-1 موارد موجود در منبع داده.

RegionalInventoryDataSource

منبع داده های موجودی منطقه ای

فیلدها
feed_ label

string

مورد نیاز. تغییرناپذیر. برچسب خوراک پیشنهادهایی که موجودی منطقه ای به آنها ارائه می شود.

باید کمتر یا مساوی 20 حرف بزرگ (AZ)، اعداد (0-9) و خط تیره (-) باشد.

همچنین مهاجرت به برچسب‌های خوراک را ببینید.

content_ language

string

مورد نیاز. تغییرناپذیر. زبان دو حرفی ISO 639-1 اقلامی که موجودی منطقه ای به آنها ارائه می شود.

منبع داده های تکمیلی محصول

منبع داده تکمیلی برای محصولات محلی و آنلاین. پس از ایجاد، باید مطمئن شوید که منبع داده تکمیلی محصول را به یک یا چند منبع داده اولیه محصول مرتبط کرده اید.

فیلدها
referencing_ primary_ data_ sources[]

DataSourceReference

فقط خروجی فهرست (نامرتب و حذف شده) از همه منابع داده اولیه مرتبط با این منبع داده در قوانین پیش‌فرض یا سفارشی. منبع داده های تکمیلی را نمی توان قبل از حذف همه پیوندها حذف کرد.

feed_ label

string

اختیاری. تغییرناپذیر. برچسب فید که در سطح منبع داده مشخص شده است.

باید کمتر یا مساوی 20 حرف بزرگ (AZ)، اعداد (0-9) و خط تیره (-) باشد.

همچنین مهاجرت به برچسب‌های خوراک را ببینید.

feedLabel و contentLanguage باید برای منابع داده با نوع محتوای محصول هر دو تنظیم یا تنظیم نشده باشند.

آنها باید برای منابع داده با file input تنظیم شوند. فیلدها باید برای منابع داده بدون file input تنظیم نشده باشند.

در صورت تنظیم، منبع داده فقط محصولاتی را می پذیرد که با این ترکیب مطابقت داشته باشند. اگر تنظیم نشود، منبع داده محصولات را بدون آن محدودیت می پذیرد.

content_ language

string

اختیاری. تغییرناپذیر. زبان دو حرفی ISO 639-1 موارد موجود در منبع داده.

feedLabel و contentLanguage باید هر دو تنظیم یا تنظیم نشده باشند. فیلدها را فقط می‌توان برای منابع داده بدون ورودی فایل تنظیم کرد.

در صورت تنظیم، منبع داده فقط محصولاتی را می پذیرد که با این ترکیب مطابقت داشته باشند. اگر تنظیم نشود، منبع داده محصولات را بدون آن محدودیت می پذیرد.

UpdateDataSourceRequest

درخواست پیام برای متد UpdateDataSource.

فیلدها
data_ source

DataSource

مورد نیاز. منبع منبع داده برای به روز رسانی.

update_ mask

FieldMask

مورد نیاز. لیست فیلدهای منبع داده که باید به روز شوند.

فیلدهای مشخص شده در ماسک به روز رسانی بدون مقدار مشخص شده در بدنه از منبع داده حذف خواهند شد.

ارائه مقدار "*" ویژه برای جایگزینی کامل منبع داده پشتیبانی نمی شود.