فهرست
-
AccountLabelsService(رابط) -
AccountsService(رابط کاربری) - رابط کاربری (
CssProductInputsService) -
CssProductsService(رابط) -
QuotaService(رابط) -
Account(پیام) -
Account.AccountType(شمارشی) -
AccountLabel(پیام) -
AccountLabel.LabelType(شمارشی) -
Attributes(پیام) -
Certification(پیام) -
CreateAccountLabelRequest(پیام) -
CssProduct(پیام) -
CssProductInput(پیام) -
CssProductStatus(پیام) -
CssProductStatus.DestinationStatus(پیام) - مشکل سطح آیتم (پیام)
CssProductStatus.ItemLevelIssue -
DeleteAccountLabelRequest(پیام) - درخواست ورودی محصول (پیام)
DeleteCssProductInputRequest -
GetAccountRequest(پیام) -
GetCssProductRequest(پیام) -
HeadlineOfferInstallment(پیام) -
HeadlineOfferSubscriptionCost(پیام) - درخواست ورودی محصول (پیام)
InsertCssProductInputRequest -
ListAccountLabelsRequest(پیام) -
ListAccountLabelsResponse(پیام) -
ListChildAccountsRequest(پیام) -
ListChildAccountsResponse(پیام) -
ListCssProductsRequest(پیام) -
ListCssProductsResponse(پیام) -
ListQuotaGroupsRequest(پیام) -
ListQuotaGroupsResponse(پیام) -
MethodDetails(پیام) -
ProductDetail(پیام) -
ProductDimension(پیام) -
ProductWeight(پیام) -
QuotaGroup(پیام) -
SubscriptionPeriod(شمارشی) -
UpdateAccountLabelRequest(پیام) -
UpdateAccountLabelsRequest(پیام) -
UpdateCssProductInputRequest(پیام)
سرویس برچسبهای حساب
برچسبهای حسابهای مرکز فروشندگان و CSS را مدیریت میکند.
| برچسب ایجاد حساب |
|---|
یک برچسب جدید ایجاد میکند که به هیچ حسابی اختصاص داده نشده است.
|
| برچسب حساب را حذف کنید |
|---|
یک برچسب را حذف میکند و آن را از تمام حسابهایی که به آنها اختصاص داده شده است، حذف میکند.
|
| برچسبهای حساب لیست |
|---|
برچسبهای متعلق به یک حساب را فهرست میکند.
|
| برچسب حساب کاربری را بهروزرسانی کنید |
|---|
یک برچسب را بهروزرسانی میکند.
|
سرویس حسابها
سرویسی برای مدیریت اطلاعات حساب CSS/MC.
| دریافت حساب کاربری |
|---|
یک حساب CSS/MC واحد را بر اساس شناسه بازیابی میکند.
|
| حسابهای کاربری ListChild |
|---|
تمام حسابها را تحت شناسه حساب CSS مشخص شده فهرست میکند و به صورت اختیاری بر اساس شناسه برچسب و نام حساب فیلتر میکند.
|
| برچسبهای بهروزرسانی |
|---|
برچسبهای اختصاص داده شده به حسابهای CSS/MC توسط یک دامنه CSS را بهروزرسانی میکند.
|
سرویس ورودیهای CssProduct
سرویسی برای استفاده از منبع CssProductInput. این سرویس به درج/بهروزرسانی/حذف محصولات CSS کمک میکند.
| ورودی محصول را حذف کنید |
|---|
ورودی CSS Product را از حساب CSS Center شما حذف میکند. پس از حذف، ممکن است چند دقیقه طول بکشد تا ورودی دیگر در دسترس نباشد.
|
| ورودی محصول را وارد کنید |
|---|
یک ورودی CssProductInput را به حساب CSS Center شما آپلود میکند. اگر ورودیای با همان contentLanguage، identity، feedLabel و feedId از قبل وجود داشته باشد، این متد آن ورودی را جایگزین میکند. پس از درج، بهروزرسانی یا حذف ورودی CSS Product، ممکن است چند دقیقه طول بکشد تا CSS Product پردازششده بازیابی شود.
|
| ورودی UpdateCssProduct |
|---|
ورودی Css Product موجود در حساب CSS Center شما را بهروزرسانی میکند. پس از درج، بهروزرسانی یا حذف ورودی CSS Product، ممکن است چند دقیقه طول بکشد تا Css Product پردازششده بازیابی شود.
|
خدمات محصولات Css
سرویسی برای دریافت و فهرست کردن محصولات CSS (که به صورت داخلی با نام Aggregate Offers نیز شناخته میشود).
| GetCssProduct |
|---|
محصول CSS پردازششده را از حساب CSS Center شما بازیابی میکند. پس از درج، بهروزرسانی یا حذف ورودی محصول، ممکن است چند دقیقه طول بکشد تا محصول نهایی بهروزرسانیشده بازیابی شود.
|
| محصولات ListCss |
|---|
محصولات CSS پردازششده را در حساب CSS Center شما فهرست میکند. پاسخ ممکن است شامل موارد کمتری نسبت به آنچه توسط pageSize مشخص شده است، باشد. برای تعیین اینکه آیا موارد بیشتری برای درخواست وجود دارد یا خیر، به pageToken تکیه کنید. پس از درج، بهروزرسانی یا حذف ورودی یک محصول CSS، ممکن است چند دقیقه طول بکشد تا محصول CSS پردازششدهی بهروزرسانیشده بازیابی شود.
|
خدمات سهمیهای
سرویسی برای دریافت اطلاعات سهمیه فراخوانی متد به ازای هر متد CSS API.
| لیست سهمیهها |
|---|
سهمیه تماس روزانه و میزان استفاده به ازای هر گروه را برای حساب CSS Center شما فهرست میکند.
|
حساب کاربری
اطلاعات مربوط به حساب CSS/MC.
| فیلدها | |
|---|---|
name | نام منبع برچسب. قالب: accounts/{account} |
full_name | فقط خروجی. تغییرناپذیر. نام کامل حساب CSS/MC. |
label_ids[] | شناسههای برچسب ایجاد شده به صورت دستی که توسط یک حساب والد CSS به حساب CSS/MC اختصاص داده شدهاند. |
automatic_label_ids[] | شناسههای برچسب ایجاد شده به صورت خودکار توسط مرکز CSS به حساب MC اختصاص داده شدهاند. |
account_type | فقط خروجی. نوع این حساب. |
display_name | نام نمایشی کوتاه حساب CSS/MC. |
homepage_uri | فقط خروجی. تغییرناپذیر. صفحه اصلی حساب CSS/MC. |
parent | منبع والد حساب CSS/MC. گروه CSS برای دامنههای CSS؛ دامنه CSS برای حسابهای MC. فقط در صورتی برگردانده میشود که کاربر به حساب والد دسترسی داشته باشد. توجه: برای زیرحسابهای MC، این دامنه CSS منبع والد حساب MCA نیز هست، زیرا ما عملاً در حال مسطح کردن سلسله مراتب هستیم. |
نوع حساب
نوع حساب.
| انومها | |
|---|---|
ACCOUNT_TYPE_UNSPECIFIED | نوع حساب کاربری نامشخص |
CSS_GROUP | حساب گروهی CSS. |
CSS_DOMAIN | حساب دامنه CSS. |
MC_PRIMARY_CSS_MCA | حساب کاربری اصلی MC CSS MCA. |
MC_CSS_MCA | حساب کاربری MC CSS MCA. |
MC_MARKETPLACE_MCA | حساب MC Marketplace MCA. |
MC_OTHER_MCA | حساب MC دیگر MCA. |
MC_STANDALONE | حساب مستقل MC. |
MC_MCA_SUBACCOUNT | حساب فرعی MC MCA. |
برچسب حساب
برچسبی که توسط دامنه CSS یا گروه CSS به یکی از زیرحسابهای آن اختصاص داده شده است.
| فیلدها | |
|---|---|
name | شناسه. نام منبع برچسب. قالب: accounts/{account}/labels/{label} |
label_id | فقط خروجی. شناسه برچسب. |
account_id | فقط خروجی. شناسه حسابی که این برچسب به آن تعلق دارد. |
label_type | فقط خروجی. نوع این برچسب. |
display_name | نام نمایشی این برچسب. |
description | توضیحات این برچسب |
نوع برچسب
نوع برچسب.
| انومها | |
|---|---|
LABEL_TYPE_UNSPECIFIED | نوع برچسب ناشناخته. |
MANUAL | نشان میدهد که برچسب به صورت دستی ایجاد شده است. |
AUTOMATIC | نشان میدهد که برچسب به طور خودکار توسط CSS Center ایجاد شده است. |
ویژگیها
ویژگیهای محصول CSS.
| فیلدها | |
|---|---|
low_price | قیمت پایین محصول CSS. |
high_price | قیمت بالای محصول CSS. |
headline_offer_price | قیمت اصلی محصول CSS. |
headline_offer_shipping_price | قیمت اصلی محصول CSS. |
additional_image_links[] | آدرس اینترنتی (URL) تصاویر اضافی کالا. |
product_types[] | دسته بندی های کالا (با فرمت مشخصات داده محصولات ). |
size_types[] | برش کالا. میتوان از آن برای نمایش انواع سایزهای ترکیبی برای پوشاک استفاده کرد. حداکثر دو نوع سایز میتواند ارائه شود (به نوع سایز مراجعه کنید). |
product_details[] | مشخصات فنی یا جزئیات بیشتر محصول. |
product_weight | وزن محصول به واحدهای ارائه شده. این مقدار باید بین 0 (به جز وزن خالص) و 2000 (شامل وزن خالص) باشد. |
product_length | طول محصول بر اساس واحدهای ارائه شده. مقدار باید بین 0 (به جز) و 3000 (شامل) باشد. |
product_width | عرض محصول بر اساس واحدهای ارائه شده. مقدار باید بین 0 (به جز عرض محصول) و 3000 (شامل عرض محصول) باشد. |
product_height | ارتفاع محصول در واحدهای ارائه شده. مقدار باید بین 0 (به جز ارتفاع محصول) و 3000 (شامل ارتفاع محصول) باشد. |
product_highlights[] | نکات برجستهای که مرتبطترین ویژگیهای یک محصول را توصیف میکنند. |
certifications[] | فهرستی از گواهینامههای مورد ادعای CSS برای محصول مورد نظر. |
expiration_date | تاریخی که کالا باید در آن تاریخ منقضی شود، همانطور که هنگام درج مشخص شده است، در قالب ISO 8601. تاریخ انقضای واقعی در |
included_destinations[] | فهرست مقصدهایی که باید برای این هدف لحاظ شوند (مطابق با کادرهای انتخابشده در مرکز فروشندگان). مقصدهای پیشفرض همیشه لحاظ میشوند، مگر اینکه در |
excluded_destinations[] | فهرست مقاصدی که باید برای این هدف حذف شوند (مطابق با کادرهای انتخاب نشده در مرکز فروشندگان). |
headline_offer_installment | تعداد و مبلغ اقساط برای پرداخت یک کالا. |
headline_offer_subscription_cost | تعداد دورهها (ماهها یا سالها) و مبلغ پرداختی در هر دوره برای یک کالا با قرارداد اشتراک مرتبط. |
cpp_link | آدرس اینترنتی (URL) که مستقیماً به صفحه جزئیات محصول شما در CSS لینک میدهد. |
cpp_mobile_link | آدرس اینترنتی نسخه بهینه شده برای موبایل صفحه جزئیات محصول در CSS. |
cpp_ads_redirect | به تبلیغکنندگان اجازه میدهد تا هنگام نمایش محصول در متن تبلیغات محصول، URL کالا را نادیده بگیرند. |
number_of_offers | تعداد محصولات CSS. |
headline_offer_condition | وضعیت پیشنهاد اصلی. |
headline_offer_link | لینک به پیشنهاد ویژه. |
headline_offer_mobile_link | لینک موبایل به پیشنهاد ویژه. |
title | عنوان کالا. |
image_link | آدرس اینترنتی (URL) تصویر کالا. |
description | شرح کالا. |
brand | ویژگیهای مرتبط با محصول.[14-36] برند کالا. |
mpn | شماره قطعه سازنده ( MPN ) کالا. |
gtin | شماره جهانی قلم تجاری ( GTIN ) قلم. |
google_product_category | دستهبندی گوگل برای کالا (به دستهبندی محصولات گوگل مراجعه کنید). هنگام جستجوی محصولات، این فیلد حاوی مقداری خواهد بود که کاربر ارائه داده است. در حال حاضر هیچ راهی برای بازیابی دستهبندیهای خودکار اختصاص داده شده به محصولات گوگل از طریق API وجود ندارد. |
adult | اگر آیتم برای بزرگسالان در نظر گرفته شده است، روی true تنظیم کنید. |
multipack | تعداد محصولات یکسان در یک بستهبندی چندگانه تعریفشده توسط فروشنده. |
is_bundle | اینکه آیا کالا به صورت بستهی تعریفشده توسط فروشنده است یا خیر. بسته، گروهبندی سفارشی از محصولات مختلف است که توسط یک فروشنده با یک قیمت واحد فروخته میشود. |
age_group | گروه سنی هدف کالا. |
color | رنگ کالا. |
gender | جنسیت مورد نظر برای کالا. |
material | مادهای که کالا از آن ساخته شده است. |
pattern | طرح روی کالا (مثلاً طرح خالخالی). |
size | اندازه کالا. فقط یک مقدار مجاز است. برای انواع با اندازههای مختلف، برای هر اندازه یک محصول جداگانه با مقدار |
size_system | سیستمی که در آن اندازه مشخص شده است. برای اقلام پوشاک توصیه میشود. |
item_group_id | شناسه مشترک برای همه انواع یک محصول. |
pause | انتشار این مطلب موقتاً متوقف خواهد شد. |
custom_label_0 | برچسب سفارشی ۰ برای گروهبندی سفارشی اقلام در یک کمپین خرید. |
custom_label_1 | برچسب سفارشی ۱ برای گروهبندی سفارشی اقلام در یک کمپین خرید. |
custom_label_2 | برچسب سفارشی ۲ برای گروهبندی سفارشی اقلام در یک کمپین خرید. |
custom_label_3 | برچسب سفارشی ۳ برای گروهبندی سفارشی اقلام در یک کمپین خرید. |
custom_label_4 | برچسب سفارشی ۴ برای گروهبندی سفارشی اقلام در یک کمپین خرید. |
review_count | تعداد نظرات مربوط به محصول. در صورت ارائه |
min_rating | حداقل امتیاز رتبهبندی محصول. در صورت ارائه |
max_rating | حداکثر امتیاز رتبهبندی محصول. در صورت ارائه |
rating | میانگین امتیاز رتبهبندی محصول. این مقدار باید در محدوده [ |
صدور گواهینامه
گواهینامه محصول. از این ویژگی برای توصیف گواهینامههای مرتبط با یک محصول، مانند رتبهبندی بهرهوری انرژی، استفاده کنید.
| فیلدها | |
|---|---|
name | نام گواهینامه. در حال حاضر، رایجترین مقدار "EPREL" است که نشاندهنده گواهینامههای بهرهوری انرژی در پایگاه داده ثبت اروپایی برچسبگذاری انرژی (EPREL) اتحادیه اروپا است. |
authority | مرجع یا نهاد صدور گواهینامه مسئول صدور گواهینامه. در حال حاضر، رایجترین مقدار برای برچسبهای انرژی در اتحادیه اروپا "EC" یا "European_Commission" است. |
code | کد گواهینامه. به عنوان مثال، برای گواهینامه EPREL با لینک https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 کد 123456 است. این کد برای برچسبهای انرژی اروپایی الزامی است. |
درخواست ایجاد حساب کاربری
درخواست پیام برای متد 'CreateAccountLanel'.
| فیلدها | |
|---|---|
parent | الزامی. حساب والد. فرمت: accounts/{account} |
account_label | الزامی. برچسبی که باید ایجاد شود. |
سیاسپرادکت
محصول CSS پردازش شده.
| فیلدها | |
|---|---|
name | نام محصول CSS. فرمت: |
raw_provided_id | فقط خروجی. شناسه خام منحصر به فرد شما برای محصول. |
content_language | فقط خروجی. کد زبان دو حرفی ISO 639-1 برای محصول. |
feed_label | فقط خروجی. برچسب تغذیه برای محصول. |
attributes | فقط خروجی. فهرستی از ویژگیهای محصول. |
custom_attributes[] | فقط خروجی. فهرستی از ویژگیهای سفارشی (ارائه شده توسط CSS). همچنین میتوان از آن برای ارسال هر ویژگی از مشخصات فید به شکل عمومی آن استفاده کرد (برای مثال، |
css_product_status | فقط خروجی. وضعیت یک محصول، مسائل اعتبارسنجی دادهها، یعنی اطلاعات مربوط به یک محصول که به صورت ناهمزمان محاسبه میشود. |
ورودی CssProduct
این منبع نشاندهندهی دادههای ورودی است که شما برای یک محصول CSS ارسال میکنید، نه محصول CSS پردازششدهای که در CSS Center، Shopping Ads یا در سطوح مختلف گوگل مشاهده میکنید.
| فیلدها | |
|---|---|
name | شناسه. نام ورودی CSS محصول. قالب: |
final_name | فقط خروجی. نام محصول CSS پردازش شده. قالب: |
raw_provided_id | الزامی. شناسه منحصر به فرد شما برای محصول CSS. این برای ورودی محصول CSS و محصول CSS پردازش شده یکسان است. ما فقط شناسههایی با حروف الفبا، زیرخط و خط تیره را مجاز میدانیم. برای جزئیات بیشتر به مشخصات فید محصولات مراجعه کنید. |
content_language | الزامی. کد زبان دو حرفی ISO 639-1 برای محصول CSS. |
feed_label | الزامی. برچسب فید برای محصول CSS. برچسب فید مترادف با "کشور هدف" است و از این رو همیشه باید یک کد منطقه معتبر باشد. به عنوان مثال: 'DE' برای آلمان، 'FR' برای فرانسه. |
freshness_time | منسوخ شده. به جای آن از expire_date استفاده کنید. نشاندهندهی نسخه موجود (تازه بودن) محصول CSS است که میتواند برای حفظ ترتیب صحیح هنگام انجام چندین بهروزرسانی همزمان استفاده شود. این فیلد نباید به زمان آینده تنظیم شود. اگر تنظیم شود، اگر نسخه جدیدتری از آیتم از قبل در سیستم ما وجود داشته باشد (یعنی آخرین زمان بهروزرسانی محصولات CSS موجود دیرتر از زمان تازگی تنظیمشده در بهروزرسانی باشد)، از بهروزرسانی جلوگیری میشود. اگر بهروزرسانی اتفاق بیفتد، آخرین زمان بهروزرسانی روی این زمان تازگی تنظیم میشود. اگر تنظیم نشود، از بهروزرسانی جلوگیری نمیشود و آخرین زمان بهروزرسانی بهطور پیشفرض به زمانی که این درخواست توسط CSS API دریافت شده است، تنظیم میشود. اگر از اجرای عملیات جلوگیری شود، خطای لغو شده (aborted exception) رخ خواهد داد. |
attributes | فهرستی از ویژگیهای محصول CSS. |
custom_attributes[] | فهرستی از ویژگیهای سفارشی (ارائه شده توسط CSS). همچنین میتواند برای ارسال هر ویژگی از مشخصات فید به شکل عمومی آن استفاده شود (برای مثال: |
وضعیت محصول Css
وضعیت Css Product، مسائل مربوط به اعتبارسنجی دادهها، یعنی اطلاعات مربوط به Css Product که به صورت ناهمزمان محاسبه میشوند.
| فیلدها | |
|---|---|
destination_statuses[] | مقاصد در نظر گرفته شده برای محصول. |
item_level_issues[] | فهرستی از تمام مشکلات مرتبط با محصول. |
creation_date | تاریخ ایجاد آیتم، با فرمت ISO 8601 . |
last_update_date | تاریخ آخرین بهروزرسانی مورد، با فرمت ISO 8601 . |
google_expiration_date | تاریخ انقضای کالا، با فرمت ISO 8601 . |
وضعیت مقصد
وضعیت مقصدِ محصول.
| فیلدها | |
|---|---|
destination | نام مقصد |
approved_countries[] | فهرست کدهای کشوری (ISO 3166-1 alpha-2) که محصول CSS در آنها تأیید شده است. |
pending_countries[] | فهرست کدهای کشوری (ISO 3166-1 alpha-2) که محصول CSS در انتظار تأیید در آنها است. |
disapproved_countries[] | فهرست کدهای کشوری (ISO 3166-1 alpha-2) که محصول CSS در آنها رد شده است. |
شماره سطح آیتم
شماره آیتم سطح مربوط به وضعیت محصول.
| فیلدها | |
|---|---|
code | کد خطای مربوط به مشکل. |
servability | چگونه این مشکل بر ارائه محصول CSS تأثیر میگذارد. |
resolution | اینکه آیا مشکل توسط فروشنده قابل حل است یا خیر. |
attribute | نام ویژگی، در صورتی که مشکل ناشی از یک ویژگی واحد باشد. |
destination | مقصدی که مشکل به آن مربوط میشود. |
description | شرح مختصری از مشکل به زبان انگلیسی. |
detail | شرح مفصلی از مشکل به زبان انگلیسی. |
documentation | آدرس اینترنتی یک صفحه وب برای کمک به حل این مشکل. |
applicable_countries[] | فهرست کدهای کشور (ISO 3166-1 alpha-2) که در آن موضوع مربوط به محصول CSS است. |
درخواست حذف برچسب حساب
درخواست پیام برای متد 'DeleteAccountLabel'.
| فیلدها | |
|---|---|
name | الزامی. نام برچسبی که قرار است حذف شود. قالب: accounts/{account}/labels/{label} |
درخواست ورودی محصول را حذف کنید
درخواست پیام برای متد DeleteCssProductInput.
| فیلدها | |
|---|---|
name | الزامی. نام منبع ورودی محصول CSS برای حذف. قالب: accounts/{account}/cssProductInputs/{css_product_input}، که در آن بخش آخر |
supplemental_feed_id | شناسه فید تکمیلی API محتوا. اگر اکشن به یک فید اصلی اعمال شود، فیلد نباید تنظیم شود. اگر فیلد تنظیم شود، اکشن محصول به جای فید API محتوای اصلی، به یک فید تکمیلی اعمال میشود. |
درخواست دریافت حساب
پیام درخواست برای متد GetAccount .
| فیلدها | |
|---|---|
name | الزامی. نام حساب CSS/MC مدیریتشده. قالب: accounts/{account} |
parent | اختیاری. فقط هنگام بازیابی اطلاعات حساب MC مورد نیاز است. دامنه CSS که منبع والد حساب MC است. قالب: accounts/{account} |
درخواست GetCssProduct
پیام درخواست برای متد GetCssProduct .
| فیلدها | |
|---|---|
name | الزامی. نام محصول CSS برای بازیابی. قالب: |
پیشنهاد ویژه اقساط
پیامی که نشان دهنده قسط است.
| فیلدها | |
|---|---|
months | تعداد اقساطی که خریدار باید پرداخت کند. |
amount | مبلغی که خریدار باید ماهانه بپردازد. |
downpayment | مبلغ پیشپرداختی که خریدار باید بپردازد. |
پیشنهاد ویژههزینه اشتراک
هزینه اشتراک محصول.
| فیلدها | |
|---|---|
period | نوع دوره اشتراک. مقادیر پشتیبانی شده عبارتند از: * " |
period_length | تعداد دورههای اشتراکی که خریدار باید پرداخت کند. |
amount | مبلغی که خریدار باید برای هر دوره اشتراک بپردازد. |
درخواست ورودی محصول را وارد کنید
درخواست پیام برای متد InsertCssProductInput.
| فیلدها | |
|---|---|
parent | الزامی. حسابی که این محصول CSS در آن درج خواهد شد. قالب: accounts/{account} |
css_product_input | الزامی. ورودی CSS محصول برای درج. |
feed_id | اختیاری. منسوخ شده. شناسه فید برای محصولات CSS لازم نیست. شناسه فید اصلی یا تکمیلی. اگر محصول CSS از قبل وجود داشته باشد و شناسه فید ارائه شده متفاوت باشد، محصول CSS به یک فید جدید منتقل میشود. توجه: در حال حاضر، CSSها نیازی به ارائه شناسه فید ندارند زیرا ما فیدها را به صورت آنی ایجاد میکنیم. ما هنوز پشتیبانی از فید تکمیلی برای محصولات CSS نداریم. |
درخواست برچسبهای حساب ListAccount
درخواست پیام برای متد ListAccountLabels .
| فیلدها | |
|---|---|
parent | الزامی. حساب والد. فرمت: accounts/{account} |
page_size | حداکثر تعداد برچسبهایی که باید برگردانده شوند. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۵۰ برچسب برگردانده خواهد شد. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بالاتر از ۱۰۰۰ به ۱۰۰۰ محدود میشوند. |
page_token | یک توکن صفحه، که از فراخوانی قبلی هنگام صفحهبندی، تمام پارامترهای دیگر ارائه شده به |
ListAccountLabelsResponse
پیام پاسخ برای متد ListAccountLabels .
| فیلدها | |
|---|---|
account_labels[] | برچسبهای حساب مشخصشده. |
next_page_token | یک توکن، که میتواند به عنوان |
درخواست حسابهای کاربری ListChild
پیام درخواست برای متد ListChildAccounts .
| فیلدها | |
|---|---|
parent | الزامی. حساب کاربری والد. باید یک گروه یا دامنه CSS باشد. فرمت: accounts/{account} |
page_size | اختیاری. حداکثر تعداد حسابهایی که باید برگردانده شوند. سرویس ممکن است کمتر از این مقدار را برگرداند. در صورت عدم تعیین، حداکثر ۵۰ حساب برگردانده خواهد شد. حداکثر مقدار ۱۰۰ است؛ مقادیر بالاتر از ۱۰۰ به ۱۰۰ کاهش داده میشوند. |
page_token | اختیاری. یک توکن صفحه که از فراخوانی قبلی هنگام صفحهبندی، تمام پارامترهای دیگر ارائه شده به |
label_id | در صورت تنظیم، فقط حسابهای MC با شناسه برچسب داده شده بازگردانده میشوند. |
full_name | در صورت تنظیم، فقط حسابهای MC با نام داده شده (حساس به حروف بزرگ و کوچک) بازگردانده میشوند. |
پاسخ ListChildAccounts
پیام پاسخ برای متد ListChildAccounts .
| فیلدها | |
|---|---|
accounts[] | حسابهای CSS/MC که برای حساب والد CSS مشخصشده برگردانده شدهاند. |
next_page_token | یک توکن، که میتواند به عنوان |
درخواست محصولات ListCss
درخواست پیام برای متد ListCssProducts.
| فیلدها | |
|---|---|
parent | الزامی. حساب/دامنه برای فهرست کردن محصولات CSS پردازش شده برای آن. فرمت: accounts/{account} |
page_size | حداکثر تعداد محصولات CSS برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بالاتر از ۱۰۰۰ به ۱۰۰۰ محدود میشوند. اگر مشخص نشود، حداکثر تعداد محصولات CSS برگردانده خواهد شد. |
page_token | یک توکن صفحه، که از فراخوانی قبلی هنگام صفحهبندی، تمام پارامترهای دیگر ارائه شده به |
پاسخ ListCssProducts
پیام پاسخ برای متد ListCssProducts.
| فیلدها | |
|---|---|
css_products[] | محصولات CSS پردازششده از حساب مشخصشده. اینها محصولات CSS پردازششده شما پس از اعمال قوانین و فیدهای تکمیلی هستند. |
next_page_token | یک توکن، که میتواند به عنوان |
درخواست لیست سهمیههاگروهها
درخواست پیام برای متد ListQuotaGroups.
| فیلدها | |
|---|---|
parent | الزامی. حساب CSS که مالک مجموعهای از سهمیههای متد و منابع است. در بیشتر موارد، این دامنه CSS است. قالب: accounts/{account} |
page_size | اختیاری. حداکثر تعداد سهمیههایی که باید در پاسخ برگردانده شود، برای صفحهبندی استفاده میشود. پیشفرض ۵۰۰ است؛ مقادیر بالاتر از ۱۰۰۰ به ۱۰۰۰ محدود میشوند. |
page_token | اختیاری. توکن (در صورت ارائه) برای بازیابی صفحه بعدی. سایر پارامترها باید با فراخوانی اصلی که توکن صفحه را ارائه داده است، مطابقت داشته باشند. |
ListQuotaGroupsپاسخ
پیام پاسخ برای متد ListMethodGroups.
| فیلدها | |
|---|---|
quota_groups[] | روشها، میزان استفاده فعلی از سهمیه و محدودیتهای هر گروه. سهمیه بین تمام روشهای گروه به اشتراک گذاشته میشود. گروهها بر اساس |
next_page_token | یک توکن، که میتواند به عنوان |
جزئیات روش
جزئیات متد به ازای هر متد در CSS API.
| فیلدها | |
|---|---|
method | فقط خروجی. نام متد، برای مثال |
version | فقط خروجی. نسخه API که متد به آن تعلق دارد. |
subapi | فقط خروجی. زیر-API که متد به آن تعلق دارد. در API CSS، این همیشه |
path | فقط خروجی. مسیر متد مانند |
جزئیات محصول
جزئیات محصول.
| فیلدها | |
|---|---|
section_name | سربرگ بخش برای گروهبندی مجموعهای از جزئیات محصول استفاده میشود. |
attribute_name | نام جزئیات محصول. |
attribute_value | ارزش جزئیات محصول. |
ابعاد محصول
ابعاد محصول.
| فیلدها | |
|---|---|
value | الزامی. مقدار بُعد که به صورت یک عدد نمایش داده میشود. این مقدار میتواند حداکثر دقت چهار رقم اعشار را داشته باشد. |
unit | الزامی. واحدهای ابعاد. مقادیر قابل قبول عبارتند از: * " |
وزن محصول
وزن محصول.
| فیلدها | |
|---|---|
value | الزامی. وزن به صورت عدد نمایش داده میشود. حداکثر دقت وزن میتواند چهار رقم اعشار باشد. |
unit | الزامی. واحد وزن. مقادیر قابل قبول عبارتند از: * " |
گروه سهمیه
اطلاعات گروه برای متدها در CSS API. سهمیه بین همه متدهای گروه به اشتراک گذاشته میشود. حتی اگر هیچ یک از متدهای گروه استفادهای نداشته باشند، اطلاعات گروه بازگردانده میشود.
| فیلدها | |
|---|---|
name | شناسه. نام منبع گروه سهمیه. قالب: accounts/{account}/quotas/{group} مثال: |
quota_usage | فقط خروجی. میزان استفاده از سهمیه فعلی، به معنی تعداد فراخوانیهایی که در یک روز مشخص با متدهای موجود در گروه انجام شده است. محدودیتهای سهمیه روزانه در ساعت ۱۲:۰۰ ظهر به وقت جهانی بازنشانی میشوند. |
quota_limit | فقط خروجی. حداکثر تعداد تماسهای مجاز در روز برای گروه. |
quota_minute_limit | فقط خروجی. حداکثر تعداد تماسهای مجاز در هر دقیقه برای گروه. |
method_details[] | فقط خروجی. فهرست تمام روشهایی که سهمیه گروه به آنها اعمال میشود. |
دوره اشتراک
دوره اشتراک محصول.
| انومها | |
|---|---|
SUBSCRIPTION_PERIOD_UNSPECIFIED | نشان میدهد که مدت اشتراک مشخص نیست. |
MONTH | نشان میدهد که دوره اشتراک یک ماه است. |
YEAR | نشان میدهد که دوره اشتراک به صورت سال است. |
درخواست برچسب حساب بهروزرسانی
درخواست پیام برای متد UpdateAccountLabel .
| فیلدها | |
|---|---|
account_label | الزامی. برچسب بهروزرسانیشده. همه فیلدها باید پر شوند. |
درخواست بهروزرسانی برچسبهای حساب
پیام درخواست برای متد UpdateLabels .
| فیلدها | |
|---|---|
name | الزامی. نام منبع برچسب. قالب: accounts/{account} |
label_ids[] | فهرست شناسههای برچسب برای بازنویسی شناسههای برچسب حساب موجود. اگر فهرست خالی باشد، تمام شناسههای برچسب اختصاص داده شده فعلی حذف خواهند شد. |
parent | اختیاری. فقط هنگام بهروزرسانی برچسبهای حساب MC مورد نیاز است. دامنه CSS که منبع والد حساب MC است. قالب: accounts/{account} |
درخواست ورودی UpdateCssProduct
درخواست پیام برای متد UpdateCssProductInput.
| فیلدها | |
|---|---|
css_product_input | الزامی. منبع ورودی محصول CSS برای بهروزرسانی. اطلاعاتی که ارسال میکنید برای محصول CSS پردازششده نیز اعمال خواهد شد. |
update_mask | فهرست ویژگیهای CSS محصول که باید بهروزرسانی شوند. اگر ماسک بهروزرسانی حذف شود، به عنوان ماسک فیلد ضمنی معادل تمام فیلدهایی که پر شدهاند (مقداری غیر خالی دارند) در نظر گرفته میشود. ویژگیهایی که در ماسک بهروزرسانی مشخص شدهاند و مقداری در بدنه ندارند، از محصول CSS حذف خواهند شد. ماسک بهروزرسانی فقط میتواند برای فیلدهای سطح بالا در ویژگیها و ویژگیهای سفارشی مشخص شود. برای مشخص کردن ماسک بهروزرسانی برای ویژگیهای سفارشی، باید پیشوند ارائه مقدار ویژه "*" برای جایگزینی کامل محصول CSS پشتیبانی نمیشود. |