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

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

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

object (ContactInfoList)

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

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

object (MobileDeviceIdList)

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

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

FirstAndThirdPartyAudienceType

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

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

AudienceType

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

טיפוסים בני מנייה (enums)
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

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

טיפוסים בני מנייה (enums)
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 שמגדירים את חברי הקהל ב'התאמה ללקוחות'. גודל החברים לאחר פיצול פריטי 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 של המנוי. לפני הגיבוב (hashing), צריך להזין את כל מספרי הטלפון בפורמט E.164 ולכלול את קוד השיחה של המדינה.
zipCodes[]

string

רשימת המיקודים של החבר/ה.

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

string

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

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

string

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

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

string

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

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

ConsentStatus

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

טיפוסים בני מנייה (enums)
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

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

list

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

patch

 עדכון של FirstAndThirdPartyAudience קיים