Method: customers.uploadClickConversions

מעבד את ההמרות הנתונות מקליקים.

רשימה של שגיאות התרעה: AuthenticationError AuthorizationError ConversionUploadError HeaderError InternalError PartialFailureError QuotaError RequestError

בקשת HTTP

POST https://googleads.googleapis.com/v15/customers/{customerId}:uploadClickConversions

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
customerId

string

חובה. מספר הלקוח שמבצע את ההעלאה.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "conversions": [
    {
      object (ClickConversion)
    }
  ],
  "partialFailure": boolean,
  "validateOnly": boolean,
  "debugEnabled": boolean,
  "jobId": integer
}
שדות
conversions[]

object (ClickConversion)

חובה. ההמרות שמעלים.
partialFailure

boolean

חובה. אם הערך הוא true, יבוצעו פעולות מוצלחות ופעולות לא חוקיות יחזירו שגיאות. אם הערך הוא False, כל הפעולות יבוצעו בעסקה אחת אך ורק אם כולן תקינות. תמיד צריך להגדיר את הערך True. מידע נוסף על כשל חלקי זמין בכתובת https://developers.google.com/google-ads/api/docs/best-practices/partial-failures.
validateOnly

boolean

אם הערך הוא true, הבקשה מאומתת אבל לא מבוצעת. רק שגיאות מוחזרות, לא תוצאות.
debugEnabled

boolean

אם הערך הוא True, ה-API יבצע את כל בדיקות ההעלאה ויחזיר שגיאות אם יימצאו. אם הערך הוא False, הוא יבצע רק אימות קלט בסיסי, ידלג על בדיקות ההעלאה הבאות ויחזיר תוצאות טובות גם אם לא נמצא קליק ב-userIdentifiers שצוין.

ההגדרה הזו משפיעה רק על ההמרות המשופרות לצורך העלאת לידים שנעשה בהם שימוש ב-userIdentifiers במקום ב-GCLID, ב-GBRAID או ב-WBRAID. כשמעלים המרות משופרות לצורך שיוך ללידים, צריך להעלות את כל אירועי ההמרות ל-API, כולל אירועי המרות שלא הגיעו מקמפיינים ב-Google Ads. העלאה של אירוע שאינו מקמפיין של Google Ads תגרום לשגיאה CLICK_NOT_FOUND אם השדה הזה מוגדר לערך true. השגיאות האלה צפויות לאירועים כאלה, ולכן צריך להגדיר את השדה הזה ל-false כדי לוודא שההעלאות בפורמט הנכון, אבל להתעלם מ-CLICK_NOT_FOUND שגיאות מכל ההמרות שאינן מקמפיין של Google Ads. כך תוכלו להתמקד רק בשגיאות שאתם יכולים לטפל בהן.

ברירת המחדל היא False.
jobId

integer

אפשרות. אפשר להזין כאן קלט אופציונלי להגדרת מזהה המשימה. חייב להיות מספר לא שלילי שקטן מ-2^31 אם צוין. אם לא מזינים את השדה הזה, ה-API ייצור מזהה משימה בטווח [ 2^31, (2^63)-1]. ה-API יחזיר את הערך של הבקשה הזו בשדה jobId מתוך UploadClickConversionsResponse.

גוף התגובה

הודעת תשובה לגבי ConversionUploadService.UploadClickConversions.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "partialFailureError": {
    object (Status)
  },
  "results": [
    {
      object (ClickConversionResult)
    }
  ],
  "jobId": string
}
שדות
partialFailureError

object (Status)

שגיאות שמתייחסות לכשלים בהמרות במצב של כשל חלקי. מוחזרת כאשר כל השגיאות מתרחשות בתוך ההמרות. אם אירעו שגיאות כלשהן מחוץ להמרות (לדוגמה, שגיאות אימות), נחזיר שגיאה ברמת ה-RPC. מידע נוסף על כשל חלקי זמין בכתובת https://developers.google.com/google-ads/api/docs/best-practices/partial-failures.
results[]

object (ClickConversionResult)

הוחזר עבור המרות שעובדו בהצלחה. קובץ Proto יהיה ריק בשורות שהתקבלה בהן שגיאה. התוצאות לא מוחזרות כאשר הערך של validateOnly הוא TRUE.
jobId

string (int64 format)

מזהה המשימה שמיועדת להעלאת הקובץ.

היקפי הרשאות

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

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

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

ClickConversion

המרה מהקליק.

ייצוג JSON 
{
  "gbraid": string,
  "wbraid": string,
  "externalAttributionData": {
    object (ExternalAttributionData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "cartData": {
    object (CartData)
  },
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "conversionEnvironment": enum (ConversionEnvironment),
  "consent": {
    object (Consent)
  },
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string,
  "conversionValue": number,
  "currencyCode": string,
  "orderId": string
}
שדות
gbraid

string

מזהה הקליק שמשויך לקליקים שמשויכים להמרות באפליקציה שמקורם במכשירי iOS החל מ-iOS14.
wbraid

string

מזהה הקליק של קליקים המשויכים להמרות באתר שמקורם במכשירי iOS החל מ-iOS14.
externalAttributionData

object (ExternalAttributionData)

נתונים נוספים על המרות שהשיוך שלהן נקבע במערכת חיצונית. חובה לציין את השדה הזה להמרות עם פעולת המרה שהשיוך שלה הוא חיצוני, אבל אין להגדיר אחרת.
customVariables[]

object (CustomVariable)

המשתנים המותאמים אישית שמשויכים להמרה הזו.
cartData

object (CartData)

נתוני עגלות הקניות המשויכים להמרה הזו.
userIdentifiers[]

object (UserIdentifier)

מזהי המשתמש שמשויכים להמרה הזו. אפשר להעלות המרות רק באמצעות hashedEmail ו-hashedPhoneNumber. המספר המקסימלי של מזהי משתמשים לכל המרה הוא 5.
conversionEnvironment

enum (ConversionEnvironment)

הסביבה שבה ההמרה הזו תועדה, למשל אפליקציה או אתר.
consent

object (Consent)

הגדרת ההסכמה לאירוע.
gclid

string

מספר הקליק ב-Google (gclid) המשויך להמרה הזו.
conversionAction

string

שם המשאב של פעולת ההמרה שמשויכת להמרה הזו. הערה: שם המשאב הזה כולל מספר לקוח ומזהה פעולת המרה, אבל המערכת תתעלם ממספר הלקוח ותשתמש במזהה פעולת ההמרה כמזהה היחיד של פעולת ההמרה.
conversionDateTime

string

התאריך והשעה שבהם התרחשה ההמרה. צריך להיות אחרי מועד הקליק. חובה לציין את אזור הזמן. הפורמט הוא 'yyyy-mm-dd hh:mm:ss+|-hh:mm'. לדוגמה, '2019-01-01 12:32:45-08:00'.
conversionValue

number

הערך של ההמרה למפרסם.
currencyCode

string

המטבע שמשויך לערך ההמרה. זהו קוד המטבע בן 3 התווים בפורמט ISO 4217. לדוגמה: USD, EUR.
orderId

string

מזהה ההזמנה המשויך להמרה. ניתן להשתמש במזהה הזמנה רק להמרה אחת לכל פעולת המרה.

ExternalAttributionData

מידע נוסף על המרות שהשיוך שלהן נקבע במערכת חיצונית.

ייצוג JSON 
{
  "externalAttributionCredit": number,
  "externalAttributionModel": string
}
שדות
externalAttributionCredit

number

מייצג את החלק של ההמרה שמיוחס לקליק ב-Google Ads.
externalAttributionModel

string

מציין את שם מודל השיוך (Attribution).

CartData

מכילה מידע נוסף על נתוני עגלות הקניות.

ייצוג JSON 
{
  "merchantId": string,
  "feedCountryCode": string,
  "feedLanguageCode": string,
  "localTransactionCost": number,
  "items": [
    {
      object (Item)
    }
  ]
}
שדות
merchantId

string (int64 format)

מספר חשבון Merchant Center שאליו הועלו הפריטים.
feedCountryCode

string

קוד המדינה שמשויך אל הפיד שאליו מועלים הפריטים.
feedLanguageCode

string

קוד השפה שמשויך אל הפיד שאליו מועלים הפריטים.
localTransactionCost

number

הסכום של כל ההנחות ברמת העסקה, כגון משלוח חינם והנחות בשוברים לגבי כל עגלת הקניות. קוד המטבע זהה לקוד המטבע שמופיע בהודעה של ClickConversion.
items[]

object (Item)

נתונים של הפריטים שנרכשו.

פריט

מכיל נתונים של הפריטים שנרכשו.

ייצוג JSON 
{
  "productId": string,
  "quantity": integer,
  "unitPrice": number
}
שדות
productId

string

מזהה הקנייה של הפריט. חייב להיות שווה למזהה המוצר ב-Merchant Center.
quantity

integer

מספר הפריטים שנמכרו.
unitPrice

number

המחיר ליחידה, לא כולל מס, משלוח והנחות ברמת העסקה. קוד המטבע זהה לקוד המטבע שמופיע בהודעה של ClickConversion.

ConversionEnvironment

סביבת ההמרה של ההמרה שהועלתה.

טיפוסים בני מנייה (enums)
UNSPECIFIED לא צוין.
UNKNOWN משמש רק לערך המוחזר. מייצג ערך לא ידוע בגרסה הזו.
APP ההמרה נרשמה באפליקציה.
WEB ההמרה תועדה באתר.

ClickConversionResult

זיהוי מידע עבור ClickConversion שעובדו בהצלחה.

ייצוג JSON 
{
  "gbraid": string,
  "wbraid": string,
  "userIdentifiers": [
    {
      object (UserIdentifier)
    }
  ],
  "gclid": string,
  "conversionAction": string,
  "conversionDateTime": string
}
שדות
gbraid

string

מזהה הקליק שמשויך לקליקים שמשויכים להמרות באפליקציה שמקורם במכשירי iOS החל מ-iOS14.
wbraid

string

מזהה הקליק של קליקים המשויכים להמרות באתר שמקורם במכשירי iOS החל מ-iOS14.
userIdentifiers[]

object (UserIdentifier)

מזהי המשתמש שמשויכים להמרה הזו. אפשר להעלות המרות רק באמצעות hashedEmail ו-hashedPhoneNumber. המספר המקסימלי של מזהי משתמשים לכל המרה הוא 5.
gclid

string

מספר הקליק ב-Google (gclid) המשויך להמרה הזו.
conversionAction

string

שם המשאב של פעולת ההמרה שמשויכת להמרה הזו.
conversionDateTime

string

התאריך והשעה שבהם התרחשה ההמרה. הפורמט הוא 'yyyy-mm-dd hh:mm:ss+|-hh:mm'. לדוגמה, '2019-01-01 12:32:45-08:00'.