Package google.shopping.merchant.conversions.v1beta

فهرست مطالب

ConversionSourcesService

سرویس مدیریت منابع تبدیل برای یک حساب تجاری.

CreateConversionSource

rpc CreateConversionSource( CreateConversionSourceRequest ) returns ( ConversionSource )

یک منبع تبدیل جدید ایجاد می کند.

محدوده مجوز

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

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

DeleteConversionSource

rpc DeleteConversionSource( DeleteConversionSourceRequest ) returns ( Empty )

یک منبع تبدیل موجود را بایگانی می کند. اگر منبع تبدیل یک مقصد Merchant Center باشد، به مدت 30 روز قابل بازیابی خواهد بود. اگر منبع تبدیل یک لینک Google Analytics باشد، بلافاصله حذف می شود و با ایجاد یک لینک جدید قابل بازیابی است.

محدوده مجوز

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

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

GetConversionSource

rpc GetConversionSource( GetConversionSourceRequest ) returns ( ConversionSource )

یک منبع تبدیل را واکشی می کند.

محدوده مجوز

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

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ListConversionSources

rpc ListConversionSources( ListConversionSourcesRequest ) returns ( ListConversionSourcesResponse )

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

محدوده مجوز

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

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

UndeleteConversionSource

rpc UndeleteConversionSource( UndeleteConversionSourceRequest ) returns ( ConversionSource )

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

محدوده مجوز

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

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

UpdateConversionSource

rpc UpdateConversionSource( UpdateConversionSourceRequest ) returns ( ConversionSource )

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

محدوده مجوز

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

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

AttributionSettings

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

زمینه های
attribution_lookback_window_days

int32

ضروری. پنجره های نگاه (در روز) برای ذکر منبع در این منبع استفاده می شود. مقادیر پشتیبانی شده 7، 30، 40 هستند.

attribution_model

AttributionModel

ضروری. مدل اسناد.

conversion_type[]

ConversionType

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

AttributionModel

مدل انتساب استفاده شده برای این منبع. ما از همان مجموعه مدل‌های ارائه شده توسط Google Analytics 4 پشتیبانی می‌کنیم، همانطور که در: https://support.google.com/analytics/answer/10596866 توضیح داده شده است.

Enums
ATTRIBUTION_MODEL_UNSPECIFIED مدل نامشخص
CROSS_CHANNEL_LAST_CLICK مدل آخرین کلیک متقابل.
ADS_PREFERRED_LAST_CLICK مدل آخرین کلیک برگزیده تبلیغات.
CROSS_CHANNEL_DATA_DRIVEN مدل متقابل داده محور.
CROSS_CHANNEL_FIRST_CLICK مدل اولین کلیک متقابل.
CROSS_CHANNEL_LINEAR مدل خطی متقابل.
CROSS_CHANNEL_POSITION_BASED مدل مبتنی بر موقعیت متقابل.
CROSS_CHANNEL_TIME_DECAY مدل کراس کانال Time Decay.

نوع تبدیل

پیامی که نشان دهنده انواع رویدادهای تبدیل است

زمینه های
name

string

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

report

bool

فقط خروجی گزینه ای که نشان می دهد آیا نوع باید در گزارش Merchant Center لحاظ شود یا خیر.

ConversionSource

نشان دهنده یک منبع تبدیل متعلق به یک حساب Merchant است. یک حساب تجاری می تواند تا 200 منبع تبدیل داشته باشد.

زمینه های
name

string

فقط خروجی مشخص کننده. با ایجاد یک ConversionSource جدید توسط Content API ایجاد شده است. قالب: [az]{4}:.+ چهار کاراکتر قبل از دو نقطه نشان دهنده نوع منبع تبدیل است. محتوای بعد از دو نقطه نشان دهنده شناسه منبع تبدیل در آن نوع است. شناسه دو منبع تبدیل مختلف ممکن است در انواع مختلف یکسان باشد. پیشوندهای نوع زیر پشتیبانی می شوند: - galk: برای منابع GoogleAnalyticsLink. - mcdn: برای منابع MerchantCenterDestination.

state

State

فقط خروجی وضعیت فعلی این منبع تبدیل. از طریق API قابل ویرایش نیست.

expire_time

Timestamp

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

controller

Controller

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

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

MerchantCenterDestination

منبع تبدیل از نوع "مقصد برچسب مرکز تجاری".

کنترل کننده

نهادی که منبع تبدیل را کنترل می کند.

Enums
CONTROLLER_UNSPECIFIED مقدار پیش فرض. این مقدار استفاده نشده است.
MERCHANT توسط بازرگانی که منبع تبدیل را در اختیار دارد کنترل می شود.
YOUTUBE_AFFILIATES توسط برنامه YT Affiliates کنترل می شود.

حالت

وضعیت منبع تبدیل را نشان می دهد.

Enums
STATE_UNSPECIFIED منبع تبدیل وضعیت نامشخصی دارد.
ACTIVE منبع تبدیل کاملاً کاربردی است.
ARCHIVED منبع تبدیل در 30 روز گذشته بایگانی شده است و در حال حاضر کاربردی نیست. با استفاده از روش undelete قابل بازیابی است.
PENDING ایجاد منبع تبدیل شروع شده است اما هنوز به طور کامل تمام نشده است.

CreateConversionSourceRequest

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

زمینه های
parent

string

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

conversion_source

ConversionSource

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

DeleteConversionSourceRequest

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

زمینه های
name

string

ضروری. نام منبع تبدیل که باید حذف شود. قالب: حساب‌ها/{account}/conversionSources/{conversion_source}

GetConversionSourceRequest

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

زمینه های
name

string

ضروری. نام منبع تبدیلی که باید واکشی شود. قالب: حساب‌ها/{account}/conversionsources/{conversion_source}

ListConversionSourcesRequest

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

زمینه های
parent

string

ضروری. حساب تجاری که مجموعه منابع تبدیل را در اختیار دارد. قالب: حساب‌ها/{حساب}

page_size

int32

اختیاری. حداکثر تعداد منابع تبدیل برای بازگشت در یک صفحه. اگر page_size مشخص نشده باشد، 100 به عنوان مقدار پیش فرض استفاده می شود. حداکثر مقدار 200 است. مقادیر بالای 200 به 200 اجباری می شود. صرف نظر از صفحه بندی، در مجموع حداکثر 200 منبع تبدیل برگردانده می شود.

page_token

string

اختیاری. توکن صفحه.

show_deleted

bool

اختیاری. نمایش گزینه حذف شده (بایگانی شده).

ListConversionSourcesResponse

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

زمینه های
conversion_sources[]

ConversionSource

فهرست منابع تبدیل

next_page_token

string

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

MerchantCenterDestination

از منابع "مقصد مرکز تجاری" می توان برای ارسال رویدادهای تبدیل از فروشگاه آنلاین با استفاده از یک برچسب Google به طور مستقیم به حساب Merchant Center جایی که منبع ایجاد شده است استفاده کرد.

زمینه های
destination

string

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

attribution_settings

AttributionSettings

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

display_name

string

ضروری. نام نمایشی مشخص شده توسط تاجر برای مقصد. این نامی است که منبع تبدیل را در رابط کاربری Merchant Center مشخص می کند. محدود به 64 کاراکتر.

currency_code

string

ضروری. کد ارز سه حرفی (ISO 4217). کد ارز مشخص می‌کند که تبدیل‌های ارسال شده به این مقصد با کدام ارز در Merchant Center گزارش می‌شوند.

UndeleteConversionSourceRequest

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

زمینه های
name

string

ضروری. نام منبع تبدیلی که باید حذف شود. قالب: حساب‌ها/{account}/conversionSources/{conversion_source}

UpdateConversionSourceRequest

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

زمینه های
conversion_source

ConversionSource

ضروری. نسخه جدید داده های منبع تبدیل. قالب: حساب‌ها/{account}/conversionSources/{conversion_source}

update_mask

FieldMask

ضروری. لیست فیلدهای در حال به روز رسانی