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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "contactInfoList": {
    object (ContactInfoList)
  },
  "mobileDeviceIdList": {
    object (MobileDeviceIdList)
  }
  // End of mutually exclusive fields.
}
שדות
name

string

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

string (int64 format)

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

string

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

string

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

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

enum (FirstPartyAndPartnerAudienceType)

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

enum (AudienceType)

אי אפשר לשנות. סוג הקהל.
audienceSource

enum (AudienceSource)

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

string (int64 format)

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

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

object (ContactInfoList)

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

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

object (MobileDeviceIdList)

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

רלוונטי רק ל-audienceType CUSTOMER_MATCH_DEVICE_ID
סוף השדות הבלעדיים.

ContactInfoList

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

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

object (ContactInfo)

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

string

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

string

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

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

string

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

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

string

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

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

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

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

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.

Methods

create

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

editCustomerMatchMembers

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

get

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

list

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

patch

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