Method: customers.generateAudienceCompositionInsights

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

רשימת שגיאות התרעה: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

בקשת HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}:generateAudienceCompositionInsights

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

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

פרמטרים
customerId

string

חובה. מספר הלקוח.

גוף הבקשה

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

ייצוג JSON
{
  "audience": {
    object (InsightsAudience)
  },
  "baselineAudience": {
    object (InsightsAudience)
  },
  "dataMonth": string,
  "dimensions": [
    enum (AudienceInsightsDimension)
  ],
  "customerInsightsGroup": string
}
שדות
audience

object (InsightsAudience)

חובה. קהל העניין שעבורו מבקשים לקבל תובנות.

baselineAudience

object (InsightsAudience)

קהל הבסיס שאליו מתבצעת השוואה של קהל העניין.

dataMonth

string

טווח של חודש אחד של נתונים היסטוריים לשימוש בתובנות, בפורמט 'yyyy-mm'. אם המדיניות לא מוגדרת, התובנות יוחזרו עבור הנתונים של 30 הימים האחרונים.

dimensions[]

enum (AudienceInsightsDimension)

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

customerInsightsGroup

string

שם הלקוח המתוכנן. זהו ערך בהגדרת המשתמש.

גוף התגובה

הודעת תשובה לגבי AudienceInsightsService.GenerateAudienceCompositionInsights.

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

ייצוג JSON
{
  "sections": [
    {
      object (AudienceCompositionSection)
    }
  ]
}
שדות
sections[]

object (AudienceCompositionSection)

התוכן של דוח התובנות, מסודר לפי קטעים. כל קטע משויך לאחד מהערכים של AudienceInsightsDimensions בבקשה. יכול להיות יותר מקטע אחד לכל מאפיין.

היקפי הרשאות

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

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

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

InsightsAudience

קבוצת משתמשים שמוגדרת לפי מאפיינים שונים, שעבורה אפשר לבקש תובנות ב-AudienceInsightsService.

ייצוג JSON
{
  "countryLocations": [
    {
      object (LocationInfo)
    }
  ],
  "subCountryLocations": [
    {
      object (LocationInfo)
    }
  ],
  "gender": {
    object (GenderInfo)
  },
  "ageRanges": [
    {
      object (AgeRangeInfo)
    }
  ],
  "parentalStatus": {
    object (ParentalStatusInfo)
  },
  "incomeRanges": [
    {
      object (IncomeRangeInfo)
    }
  ],
  "dynamicLineups": [
    {
      object (AudienceInsightsDynamicLineup)
    }
  ],
  "topicAudienceCombinations": [
    {
      object (InsightsAudienceAttributeGroup)
    }
  ]
}
שדות
countryLocations[]

object (LocationInfo)

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

subCountryLocations[]

object (LocationInfo)

מאפייני מיקום גיאוגרפי של מדינות משנה. אם השדה הזה קיים, כל אחד מהם צריך להיכלל באחת מהמדינות בקהל הזה. אם הוא לא קיים, הקהל נמצא גיאוגרפית במדינה (countryLocations) בלבד.

gender

object (GenderInfo)

המגדר של הקהל. אם המאפיין חסר, הקהל לא מגביל את החשיפה לפי מגדר.

ageRanges[]

object (AgeRangeInfo)

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

parentalStatus

object (ParentalStatusInfo)

סטטוס הורה של הקהל. אם התג לא קיים, הקהל לא מוגבל לפי סטטוס הורה.

incomeRanges[]

object (IncomeRangeInfo)

טווחי אחוזים של הכנסה למשק בית עבור הקהל. אם הערך חסר, הקהל לא מגביל את היקף ההכנסה למשק בית.

dynamicLineups[]

object (AudienceInsightsDynamicLineup)

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

topicAudienceCombinations[]

object (InsightsAudienceAttributeGroup)

שילוב של מאפיינים של ישות, קטגוריה ותחומי עניין של המשתמש, שמגדירים את הקהל. לשילוב יש מבנה AND-OR לוגי: מאפיינים בכל InsightsAudienceAttributeGroup משולבים עם OR, והשילובים עצמם משולבים יחד עם AND. לדוגמה, אפשר ליצור את הביטוי (ישות OR תחום עניין משותף) AND (קהל עם כוונת רכישה או קטגוריה) באמצעות שני מדדים של InsightsAudienceAttributeGroups שלכל אחד מהם יש שני מאפיינים.

InsightsAudienceAttributeGroup

רשימה של AudienceInsightsAttributes.

ייצוג JSON
{
  "attributes": [
    {
      object (AudienceInsightsAttribute)
    }
  ]
}
שדות
attributes[]

object (AudienceInsightsAttribute)

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

AudienceCompositionSection

אוסף של מאפיינים קשורים מאותו סוג בדוח תובנות על הרכב הקהל.

ייצוג JSON
{
  "dimension": enum (AudienceInsightsDimension),
  "topAttributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ],
  "clusteredAttributes": [
    {
      object (AudienceCompositionAttributeCluster)
    }
  ]
}
שדות
dimension

enum (AudienceInsightsDimension)

סוג המאפיינים בקטע הזה.

topAttributes[]

object (AudienceCompositionAttribute)

הפלחים הרלוונטיים ביותר לקהל הזה. אם המאפיין הוא GENDER, AGE_RANGE או PARENTAL_STATUS, רשימת המאפיינים הזו היא מקיפה.

clusteredAttributes[]

object (AudienceCompositionAttributeCluster)

מאפיינים נוספים לקהל הזה, מקובצים באשכולות. השדה יאוכלס רק אם המאפיין הוא YOUTUBE_CHANNEL.

AudienceCompositionAttribute

מאפיין קהל עם מטא-נתונים ומדדים.

ייצוג JSON
{
  "attributeMetadata": {
    object (AudienceInsightsAttributeMetadata)
  },
  "metrics": {
    object (AudienceCompositionMetrics)
  }
}
שדות
attributeMetadata

object (AudienceInsightsAttributeMetadata)

המאפיין עם המטא-נתונים שלו.

metrics

object (AudienceCompositionMetrics)

שיתוף והוספה לאינדקס של מדדי המאפיין.

AudienceCompositionMetrics

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

ייצוג JSON
{
  "baselineAudienceShare": number,
  "audienceShare": number,
  "index": number,
  "score": number
}
שדות
baselineAudienceShare

number

השבר (מ-0 עד 1 כולל) של קהל הבסיס שמתאים למאפיין.

audienceShare

number

השבר (מ-0 עד 1 כולל) של הקהל הספציפי שתואם למאפיין.

index

number

היחס בין AudienceShare ל-baseAudienceShare, או אפס אם היחס הזה לא מוגדר או שהוא לא משמעותי.

score

number

ציון רלוונטיות מ-0 עד 1, כולל.

AudienceCompositionAttributeCluster

אוסף של מאפיינים קשורים, עם מטא-נתונים ומדדים, בדוח תובנות לגבי הרכב הקהל.

ייצוג JSON
{
  "clusterDisplayName": string,
  "clusterMetrics": {
    object (AudienceCompositionMetrics)
  },
  "attributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ]
}
שדות
clusterDisplayName

string

השם של אשכול המאפיינים הזה

clusterMetrics

object (AudienceCompositionMetrics)

אם המאפיין המשויך לאשכול הזה הוא YOUTUBE_CHANNEL, אז clusterMetrics הם מדדים שמשויכים לאשכול בכללותו. במאפיינים אחרים השדה הזה לא מוגדר.

attributes[]

object (AudienceCompositionAttribute)

המאפיינים הספציפיים שמרכיבים את האשכול הזה, עם מטא-נתונים ומדדים.