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)

هي المدة بالأيام التي يظل فيها أحد الإدخالات ضمن شريحة الجمهور بعد الحدث المؤهِّل. يجب أن تكون القيمة المحدّدة أكبر من 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

الأنواع المحتملة لمصدر بيانات جمهور الطرف الأول والجهات الخارجية

عمليات التعداد
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED القيمة التلقائية عندما لا يتم تحديد النوع أو يكون غير معروف
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY شريحة الجمهور التي يتم إنشاؤها من خلال استخدام بيانات العميل
FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY الجمهور الذي يقدّمه مزوّدو بيانات تابعون لجهات خارجية

AudienceType

أنواع شرائح الجمهور المحتملة

عمليات التعداد
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

مصادر الجمهور المحتملة

عمليات التعداد
AUDIENCE_SOURCE_UNSPECIFIED القيمة التلقائية عندما لا يتم تحديد مصدر شريحة الجمهور أو يكون غير معروف
DISPLAY_VIDEO_360 نشأت من "مساحة العرض والفيديو 360".
CAMPAIGN_MANAGER نشأت من "مدير الحملة 360".
AD_MANAGER مصدرها "مدير إعلانات Google".
SEARCH_ADS_360 نشأت من "إعلانات شبكة البحث 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

قائمة بعناوين البريد الإلكتروني المجزّأة باستخدام خوارزمية SHA256 الخاصة بالعضو قبل التجزئة، أزِل جميع المسافات البيضاء وتأكَّد من أنّ السلسلة تتضمّن أحرفًا إنجليزية صغيرة فقط.

hashedPhoneNumbers[]

string

قائمة بأرقام هواتف الأعضاء المجزّأة باستخدام خوارزمية SHA256 قبل التجزئة، يجب تنسيق جميع أرقام الهواتف باستخدام تنسيق E.164 وتضمين رمز الاتصال الخاص بالبلد.

zipCodes[]

string

تمثّل هذه السمة قائمة بالرموز البريدية الخاصة بالمشترك.

يجب أيضًا ضبطها باستخدام الحقول التالية:

hashedFirstName

string

الاسم الأوّل المجزّأ باستخدام خوارزمية SHA256 الخاص بالمشترك قبل التجزئة، أزِل جميع المسافات البيضاء وتأكَّد من أنّ السلسلة تتضمّن أحرفًا إنجليزية صغيرة فقط.

يجب أيضًا ضبطها باستخدام الحقول التالية:

hashedLastName

string

اسم العائلة المجزّأ باستخدام خوارزمية SHA256 الخاص بالمشترك قبل التجزئة، أزِل جميع المسافات البيضاء وتأكَّد من أنّ السلسلة تتضمّن أحرفًا إنجليزية صغيرة فقط.

يجب أيضًا ضبطها باستخدام الحقول التالية:

countryCode

string

رمز بلد العضو

يجب أيضًا ضبطها باستخدام الحقول التالية:

ConsentStatus

حالة الموافقة

عمليات التعداد
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، سيعرض الطلب خطأً.

الطُرق

create

تُنشئ هذه الطريقة كائن FirstAndThirdPartyAudience.

editCustomerMatchMembers

تعدّل هذه الطريقة قائمة الأعضاء في إحدى شرائح جمهور "مطابقة العملاء".

get

تعرض هذه السمة جمهور الطرف الأول والطرف الثالث.

list

تعرض هذه السمة شرائح الجمهور التابعة للطرف الأول والجهات الخارجية.

patch

تعدّل هذه الطريقة FirstAndThirdPartyAudience حالية.