Package google.shopping.merchant.conversions.v1beta

الفهرس

ConversionSourcesService

خدمة لإدارة مصادر الإحالات الناجحة لحساب تاجر

CreateConversionSource

rpc CreateConversionSource(CreateConversionSourceRequest) returns (ConversionSource)

لإنشاء مصدر إحالة ناجحة جديد

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
DeleteConversionSource

rpc DeleteConversionSource(DeleteConversionSourceRequest) returns (Empty)

أرشفة مصدر إحالة ناجحة حالي إذا كان مصدر الإحالة الناجحة هو وجهة في Merchant Center، يمكن استردادها لمدة 30 يومًا. إذا كان مصدر الإحالة الناجحة هو رابط على "إحصاءات Google"، سيتم حذفه على الفور ويمكن استعادته من خلال إنشاء رابط جديد.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
GetConversionSource

rpc GetConversionSource(GetConversionSourceRequest) returns (ConversionSource)

تُستخدَم هذه الدالة لجلب مصدر إحالة ناجحة.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
ListConversionSources

rpc ListConversionSources(ListConversionSourcesRequest) returns (ListConversionSourcesResponse)

يسترجع قائمة مصادر الإحالات الناجحة التي يمكن للمتصل الوصول إليها.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
UndeleteConversionSource

rpc UndeleteConversionSource(UndeleteConversionSourceRequest) returns (ConversionSource)

إعادة تفعيل مصدر إحالة ناجحة تم أرشفته لا تتوفّر إلا لمصادر الإحالات الناجحة التي تستهدِف Merchant Center.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.
UpdateConversionSource

rpc UpdateConversionSource(UpdateConversionSourceRequest) returns (ConversionSource)

تعديل معلومات مصدر إحالة ناجحة حالي لا تتوفّر إلا لمصادر الإحالات الناجحة التي تستهدِف وجهة في Merchant Center.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.

AttributionSettings

تمثّل إعدادات تحديد المصدر لمصادر الإحالات الناجحة التي تتلقّى بيانات تحديد المصدر المُسبَق.

الحقول
attribution_lookback_window_days

int32

مطلوب. فترات معاينة الإعلان (بالأيام) المستخدَمة لتحديد المصدر في هذا المصدر. القيم المسموح بها هي 7 و30 و40.
attribution_model

AttributionModel
conversion_type[]

ConversionType

غير قابل للتغيير قائمة بدون ترتيب قائمة بأنواع الإحالات الناجحة المختلفة التي يمكن تصنيف حدث إحالة ناجحة على أنّه منها سيتم تلقائيًا إنشاء نوع "شراء" عادي إذا كانت هذه القائمة فارغة في وقت الإنشاء.

AttributionModel

نموذج تحديد المصدر المستخدَم لهذا المصدر. نتيح المجموعة نفسها من النماذج التي تقدّمها "إحصاءات Google‏ 4"، كما هو موضّح في المقالة: https://support.google.com/analytics/answer/10596866.

عمليات التعداد
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 نموذج "تناقص الوقت" على جميع القنوات

ConversionType

رسالة تمثّل أنواعًا من أحداث الإحالات الناجحة

الحقول
name

string

النتائج فقط. اسم حدث الإحالة الناجحة، كما سيُبلِغ عنه العميل.
report

bool

النتائج فقط. خيار يشير إلى ما إذا كان يجب تضمين النوع في تقارير Merchant Center

ConversionSource

تمثّل مصدر إحالة ناجحة مملوكًا لحساب تاجر. يمكن أن يتضمّن حساب التاجر ما يصل إلى 200 مصدر إحالة ناجحة.

الحقول
name

string

النتائج فقط. المعرّف يتم إنشاؤها بواسطة Content API عند إنشاء ConversionSource جديد. التنسيق: [a-z]{4}:.+ تمثل الأحرف الأربعة قبل النقطتَين الرأسيتَين نوع مصدر الإحالة الناجحة. يمثّل المحتوى الذي يأتي بعد النقطتَين رقم تعريف مصدر الإحالة الناجحة ضمن هذا النوع. قد يكون رقم تعريف مصدرَي إحالة ناجحة مختلفَين متطابقًا في أنواع مختلفة. يمكن استخدام البادئات التالية للأنواع: - galk: لمصادر GoogleAnalyticsLink. ‫- mcdn: لمصادر MerchantCenterDestination
state

State

النتائج فقط. الحالة الحالية لمصدر الإحالة الناجحة هذا. لا يمكن تعديلها من خلال واجهة برمجة التطبيقات.
expire_time

Timestamp

النتائج فقط. الوقت الذي يصبح فيه مصدر إحالة ناجحة مؤرشفًا ويتم حذفه نهائيًا ولا يمكن إلغاء حذفه بعد ذلك
controller

Controller

النتائج فقط. التحكّم في مصدر الإحالة الناجحة
حقل الربط source_data مطلوب. بيانات مصدر الإحالة الناجحة الخاصة بكل نوع مختلف من المصادر يمكن أن يكون source_data واحدًا فقط مما يلي:
merchant_center_destination

MerchantCenterDestination

مصدر الإحالة الناجحة من النوع "وجهة علامة Merchant Center"

وحدة التحكّم

العنصر الذي يتحكّم في مصدر الإحالة الناجحة

عمليات التعداد
CONTROLLER_UNSPECIFIED القيمة التلقائية هذه القيمة غير مستخدَمة.
MERCHANT يتحكم فيه التاجر الذي يملك مصدر الإحالة الناجحة.
YOUTUBE_AFFILIATES تخضع هذه الطلبات لـ "برنامج الشركاء التابعين في YouTube".

الحالة

تمثّل حالة مصدر الإحالة الناجحة.

عمليات التعداد
STATE_UNSPECIFIED حالة مصدر الإحالة الناجحة غير محدّدة.
ACTIVE مصدر الإحالة الناجحة يعمل بكامل طاقته.
ARCHIVED تمّ أرشفة مصدر الإحالة الناجحة في آخر 30 يومًا، وهو غير نشط حاليًا. يمكن استعادتها باستخدام طريقة إلغاء الحذف.
PENDING بدأت عملية إنشاء مصدر الإحالة الناجحة ولكنّها لم تكتمل بعد.

CreateConversionSourceRequest

رسالة طلب لطريقة CreateConversionSource

الحقول
parent

string

مطلوب. حساب التاجر الذي سيمتلك مصدر الإحالة الناجحة الجديد. التنسيق: accounts/{account}
conversion_source

ConversionSource

مطلوب. وصف مصدر الإحالة الناجحة. وسيتمّ تلقائيًا منح هذا النموذج معرّفًا جديدًا عند إنشائه.

DeleteConversionSourceRequest

رسالة طلب لطريقة DeleteConversionSource

الحقول
name

string

مطلوب. اسم مصدر الإحالة الناجحة المطلوب حذفه التنسيق: accounts/{account}/conversionSources/{conversion_source}

GetConversionSourceRequest

رسالة طلب لطريقة GetConversionSource

الحقول
name

string

مطلوب. اسم مصدر الإحالة الناجحة المطلوب استرجاعه. التنسيق: accounts/{account}/conversionSources/{conversion_source}

ListConversionSourcesRequest

رسالة طلب لطريقة ListConversionSources

الحقول
parent

string

مطلوب. حساب التاجر الذي يملك مجموعة مصادر الإحالات الناجحة. التنسيق: accounts/{account}
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

يمكن استخدام مصادر "وجهة Merchant Center" لإرسال أحداث الإحالات الناجحة من متجر على الإنترنت باستخدام علامة Google مباشرةً إلى حساب على Merchant Center تم إنشاء المصدر فيه.

الحقول
destination

string

النتائج فقط. رقم تعريف الوجهة في Merchant Center
attribution_settings

AttributionSettings

مطلوب. إعدادات تحديد المصدر المستخدَمة لوجهة Merchant Center
display_name

string

مطلوب. الاسم المعروض الذي يحدّده التاجر للوجهة هذا هو الاسم الذي يحدّد مصدر الإحالة الناجحة ضمن واجهة مستخدم Merchant Center. يجب أن يتألف من 64 حرفًا كحدّ أقصى.
currency_code

string

مطلوب. رمز العملة المكوّن من ثلاثة أحرف (ISO 4217) يحدّد رمز العملة العملة التي سيتم تسجيل الإحالات الناجحة المرسَلة إلى هذه الوجهة بها في Merchant Center.

UndeleteConversionSourceRequest

رسالة طلب لطريقة UndeleteConversionSource

الحقول
name

string

مطلوب. اسم مصدر الإحالة الناجحة المطلوب إلغاء حذفه التنسيق: accounts/{account}/conversionSources/{conversion_source}

UpdateConversionSourceRequest

رسالة طلب لطريقة UpdateConversionSource

الحقول
conversion_source

ConversionSource

مطلوب. الإصدار الجديد من بيانات مصدر الإحالة الناجحة. التنسيق: accounts/{account}/conversionSources/{conversion_source}
update_mask

FieldMask

اختيارية: قائمة الحقول التي يتم تعديلها