REST Resource: firstAndThirdPartyAudiences

משאב: FirstAndThirdPartyAudience

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

ייצוג ב-JSON 
{
  "name": string,
  "firstAndThirdPartyAudienceId": string,
  "displayName": string,
  "description": string,
  "firstAndThirdPartyAudienceType": enum (FirstAndThirdPartyAudienceType),
  "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

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

string (int64 format)

פלט בלבד. המזהה הייחודי של קהל היעד מאינטראקציה ישירה (first-party) ושל קהל היעד מצד שלישי. המערכת מקצה את השם.
displayName

string

שם התצוגה של קהל היעד מאינטראקציה ישירה (first-party) ושל קהל היעד מצד שלישי.
description

string

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

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

enum (FirstAndThirdPartyAudienceType)

האם הקהל הוא קהל של צד ראשון או קהל של צד שלישי.
audienceType

enum (AudienceType)

סוג הקהל.
audienceSource

enum (AudienceSource)

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

string (int64 format)

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

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

השדה הזה נדרש אם משתמשים באחד מה-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

FirstAndThirdPartyAudienceType

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

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

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.
LICENSED תת-סוג של סוג קהל של צד שלישי.

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 שמגדירים את חברי הקהל של התאמה ללקוחות. אחרי הפיצול, לא ניתן לכלול יותר מ-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

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

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

string

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

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

string

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

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

ConsentStatus

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

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

MobileDeviceIdList

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

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

string

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

object (Consent)

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

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

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

שיטות

create

 יצירת FirstAndThirdPartyAudience.

editCustomerMatchMembers

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

get

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

list

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

patch

 מעדכנות קהל קיים של FirstAndIII.