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.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

למידע נוסף, עיינו בסקירה הכללית על OAuth 2.0.

AttributionSettings

מייצג את הגדרות השיוך של מקורות של המרות שמקבלים נתונים לפני השיוך.

שדות
attribution_lookback_window_days

int32

חובה. חלונות מבט לאחור (בימים) ששימשו לשיוך במקור הזה. הערכים הנתמכים הם 7, 30, 40.

attribution_model

AttributionModel

חובה. מודל שיוך (Attribution).

conversion_type[]

ConversionType

בלתי משתנה. רשימה לא ממוינת. רשימת סוגי ההמרות השונים שאפשר לסווג בתור אירוע המרה. אם הרשימה הזו ריקה בזמן היצירה, ייווצר סוג 'רכישה' רגיל באופן אוטומטי.

AttributionModel

מודל השיוך (Attribution) ששימש למקור הזה. אנחנו תומכים באותה קבוצת מודלים שמוצעת ב-Google Analytics 4, כמתואר בכתובת: https://support.google.com/analytics/answer/10596866.

טיפוסים בני מנייה (enums)
ATTRIBUTION_MODEL_UNSPECIFIED מודל לא צוין.
CROSS_CHANNEL_LAST_CLICK מודל של קליק אחרון בכל הערוצים.
ADS_PREFERRED_LAST_CLICK מודל קליק אחרון עם העדפה ל-Google Ads.
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

פלט בלבד. המצב הנוכחי של מקור ההמרות. לא ניתן לערוך אותם באמצעות ה-API.

expire_time

Timestamp

פלט בלבד. המועד שבו מקור המרות שהועבר לארכיון נמחק לצמיתות ואי אפשר לבטל את המחיקה שלו.

controller

Controller

פלט בלבד. נאמן המידע של מקור ההמרות.

שדה איחוד source_data. חובה. נתונים של מקורות המרות הספציפיים לכל סוג של מקור. source_data יכול להיות רק אחד מהבאים:
merchant_center_destination

MerchantCenterDestination

מקור המרות מסוג 'יעד תג Merchant Center'.

שלט רחוק

הישות השולטת במקור ההמרות.

טיפוסים בני מנייה (enums)
CONTROLLER_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
MERCHANT בשליטת המוכר שמקור ההמרות נמצא בבעלותו.
YOUTUBE_AFFILIATES בשליטת תוכנית השותפים של YT.

ארץ

המצב של מקור ההמרות.

טיפוסים בני מנייה (enums)
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 Tag ישירות לחשבון Merchant Center שבו המקור נוצר.

שדות
destination

string

פלט בלבד. מספר יעד ב-Merchant Center.

attribution_settings

AttributionSettings

חובה. הגדרות השיוך (Attribution) שנעשה בהן שימוש ביעד 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

חובה. רשימת השדות בתהליך עדכון.