- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- InsightsAudience
- InsightsAudienceAttributeGroup
- AudienceCompositionSection
- AudienceCompositionAttribute
- AudienceCompositionMetrics
- AudienceCompositionAttributeCluster
- רוצים לנסות?
פונקציה זו מחזירה אוסף של מאפיינים שמיוצגים בקהל של תחום עניין, עם מדדים שמשווים את הנתח של כל מאפיין בקהל לחלק שלו בקהל הבסיס.
רשימת שגיאות התרעה: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError
בקשת HTTP
POST https://googleads.googleapis.com/v14/customers/{customerId}:generateAudienceCompositionInsights
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
customerId |
חובה. מספר הלקוח. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "audience": { object ( |
שדות | |
---|---|
audience |
חובה. קהל העניין שעבורו מבקשים לקבל תובנות. |
baselineAudience |
קהל הבסיס שאליו מתבצעת השוואה של קהל העניין. |
dataMonth |
טווח של חודש אחד של נתונים היסטוריים לשימוש בתובנות, בפורמט 'yyyy-mm'. אם המדיניות לא מוגדרת, התובנות יוחזרו עבור הנתונים של 30 הימים האחרונים. |
dimensions[] |
חובה. מאפייני הקהל שעבורם צריך להחזיר את מדדי ההרכב. |
customerInsightsGroup |
שם הלקוח המתוכנן. זהו ערך בהגדרת המשתמש. |
גוף התגובה
הודעת תשובה לגבי AudienceInsightsService.GenerateAudienceCompositionInsights
.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"sections": [
{
object ( |
שדות | |
---|---|
sections[] |
התוכן של דוח התובנות, מסודר לפי קטעים. כל קטע משויך לאחד מהערכים של AudienceInsightsDimensions בבקשה. יכול להיות יותר מקטע אחד לכל מאפיין. |
היקפי הרשאות
נדרש היקף OAuth הבא:
https://www.googleapis.com/auth/adwords
למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
InsightsAudience
קבוצת משתמשים שמוגדרת לפי מאפיינים שונים, שעבורה אפשר לבקש תובנות ב-AudienceInsightsService.
ייצוג JSON |
---|
{ "countryLocations": [ { object ( |
שדות | |
---|---|
countryLocations[] |
חובה. המדינות שבהן קהל היעד נמצא. |
subCountryLocations[] |
מאפייני מיקום גיאוגרפי של מדינות משנה. אם השדה הזה קיים, כל אחד מהם צריך להיכלל באחת מהמדינות בקהל הזה. אם הוא לא קיים, הקהל נמצא גיאוגרפית במדינה (countryLocations) בלבד. |
gender |
המגדר של הקהל. אם המאפיין חסר, הקהל לא מגביל את החשיפה לפי מגדר. |
ageRanges[] |
טווחי גילאים לקהל. אם לא צוין מזהה כזה, הקהל מייצג את כל האנשים מעל גיל 18 שתואמים למאפיינים האחרים. |
parentalStatus |
סטטוס הורה של הקהל. אם התג לא קיים, הקהל לא מוגבל לפי סטטוס הורה. |
incomeRanges[] |
טווחי אחוזים של הכנסה למשק בית עבור הקהל. אם הערך חסר, הקהל לא מגביל את היקף ההכנסה למשק בית. |
dynamicLineups[] |
מבחר ערוצים דינמי שמייצג את התוכן ב-YouTube שנצפה על ידי הקהל. |
topicAudienceCombinations[] |
שילוב של מאפיינים של ישות, קטגוריה ותחומי עניין של המשתמש, שמגדירים את הקהל. לשילוב יש מבנה AND-OR לוגי: מאפיינים בכל InsightsAudienceAttributeGroup משולבים עם OR, והשילובים עצמם משולבים יחד עם AND. לדוגמה, אפשר ליצור את הביטוי (ישות OR תחום עניין משותף) AND (קהל עם כוונת רכישה או קטגוריה) באמצעות שני מדדים של InsightsAudienceAttributeGroups שלכל אחד מהם יש שני מאפיינים. |
InsightsAudienceAttributeGroup
רשימה של AudienceInsightsAttributes.
ייצוג JSON |
---|
{
"attributes": [
{
object ( |
שדות | |
---|---|
attributes[] |
חובה. אוסף של מאפייני קהל לשילוב עם OR לוגי. המאפיינים לא צריכים להיות בהכרח אותו מאפיין. רק ישויות של Knowledge Graph, קטגוריות מוצרים ושירותים, וקהלים עם תחום עניין משותף וקהלים עם כוונת רכישה נתמכים בהקשר הזה. |
AudienceCompositionSection
אוסף של מאפיינים קשורים מאותו סוג בדוח תובנות על הרכב הקהל.
ייצוג JSON |
---|
{ "dimension": enum ( |
שדות | |
---|---|
dimension |
סוג המאפיינים בקטע הזה. |
topAttributes[] |
הפלחים הרלוונטיים ביותר לקהל הזה. אם המאפיין הוא GENDER, AGE_RANGE או PARENTAL_STATUS, רשימת המאפיינים הזו היא מקיפה. |
clusteredAttributes[] |
מאפיינים נוספים לקהל הזה, מקובצים באשכולות. השדה יאוכלס רק אם המאפיין הוא YOUTUBE_CHANNEL. |
AudienceCompositionAttribute
מאפיין קהל עם מטא-נתונים ומדדים.
ייצוג JSON |
---|
{ "attributeMetadata": { object ( |
שדות | |
---|---|
attributeMetadata |
המאפיין עם המטא-נתונים שלו. |
metrics |
שיתוף והוספה לאינדקס של מדדי המאפיין. |
AudienceCompositionMetrics
מדדי הנתח והאינדקס שמשויכים למאפיין בדוח תובנות על הרכב הקהל.
ייצוג JSON |
---|
{ "baselineAudienceShare": number, "audienceShare": number, "index": number, "score": number } |
שדות | |
---|---|
baselineAudienceShare |
השבר (מ-0 עד 1 כולל) של קהל הבסיס שמתאים למאפיין. |
audienceShare |
השבר (מ-0 עד 1 כולל) של הקהל הספציפי שתואם למאפיין. |
index |
היחס בין AudienceShare ל-baseAudienceShare, או אפס אם היחס הזה לא מוגדר או שהוא לא משמעותי. |
score |
ציון רלוונטיות מ-0 עד 1, כולל. |
AudienceCompositionAttributeCluster
אוסף של מאפיינים קשורים, עם מטא-נתונים ומדדים, בדוח תובנות לגבי הרכב הקהל.
ייצוג JSON |
---|
{ "clusterDisplayName": string, "clusterMetrics": { object ( |
שדות | |
---|---|
clusterDisplayName |
השם של אשכול המאפיינים הזה |
clusterMetrics |
אם המאפיין המשויך לאשכול הזה הוא YOUTUBE_CHANNEL, אז clusterMetrics הם מדדים שמשויכים לאשכול בכללותו. במאפיינים אחרים השדה הזה לא מוגדר. |
attributes[] |
המאפיינים הספציפיים שמרכיבים את האשכול הזה, עם מטא-נתונים ומדדים. |