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"، سيتم حذفه على الفور ويمكن استعادته عن طريق إنشاء مصدر جديد.

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

يجب توفير نطاق 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.

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

يجب توفير نطاق 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 4" على النحو الموضّح في الرابط التالي: https://support.google.com/analytics/answer/10596866.

عمليات التعداد
ATTRIBUTION_MODEL_UNSPECIFIED نموذج غير محدَّد.
CROSS_CHANNEL_LAST_CLICK نموذج "النقرة الأخيرة على جميع القنوات".
ADS_PREFERRED_LAST_CLICK نموذج النقرة الأخيرة من "إعلانات Google"
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 Affiliates.

الحالة

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

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

CreateConversionSourceRequest

طلب رسالة لطريقة "Create ConversionSource" (إنشاء مصدر الإحالة الناجحة)

الحقول
parent

string

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

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

مطلوبة. قائمة الحقول التي يتم تعديلها