Package google.shopping.merchant.promotions.v1beta

شاخص

خدمات تبلیغاتی

خدمات مدیریت تبلیغات برای محصولات.

GetPromotion

rpc GetPromotion( GetPromotionRequest ) returns ( Promotion )

تبلیغ را از حساب Merchant Center شما بازیابی می کند.

پس از درج یا به‌روزرسانی ورودی تبلیغات، ممکن است چند دقیقه طول بکشد تا تبلیغات به‌روز شده بازیابی شود.

محدوده مجوز

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

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

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

InsertPromotion

rpc InsertPromotion( InsertPromotionRequest ) returns ( Promotion )

یک تبلیغ برای حساب Merchant Center شما درج می کند. اگر تبلیغات از قبل وجود داشته باشد، در عوض تبلیغ را به روز می کند.

محدوده مجوز

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

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

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

لیست تبلیغات

rpc ListPromotions( ListPromotionsRequest ) returns ( ListPromotionsResponse )

تبلیغات را در حساب Merchant Center شما فهرست می کند. پاسخ ممکن است حاوی موارد کمتری نسبت به pageSize باشد. برای تعیین اینکه آیا موارد بیشتری برای درخواست وجود دارد یا خیر، به pageToken تکیه کنید.

پس از درج یا به‌روزرسانی یک تبلیغ، ممکن است چند دقیقه طول بکشد تا تبلیغات پردازش شده به‌روز شده بازیابی شود.

محدوده مجوز

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

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

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

صفات

صفات.

فیلدها
product_ applicability

ProductApplicability

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

offer_ type

OfferType

مورد نیاز. نوع تبلیغ از این ویژگی برای نشان دادن اینکه آیا مشتریان برای بازخرید تبلیغات شما به کد کوپن نیاز دارند یا خیر، استفاده کنید.

generic_ redemption_ code

string

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

long_ title

string

مورد نیاز. عنوان طولانی برای ارتقاء

coupon_ value_ type

CouponValueType

مورد نیاز. ویژگی نوع ارزش کوپن برای نشان دادن نوع تبلیغی که در حال اجرا هستید. بسته به نوع ارزش کوپن انتخاب شده ، برخی از ویژگی ها مورد نیاز است .

promotion_ destinations[]

DestinationEnum

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

ممکن است قبلاً مقادیر زیر را به عنوان مقصد محصولات خود ارسال کرده باشید: اقدامات خرید، سطوح در سراسر Google، سطوح محلی در سراسر Google. برای نمایش این مقادیر از FREE_LISTINGS ، FREE_LOCAL_LISTINGS ، LOCAL_INVENTORY_ADS استفاده کنید. برای جزئیات بیشتر به مقصد تبلیغاتی مراجعه کنید

item_ id_ inclusion[]

string

اختیاری. فیلتر محصول بر اساس شناسه مورد برای تبلیغات. ویژگی‌های فیلتر محصول فقط زمانی اعمال می‌شود که محصولات واجد شرایط برای ارتقاء، قابلیت کاربردی بودن محصول، ویژگی product_applicability روی specific_products تنظیم شده باشد.

brand_ inclusion[]

string

اختیاری. فیلتر محصول بر اساس برند برای تبلیغات. ویژگی‌های فیلتر محصول فقط زمانی اعمال می‌شود که محصولات واجد شرایط برای ارتقاء، قابلیت کاربردی بودن محصول، ویژگی product_applicability روی specific_products تنظیم شده باشد.

item_ group_ id_ inclusion[]

string

اختیاری. فیلتر محصول بر اساس شناسه گروه مورد برای تبلیغات. ویژگی‌های فیلتر محصول فقط زمانی اعمال می‌شود که محصولات واجد شرایط برای کاربردی بودن محصول تبلیغاتی [محصول_کاربردی] روی specific_products تنظیم شده باشد.

product_ type_ inclusion[]

string

اختیاری. فیلتر محصول بر اساس نوع محصول برای تبلیغات. ویژگی‌های فیلتر محصول فقط زمانی اعمال می‌شود که محصولات واجد شرایط برای ارتقاء، قابلیت کاربردی بودن محصول، ویژگی product_applicability روی specific_products تنظیم شده باشد.

item_ id_ exclusion[]

string

اختیاری. فیلتر محصول بر اساس حذف شناسه مورد برای تبلیغات. ویژگی‌های فیلتر محصول فقط زمانی اعمال می‌شود که محصولات واجد شرایط برای ارتقاء، قابلیت کاربردی بودن محصول، ویژگی product_applicability روی specific_products تنظیم شده باشد.

brand_ exclusion[]

string

اختیاری. فیلتر محصول بر اساس حذف نام تجاری برای تبلیغات. ویژگی‌های فیلتر محصول فقط زمانی اعمال می‌شود که محصولات واجد شرایط برای ارتقاء، قابلیت کاربردی بودن محصول، ویژگی product_applicability روی specific_products تنظیم شده باشد.

item_ group_ id_ exclusion[]

string

اختیاری. فیلتر محصول بر اساس شناسه گروه مورد . ویژگی‌های فیلتر محصول فقط زمانی اعمال می‌شود که محصولات واجد شرایط برای ارتقاء، قابلیت کاربردی بودن محصول، ویژگی product_applicability روی specific_products تنظیم شده باشد. محرومیت برای ارتقاء

product_ type_ exclusion[]

string

اختیاری. فیلتر محصول بر اساس نوع محصول استثنا برای تبلیغات. ویژگی‌های فیلتر محصول فقط زمانی اعمال می‌شود که محصولات واجد شرایط برای ارتقاء، قابلیت کاربردی بودن محصول، ویژگی product_applicability روی specific_products تنظیم شده باشد.

minimum_ purchase_ amount

Price

اختیاری. حداقل مبلغ خرید برای تبلیغات.

minimum_ purchase_ quantity

int64

اختیاری. حداقل مقدار خرید برای تبلیغات.

limit_ quantity

int64

اختیاری. حداکثر مقدار خرید برای تبلیغات.

limit_ value

Price

اختیاری. حداکثر قیمت محصول برای تبلیغ.

percent_ off

int64

اختیاری. درصد تخفیف ارائه شده در تبلیغات.

money_ off_ amount

Price

اختیاری. مقدار پولی که در تبلیغات ارائه شده است.

get_ this_ quantity_ discounted

int64

اختیاری. تعداد کالاهایی که در تبلیغات تخفیف داده شده است. این ویژگی زمانی تنظیم می‌شود که couponValueType برابر با buy_m_get_n_money_off یا buy_m_get_n_percent_off باشد.

free_ gift_ value

Price

اختیاری. ارزش هدیه رایگان برای تبلیغات.

free_ gift_ description

string

اختیاری. توضیحات هدیه رایگان برای تبلیغات.

free_ gift_ item_ id

string

اختیاری. شناسه کالای هدیه رایگان برای تبلیغات.

promotion_ effective_ time_ period

Interval

مورد نیاز. نمایش TimePeriod از تاریخ های موثر تبلیغات. این ویژگی مشخص می‌کند که تبلیغات را می‌توان در فروشگاه آنلاین شما در این بازه زمانی آزمایش کرد.

promotion_ display_ time_ period

Interval

اختیاری. نمایش TimePeriod تاریخ های نمایش تبلیغات. این مشخصه تاریخ و بازه زمانی را مشخص می‌کند که تبلیغات در Google.com و تبلیغات خرید فعال می‌شود. اگر بازه زمانی نمایش برای ویژگی promotion_display_time_period مشخص نشده باشد، بازه زمانی مؤثر تبلیغاتی promotion_effective_time_period تاریخ و چارچوب زمانی را که تبلیغات در Google.com و تبلیغات خرید به صورت زنده اجرا می‌شود، تعیین می‌کند.

store_ applicability

StoreApplicability

اختیاری. آیا این تبلیغات برای همه فروشگاه‌ها اعمال می‌شود یا فقط فروشگاه‌های مشخص شده . تبلیغات موجودی محلی در صورت عدم استفاده از فروشگاه با خطا مواجه می شوند. اگر store_applicability روی ALL_STORES تنظیم شود و store_codes_inclusion یا score_code_exclusion روی یک مقدار تنظیم شود، خطای INVALID_ARGUMENT ایجاد می‌شود.

store_ codes_ inclusion[]

string

اختیاری. کدهای فروشگاهی که باید برای تبلیغات درج شوند . ویژگی‌های فیلتر فروشگاه فقط زمانی اعمال می‌شود که ویژگی store_applicability روی specific_stores تنظیم شده باشد.

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

store_ codes_ exclusion[]

string

اختیاری. کدهای فروشگاه برای حذف برای تبلیغات. ویژگی‌های فیلتر فروشگاه فقط زمانی اعمال می‌شود که ویژگی store_applicability روی specific_stores تنظیم شده باشد.

promotion_ url

string

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

CouponValueType

نوع ارزش کوپن یک تبلیغ.

Enums
COUPON_VALUE_TYPE_UNSPECIFIED نشان می دهد که نوع ارزش کوپن مشخص نشده است.
MONEY_OFF نوع ارزش کوپن پول تخفیف.
PERCENT_OFF نوع ارزش کوپن درصد تخفیف.
BUY_M_GET_N_MONEY_OFF مقدار M بخرید، از نوع ارزش کوپن N پول دریافت کنید. minimum_purchase_quantity و get_this_quantity_discounted باید وجود داشته باشد. money_off_amount نیز باید وجود داشته باشد.
BUY_M_GET_N_PERCENT_OFF مقدار M را خریداری کنید، از نوع ارزش کوپن N درصد تخفیف دریافت کنید. minimum_purchase_quantity و get_this_quantity_discounted باید وجود داشته باشد. percent_off_percentage نیز باید وجود داشته باشد.
BUY_M_GET_MONEY_OFF مقدار M بخرید، پول بگیرید. minimum_purchase_quantity و money_off_amount باید وجود داشته باشد.
BUY_M_GET_PERCENT_OFF مقدار M بخرید، پول بگیرید. minimum_purchase_quantity و percent_off_percentage باید وجود داشته باشد.
FREE_GIFT هدیه رایگان فقط با توضیحات.
FREE_GIFT_WITH_VALUE هدیه رایگان با ارزش پولی.
FREE_GIFT_WITH_ITEM_ID هدیه رایگان با شناسه کالا.
FREE_SHIPPING_STANDARD نوع ارزش کوپن حمل و نقل رایگان استاندارد. فقط برای تبلیغات آنلاین موجود است.
FREE_SHIPPING_OVERNIGHT نوع ارزش کوپن ارسال رایگان شبانه. فقط برای تبلیغات آنلاین موجود است.
FREE_SHIPPING_TWO_DAY نوع ارزش کوپن ارسال رایگان دو روزه. فقط برای تبلیغات آنلاین موجود است.

GetPromotionRequest

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

فیلدها
name

string

مورد نیاز. نام تبلیغی که باید بازیابی شود. قالب: accounts/{account}/promotions/{promotions}

InsertPromotionRequest

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

فیلدها
parent

string

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

promotion

Promotion

مورد نیاز. تبلیغ برای درج.

data_ source

string

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

ListPromotionsRequest

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

فیلدها
parent

string

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

page_ size

int32

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

page_ token

string

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

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

ListPromotionsResponse

پیام پاسخ برای روش ListPromotions .

فیلدها
promotions[]

Promotion

تبلیغات پردازش شده از حساب مشخص شده.

next_ page_ token

string

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

OfferType

نوع پیشنهاد یک ترفیع

Enums
OFFER_TYPE_UNSPECIFIED نوع پیشنهاد نامشخص.
NO_CODE نوع پیشنهاد بدون کد
GENERIC_CODE نوع پیشنهاد با یک کد زمانی که offerType = GENERIC_CODE کد بازخرید عمومی برای تبلیغ مورد نیاز است.

کاربرد محصول

تبلیغ برای کدام محصول یا لیست محصولات اعمال می شود.

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

ارتقاء

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

ویژگی‌های ورودی تبلیغاتی مورد نیاز برای گذراندن بررسی‌های اعتبارسنجی داده‌ها عمدتاً در زیر تعریف می‌شوند:

پس از درج، به‌روزرسانی ورودی تبلیغات، ممکن است چند دقیقه طول بکشد تا تبلیغات نهایی بازیابی شود.

فیلدها
name

string

شناسه. نام تبلیغ. قالب: accounts/{account}/promotions/{promotion}

promotion_ id

string

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

content_ language

string

مورد نیاز. کد زبان دو حرفی ISO 639-1 برای تبلیغ.

تبلیغات فقط برای زبان های انتخاب شده است.

target_ country

string

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

تبلیغات فقط در کشورهای منتخب، فهرست‌های رایگان و آگهی‌های خرید، آگهی‌های موجودی محلی موجود است

redemption_ channel[]

RedemptionChannel

مورد نیاز. کانال بازخرید برای تبلیغات. حداقل یک کانال مورد نیاز است.

data_ source

string

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

attributes

Attributes

اختیاری. لیستی از ویژگی های ارتقاء

custom_ attributes[]

CustomAttribute

اختیاری. فهرستی از ویژگی های سفارشی (ارائه شده توسط بازرگان). همچنین می‌توان از آن برای ارسال هر ویژگی از مشخصات داده‌ها به شکل عمومی آن استفاده کرد (به عنوان مثال، { "name": "size type", "value": "regular" } ). این برای ارسال ویژگی هایی مفید است که به صراحت توسط API در معرض نمایش قرار نگرفته اند.

promotion_ status

PromotionStatus

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

version_ number

int64

اختیاری. نشان دهنده نسخه موجود (تازه بودن) تبلیغات است که می تواند برای حفظ نظم درست زمانی که به روز رسانی های متعدد به طور همزمان انجام می شود استفاده شود.

در صورت تنظیم، زمانی که شماره نسخه کمتر از شماره نسخه فعلی تبلیغ موجود باشد، از درج جلوگیری می شود. درج مجدد (به عنوان مثال، بازخوانی تبلیغات پس از 30 روز) را می توان با version_number فعلی انجام داد.

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

وضعیت ارتقاء

وضعیت ارتقاء.

فیلدها
destination_ statuses[]

DestinationStatus

فقط خروجی مقاصد در نظر گرفته شده برای تبلیغات

item_ level_ issues[]

ItemLevelIssue

فقط خروجی فهرستی از مسائل مرتبط با تبلیغات.

creation_ date

Timestamp

فقط خروجی تاریخی که تبلیغات در قالب ISO 8601 ایجاد شده است: تاریخ، زمان و افست، به عنوان مثال 2020-01-02T09:00:00+01:00 یا 2020-01-02T09:00:00Z

last_ update_ date

Timestamp

فقط خروجی تاریخی که آخرین بار وضعیت تبلیغ در قالب ISO 8601 به روز شده است: تاریخ، زمان و افست، به عنوان مثال 2020-01-02T09:00:00+01:00 یا 2020-01-02T09:00:00Z

وضعیت مقصد

وضعیت برای مقصد مشخص شده

فیلدها
reporting_ context

ReportingContextEnum

فقط خروجی نام مقصد تبلیغاتی

status

State

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

ایالت

وضعیت فعلی تبلیغ.

Enums
STATE_UNSPECIFIED وضعیت تبلیغ نامشخص
IN_REVIEW تبلیغات در دست بررسی است.
REJECTED تبلیغ تایید نشده است.
LIVE تبلیغات تایید شده و فعال است.
STOPPED تبلیغ توسط تاجر متوقف شده است.
EXPIRED تبلیغات دیگر فعال نیست.
PENDING تبلیغات متوقف نمی شود و همه بررسی ها تایید می شوند، اما تاریخ فعال در آینده است.

ItemLevelIssue

موضوع مرتبط با ارتقاء

فیلدها
code

string

فقط خروجی کد خطای مشکل

severity

Severity

فقط خروجی چگونه این موضوع بر ارائه تبلیغات تأثیر می گذارد.

resolution

string

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

attribute

string

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

reporting_ context

ReportingContextEnum

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

description

string

فقط خروجی شرح مختصر موضوع به زبان انگلیسی.

detail

string

فقط خروجی شرح مفصل موضوع به زبان انگلیسی.

documentation

string

فقط خروجی URL یک صفحه وب برای کمک به حل این مشکل.

applicable_ countries[]

string

فقط خروجی فهرست کدهای کشور (ISO 3166-1 alpha-2) که در آن مشکل برای پیشنهاد اعمال می شود.

شدت

شدت موضوع.

Enums
SEVERITY_UNSPECIFIED مشخص نشده است.
NOT_IMPACTED این موضوع یک هشدار است و تأثیر مستقیمی بر تبلیغات ندارد.
DEMOTED ترفیع کاهش یافته و به احتمال زیاد عملکرد محدودی در نتایج جستجو دارد
DISAPPROVED موضوع تبلیغ را تأیید نمی کند.

RedemptionChannel

کانال یک تبلیغ

Enums
REDEMPTION_CHANNEL_UNSPECIFIED نشان می دهد که کانال نامشخص است.
IN_STORE نشان می دهد که کانال در فروشگاه است. این همان کانال local است که برای products استفاده می شود.
ONLINE نشان دهنده آنلاین بودن کانال است.

StoreApplicability

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

Enums
STORE_APPLICABILITY_UNSPECIFIED کدهای فروشگاهی که تبلیغات برای آنها اعمال می شود ناشناخته است.
ALL_STORES تبلیغات برای همه فروشگاه ها اعمال می شود.
SPECIFIC_STORES تبلیغات فقط برای فروشگاه های مشخص شده اعمال می شود.