- בקשת HTTP
- פרמטרים של נתיבים
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- ערך הבסיס
- מיקום
- MarketingDataInsight
- AudienceInsightsDimension
- MarketingDataInsightsAttribute
- AgeRange
- מגדר
- כדאי לנסות!
אחזור תובנות לגבי נתוני שיווק עבור רשימת משתמשים מסוימת.
התכונה הזו זמינה רק לשותפי נתונים.
כותרות הרשאות:
השיטה הזו תומכת בכותרות האופציונליות הבאות, שבעזרתן אפשר להגדיר איך ה-API מאשר גישה לבקשה:
-
login-account: (אופציונלי) שם המשאב של החשבון שבו חשבון Google של פרטי הכניסה הוא משתמש. אם לא מגדירים את הפרמטר, ברירת המחדל היא החשבון של הבקשה. פורמט:accountTypes/{loginAccountType}/accounts/{loginAccountId} -
linked-account: (אופציונלי) שם המשאב של החשבון עם קישור מוצר מבוסס אלlogin-account. פורמט:accountTypes/{linkedAccountType}/accounts/{linkedAccountId}
בקשת HTTP
POST https://datamanager.googleapis.com/v1/{parent=accountTypes/*/accounts/*}/insights:retrieve
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
פרמטרים של נתיב
| פרמטרים | |
|---|---|
parent |
חובה. חשבון ההורה שהרשימה משויכת אליו. פורמט: |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג JSON |
|---|
{
"baseline": {
object ( |
| שדות | |
|---|---|
baseline |
חובה. קהל הבסיס להשוואה לתובנות המבוקשות. |
userListId |
חובה. מזהה רשימת המשתמשים שעבורה מתבקשות תובנות. |
גוף התשובה
הודעת תגובה ל-DM API MarketingDataInsightsService.RetrieveInsights
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג JSON |
|---|
{
"marketingDataInsights": [
{
object ( |
| שדות | |
|---|---|
marketingDataInsights[] |
מכיל את התובנות לגבי נתוני השיווק. |
היקפי הרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/datamanager
בסיס להשוואה
קריטריונים בסיסיים להשוואה של התובנות.
| ייצוג JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"baselineLocation": {
object ( |
| שדות | |
|---|---|
| מיקום בסיסי שאליו משווים את התובנות. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה: | |
baselineLocation |
מיקום הבסיס של הבקשה. מיקום בסיסי הוא רשימת OR של האזורים המבוקשים. |
locationAutoDetectionEnabled |
אם הערך מוגדר כ-True, השירות ינסה לזהות באופן אוטומטי את מיקום הבסיס לתובנות. |
| סוף השדות הבלעדיים. | |
מיקום
מיקום הבסיס של הבקשה. מיקום בסיסי נמצא ברשימת OR של קודי אזור לפי תקן ISO 3166-1 alpha-2 של האזורים המבוקשים.
| ייצוג JSON |
|---|
{ "regionCodes": [ string ] } |
| שדות | |
|---|---|
regionCodes[] |
רשימה של קודי אזורים לפי תקן ISO 3166-1 alpha-2. |
MarketingDataInsight
תובנות לגבי נתוני שיווק.
התכונה הזו זמינה רק לשותפי נתונים.
| ייצוג JSON |
|---|
{ "dimension": enum ( |
| שדות | |
|---|---|
dimension |
המאפיין שאליו שייכת התובנה. |
attributes[] |
תובנות לגבי ערכים של מאפיין נתון. |
AudienceInsightsDimension
מאפיינים שאפשר להשתמש בהם ליצירת תובנות.
| טיפוסים בני מנייה (enum) | |
|---|---|
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED |
לא צוין. |
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN |
הערך לא ידוע בגרסה הזו. |
AFFINITY_USER_INTEREST |
תחום עניין משותף של משתמש. |
IN_MARKET_USER_INTEREST |
תחום עניין של משתמש עם כוונת רכישה. |
AGE_RANGE |
טווח גילאים. |
GENDER |
מגדר. |
MarketingDataInsightsAttribute
תובנות לגבי אוסף של מאפיינים קשורים של אותו מאפיין.
| ייצוג JSON |
|---|
{ "userInterestId": string, "lift": number, "ageRange": enum ( |
| שדות | |
|---|---|
userInterestId |
מזהה תחום העניין של המשתמש. |
lift |
מדד העלייה שקהל היעד השיג בערך המאפיין בהשוואה לערך הבסיס. הטווח [0-1]. |
ageRange |
טווח הגילאים של הקהל שעבורו מוצגות נתוני העלייה. |
gender |
המגדר של הקהל שעבורו מסופקת העלייה. |
טווח גילים
טווח הגילאים הדמוגרפי
| טיפוסים בני מנייה (enum) | |
|---|---|
AGE_RANGE_UNSPECIFIED |
לא צוין. |
AGE_RANGE_UNKNOWN |
לא ידוע. |
AGE_RANGE_18_24 |
בגיל 18 עד 24. |
AGE_RANGE_25_34 |
בגיל 25 עד 34. |
AGE_RANGE_35_44 |
בגיל 35 עד 44. |
AGE_RANGE_45_54 |
בגיל 45 עד 54. |
AGE_RANGE_55_64 |
בגיל 55 עד 64. |
AGE_RANGE_65_UP |
גיל 65 ומעלה. |
מגדר
סוג המגדר הדמוגרפי (לדוגמה, נקבה).
| טיפוסים בני מנייה (enum) | |
|---|---|
GENDER_UNSPECIFIED |
לא צוין. |
GENDER_UNKNOWN |
לא ידוע. |
GENDER_MALE |
זכר. |
GENDER_FEMALE |
נקבה. |