REST Resource: firstAndThirdPartyAudiences

משאב: FirstAndIIIPartyAudience

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

ייצוג 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

פלט בלבד. שם המשאב של הקהל הראשון והקהל של הצד השלישי.
firstAndThirdPartyAudienceId

string (int64 format)

פלט בלבד. המזהה הייחודי של הקהל הראשון והקהל של הצד השלישי. הוקצתה על ידי המערכת.
displayName

string

השם המוצג של הקהל הראשון והקהל של הצד השלישי.
description

string

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

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

enum (FirstAndThirdPartyAudienceType)

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

enum (AudienceType)

סוג הקהל.
audienceSource

enum (AudienceSource)

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

string (int64 format)

משך הזמן (בימים) שבו רשומה מסוימת נשארת בקהל אחרי אירוע הזכאות. אם לקהל אין תפוגה, צריך להגדיר את הערך בשדה הזה כ-10,000. אחרת, הערך שהוגדר צריך להיות גדול מ-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 מטעמי פרטיות. אחרת, המספר יעוגל לשתי ספרות משמעותיות.

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

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

string (int64 format)

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

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

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

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

string (int64 format)

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

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

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

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

string (int64 format)

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

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

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

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

string (int64 format)

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

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

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

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

string

ה-appId תואם לסוג של מזהי ה-mobileDeviceId שמעלים.

רלוונטי רק לCUSTOMER_MATCH_DEVICE_IDaudienceType
שדה איחוד members. החברים הראשונים בקהל של 'התאמה ללקוחות'. members יכול להיות רק אחת מהאפשרויות הבאות:
contactInfoList

object (ContactInfoList)

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

רלוונטי רק לCUSTOMER_MATCH_CONTACT_INFOaudienceType
mobileDeviceIdList

object (MobileDeviceIdList)

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

רלוונטי רק לCUSTOMER_MATCH_DEVICE_IDaudienceType

FirstAndThirdPartyAudienceType

סוגים אפשריים של משאבי קהלים של צד ראשון וצד שלישי.

טיפוסים בני מנייה (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 הקהל נוצר באמצעות התאמת לקוחות למזהי משתמשים מוכרים.
ACTIVITY_BASED

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

הקהל נוצר על סמך החרגה של מספר החשיפות שהמודעות קיבלו.
TAG_BASED הקהל נוצר על סמך משתנים מותאמים אישית שמצורפים לפיקסל.
YOUTUBE_USERS הקהל נוצר על סמך אינטראקציות קודמות עם סרטונים, מודעות YouTube או ערוץ YouTube.
LICENSED תת-סוג של קהל מסוג צד שלישי.

AudienceSource

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

טיפוסים בני מנייה (enum)
AUDIENCE_SOURCE_UNSPECIFIED ערך ברירת המחדל כשמקור הנתונים ליצירת קהלים לא צוין או שאינו ידוע.
DISPLAY_VIDEO_360 הגיעו מרשת המדיה וידאו 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. לפני הגיבוב (hashing), יש להסיר את כל הרווחים הלבנים ולוודא שהמחרוזת כתובה באותיות קטנות.
hashedPhoneNumbers[]

string

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

string

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

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

string

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

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

string

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

צריך להגדיר גם את השדות הבאים:
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

 יצירת קהל של FirstAndFirstParty.

editCustomerMatchMembers

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

get

 מקבל קהל של צד ראשון וקהל של צד שלישי.

list

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

patch

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