REST Resource: firstPartyAndPartnerAudiences

משאב: FirstPartyAndPartnerAudience

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

ייצוג ב-JSON 
{
  "name": string,
  "firstPartyAndPartnerAudienceId": string,
  "displayName": string,
  "description": string,
  "firstPartyAndPartnerAudienceType": enum (FirstPartyAndPartnerAudienceType),
  "audienceType": enum (AudienceType),
  "audienceSource": enum (AudienceSource),
  "membershipDurationDays": string,
  "displayAudienceSize": string,
  "activeDisplayAudienceSize": string,
  "youtubeAudienceSize": string,
  "gmailAudienceSize": string,
  "displayMobileAppAudienceSize": string,
  "displayMobileWebAudienceSize": string,
  "displayDesktopAudienceSize": string,
  "appId": string,

  // Union field members can be only one of the following:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of list of possible types for union field members.
}
שדות
name

string

פלט בלבד. שם המשאב של קהל הצד הראשון וקהל השותף.
firstPartyAndPartnerAudienceId

string (int64 format)

מזהה. המזהה הייחודי של קהל מאינטראקציה ישירה (First-Party) וקהל של שותף. המערכת מקצה את השם.
displayName

string

פלט בלבד. השם המוצג של קהל הצד הראשון וקהל השותף.
description

string

פלט בלבד. התיאור של הקהל שהמשתמש סיפק.

האפשרות הזו רלוונטית רק לקהלים מאינטראקציה ישירה (First-Party).
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

פלט בלבד. אם הקהל הוא קהל מאינטראקציה ישירה (first-party) וקהל של שותף.
audienceType

enum (AudienceType)

פלט בלבד. סוג הקהל.
audienceSource

enum (AudienceSource)

פלט בלבד. המקור של הקהל.
membershipDurationDays

string (int64 format)

פלט בלבד. משך הזמן, בימים, שבו רשומה נשארת בקהל אחרי האירוע שעמד בדרישות. אם לקהל אין תאריך תפוגה, מגדירים את הערך בשדה הזה כ-10000. אחרת, הערך שהוגדר צריך להיות גדול מ-0 וקטן מ-540 או שווה לו.

האפשרות הזו רלוונטית רק לקהלים מאינטראקציה ישירה (First-Party).

השדה הזה נדרש אם משתמשים באחד מה-audienceType הבאים:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string (int64 format)

פלט בלבד. גודל הקהל המשוער ברשת המדיה.

אם הגודל קטן מ-1,000, המספר יהיה מוסתר והערך 0 יוחזר מטעמי פרטיות. אחרת, המספר יעוגל לשתי ספרות משמעותיות.

הנתון הזה מוחזר רק בבקשת GET.
activeDisplayAudienceSize

string (int64 format)

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

אם הגודל קטן מ-1,000, המספר יהיה מוסתר והערך 0 יוחזר מטעמי פרטיות. אחרת, המספר יעוגל לשתי ספרות משמעותיות.

הנתון הזה מוחזר רק בבקשת GET.
youtubeAudienceSize

string (int64 format)

פלט בלבד. גודל הקהל המשוער של רשת YouTube.

אם הגודל קטן מ-1,000, המספר יהיה מוסתר והערך 0 יוחזר מטעמי פרטיות. אחרת, המספר יעוגל לשתי ספרות משמעותיות.

האפשרות הזו רלוונטית רק לקהלים מאינטראקציה ישירה (First-Party).

הנתון הזה מוחזר רק בבקשת GET.
gmailAudienceSize

string (int64 format)

פלט בלבד. גודל הקהל המשוער ברשת Gmail.

אם הגודל קטן מ-1,000, המספר יהיה מוסתר והערך 0 יוחזר מטעמי פרטיות. אחרת, המספר יעוגל לשתי ספרות משמעותיות.

האפשרות הזו רלוונטית רק לקהלים מאינטראקציה ישירה (First-Party).

הנתון הזה מוחזר רק בבקשת GET.
displayMobileAppAudienceSize

string (int64 format)

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

אם הגודל קטן מ-1,000, המספר יהיה מוסתר והערך 0 יוחזר מטעמי פרטיות. אחרת, המספר יעוגל לשתי ספרות משמעותיות.

האפשרות הזו רלוונטית רק לקהלים מאינטראקציה ישירה (First-Party).

הנתון הזה מוחזר רק בבקשת GET.
displayMobileWebAudienceSize

string (int64 format)

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

אם הגודל קטן מ-1,000, המספר יהיה מוסתר והערך 0 יוחזר מטעמי פרטיות. אחרת, המספר יעוגל לשתי ספרות משמעותיות.

האפשרות הזו רלוונטית רק לקהלים מאינטראקציה ישירה (First-Party).

הנתון הזה מוחזר רק בבקשת GET.
displayDesktopAudienceSize

string (int64 format)

פלט בלבד. גודל הקהל המשוער במחשבים ברשת המדיה.

אם הגודל קטן מ-1,000, המספר יהיה מוסתר והערך 0 יוחזר מטעמי פרטיות. אחרת, המספר יעוגל לשתי ספרות משמעותיות.

האפשרות הזו רלוונטית רק לקהלים מאינטראקציה ישירה (First-Party).

הנתון הזה מוחזר רק בבקשת GET.
appId

string

זה שינוי אופציונלי. השדה appId תואם לסוג של מזהי mobileDeviceId שמעלים.

רלוונטי רק ל-audienceType CUSTOMER_MATCH_DEVICE_ID
שדה האיחוד members. החברים הראשונים בקהל 'התאמה ללקוחות'. הערך של members יכול להיות רק אחת מהאפשרויות הבאות:
contactInfoList

object (ContactInfoList)

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

רלוונטי רק ל-audienceType CUSTOMER_MATCH_CONTACT_INFO
mobileDeviceIdList

object (MobileDeviceIdList)

קלט בלבד. רשימה של מזהי מכשירים ניידים להגדרת חברי הקהל הראשוניים.

רלוונטי רק ל-audienceType CUSTOMER_MATCH_DEVICE_ID

FirstPartyAndPartnerAudienceType

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

טיפוסים בני מנייה (enum)
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED ערך ברירת המחדל כשהסוג לא צוין או לא ידוע.
TYPE_FIRST_PARTY קהל שנוצר על סמך שימוש בנתוני לקוחות.
TYPE_PARTNER קהל שמסופק על ידי ספקי נתונים של צד שלישי.

AudienceType

סוגי קהלים אפשריים.

טיפוסים בני מנייה (enum)
AUDIENCE_TYPE_UNSPECIFIED ערך ברירת המחדל כשהסוג לא צוין או לא ידוע.
CUSTOMER_MATCH_CONTACT_INFO הקהל נוצר על ידי התאמת לקוחות לפרטים ידועים ליצירת קשר.
CUSTOMER_MATCH_DEVICE_ID הקהל נוצר על ידי התאמת לקוחות למזהי מכשירים ניידים ידועים.
CUSTOMER_MATCH_USER_ID הקהל נוצר על ידי התאמת לקוחות למזהי User ID ידועים.
ACTIVITY_BASED

הקהל נוצר על סמך פעילות הקמפיין.
FREQUENCY_CAP

הקהל נוצר על סמך החרגת מספר החשיפות שהוצגו לו.
TAG_BASED הקהל נוצר על סמך משתנים מותאמים אישית שמצורפים ל-pixel.
YOUTUBE_USERS הקהל נוצר על סמך אינטראקציות קודמות עם סרטונים, מודעות ב-YouTube או ערוץ YouTube.
THIRD_PARTY הקהל נרכש ברישיון מצד שלישי.
COMMERCE קהל שסופק על ידי שותפי מסחר בתשלום.
LINEAR קהל של תוכן בטלוויזיה לינארית.

AudienceSource

מקורות אפשריים ליצירת קהלים.

טיפוסים בני מנייה (enum)
AUDIENCE_SOURCE_UNSPECIFIED ערך ברירת המחדל כשמקור הקהל לא צוין או לא ידוע.
DISPLAY_VIDEO_360 המקור שלהם הוא Display & Video 360.
CAMPAIGN_MANAGER המקור שלהן הוא Campaign Manager 360.
AD_MANAGER המקור הוא Google Ad Manager.
SEARCH_ADS_360 נוצרו ב-Search Ads 360.
YOUTUBE מקור הנתונים הוא YouTube.
ADS_DATA_HUB מקור הנתונים הוא Ads Data Hub.

ContactInfoList

הודעת עטיפה לרשימת פרטים ליצירת קשר שמגדירה את חברי הקהל בהתאמה ללקוחות.

ייצוג ב-JSON 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
שדות
contactInfos[]

object (ContactInfo)

רשימה של אובייקטים מסוג ContactInfo שמגדירים את חברי הקהל מסוג 'התאמה ללקוחות'. הגודל של רשימת המשתתפים אחרי חלוקת contactInfos לא יכול להיות גדול מ-500,000.
consent

object (Consent)

קלט בלבד. הגדרת ההסכמה של המשתמשים ב-contactInfos.

אם השדה הזה לא מוגדר, סימן שלא צוינה הסכמה.

אם השדות adUserData או adPersonalization מוגדרים ל-CONSENT_STATUS_DENIED, הבקשה תחזיר שגיאה.

ContactInfo

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

ייצוג ב-JSON 
{
  "hashedEmails": [
    string
  ],
  "hashedPhoneNumbers": [
    string
  ],
  "zipCodes": [
    string
  ],
  "hashedFirstName": string,
  "hashedLastName": string,
  "countryCode": string
}
שדות
hashedEmails[]

string

רשימה של כתובות האימייל של המשתמש שעברו גיבוב (hash) באמצעות SHA256. לפני ביצוע הגיבוב, מסירים את כל הרווחים ומקפידים שהמחרוזת תהיה מורכבת רק מאותיות קטנות.
hashedPhoneNumbers[]

string

רשימה של מספרי הטלפון של המשתמש שעבר גיבוב (hash) באמצעות SHA256. לפני הגיבוב, כל מספרי הטלפון צריכים להיות בפורמט E.164 ולכלול את קידומת המדינה.
zipCodes[]

string

רשימה של אזורי המיקוד של המשתמש.

צריך להגדיר גם את השדות הבאים:
hashedFirstName

string

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

צריך להגדיר גם את השדות הבאים:
hashedLastName

string

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

צריך להגדיר גם את השדות הבאים:
countryCode

string

קוד המדינה של המשתמש.

צריך להגדיר גם את השדות הבאים:

ConsentStatus

סטטוס ההסכמה.

טיפוסים בני מנייה (enum)
CONSENT_STATUS_UNSPECIFIED ערך הטיפוס לא צוין או שהוא לא ידוע בגרסה הזו.
CONSENT_STATUS_GRANTED ניתנת הסכמה.
CONSENT_STATUS_DENIED ההסכמה נדחית.

MobileDeviceIdList

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

ייצוג ב-JSON 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
שדות
mobileDeviceIds[]

string

רשימה של מזהי מכשירים ניידים שמגדירה את חברי הקהל של התאמה ללקוחות. הגודל של mobileDeviceIds לא יכול להיות גדול מ-500,000.
consent

object (Consent)

קלט בלבד. הגדרת ההסכמה של המשתמשים ב-mobileDeviceIds.

אם השדה הזה לא מוגדר, סימן שלא צוינה הסכמה.

אם השדות adUserData או adPersonalization מוגדרים ל-CONSENT_STATUS_DENIED, הבקשה תחזיר שגיאה.

Methods

create

 הפונקציה יוצרת קהל מסוג FirstPartyAndPartnerAudience.

editCustomerMatchMembers

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

get

 הפונקציה מקבלת קהל מאינטראקציה ישירה או קהל של שותף.

list

 רשימת קהלים מאינטראקציה ישירה וקהלים של שותפים.

patch

 עדכון של קהל קיים מסוג FirstPartyAndPartnerAudience.