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,

  // 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

النتائج فقط. اسم المورد لشريحة جمهور الطرف الأول والشريك
firstPartyAndPartnerAudienceId

string (int64 format)

المعرّف المعرّف الفريد لشريحة جمهور الطرف الأول والشريك تمّ تعيينه من قِبل النظام.
displayName

string

النتائج فقط. الاسم المعروض لشريحة جمهور الطرف الأول والشريك.
description

string

النتائج فقط. الوصف الذي يوفّره المستخدِم للجمهور.

لا ينطبق ذلك إلا على شرائح جمهور الطرف الأول.
firstPartyAndPartnerAudienceType

enum (FirstPartyAndPartnerAudienceType)

النتائج فقط. ما إذا كان الجمهور تابعًا للطرف الأول أو شريكًا
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)

النتائج فقط. حجم الجمهور المقدّر للشبكة الإعلانية

إذا كان العدد أقل من 1000، سيتم إخفاءه وسيتم عرض القيمة 0 لأسباب تتعلّق بالخصوصية. بخلاف ذلك، سيتم تقريب الرقم إلى رقمين معنوين.

لا يتم عرضها إلا في طلب GET.
activeDisplayAudienceSize

string (int64 format)

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

إذا كان العدد أقل من 1000، سيتم إخفاءه وسيتم عرض القيمة 0 لأسباب تتعلّق بالخصوصية. بخلاف ذلك، سيتم تقريب الرقم إلى رقمين معنوين.

لا يتم عرضها إلا في طلب GET.
youtubeAudienceSize

string (int64 format)

النتائج فقط. حجم الجمهور المقدّر لشبكة YouTube

إذا كان العدد أقل من 1000، سيتم إخفاءه وسيتم عرض القيمة 0 لأسباب تتعلّق بالخصوصية. بخلاف ذلك، سيتم تقريب الرقم إلى رقمين معنوين.

لا ينطبق ذلك إلا على شرائح جمهور الطرف الأول.

لا يتم عرضها إلا في طلب GET.
gmailAudienceSize

string (int64 format)

النتائج فقط. حجم الجمهور المقدّر لشبكة Gmail

إذا كان العدد أقل من 1000، سيتم إخفاءه وسيتم عرض القيمة 0 لأسباب تتعلّق بالخصوصية. بخلاف ذلك، سيتم تقريب الرقم إلى رقمين معنوين.

لا ينطبق ذلك إلا على شرائح جمهور الطرف الأول.

لا يتم عرضها إلا في طلب GET.
displayMobileAppAudienceSize

string (int64 format)

النتائج فقط. حجم الجمهور المقدّر للتطبيقات المتوافقة مع الأجهزة الجوّالة في "الشبكة الإعلانية"

إذا كان العدد أقل من 1000، سيتم إخفاءه وسيتم عرض القيمة 0 لأسباب تتعلّق بالخصوصية. بخلاف ذلك، سيتم تقريب الرقم إلى رقمين معنوين.

لا ينطبق ذلك إلا على شرائح جمهور الطرف الأول.

لا يتم عرضها إلا في طلب GET.
displayMobileWebAudienceSize

string (int64 format)

النتائج فقط. حجم جمهور الويب على الأجهزة الجوّالة المقدّر في "شبكة Google الإعلانية"

إذا كان العدد أقل من 1000، سيتم إخفاءه وسيتم عرض القيمة 0 لأسباب تتعلّق بالخصوصية. بخلاف ذلك، سيتم تقريب الرقم إلى رقمين معنوين.

لا ينطبق ذلك إلا على شرائح جمهور الطرف الأول.

لا يتم عرضها إلا في طلب GET.
displayDesktopAudienceSize

string (int64 format)

النتائج فقط. حجم الجمهور المقدَّر على أجهزة الكمبيوتر المكتبي في "شبكة Google الإعلانية"

إذا كان العدد أقل من 1000، سيتم إخفاءه وسيتم عرض القيمة 0 لأسباب تتعلّق بالخصوصية. بخلاف ذلك، سيتم تقريب الرقم إلى رقمين معنوين.

لا ينطبق ذلك إلا على شرائح جمهور الطرف الأول.

لا يتم عرضها إلا في طلب 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

FirstPartyAndPartnerAudienceType

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

عمليات التعداد
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED القيمة التلقائية عندما لا يكون النوع محدّدًا أو غير معروف
TYPE_FIRST_PARTY شريحة الجمهور التي يتم إنشاؤها من خلال استخدام بيانات العميل.
TYPE_PARTNER شرائح الجمهور التي يوفّرها مزوّدو البيانات التابعون لجهات خارجية

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.
THIRD_PARTY تم ترخيص شريحة الجمهور لاستخدامها من جهة خارجية.
COMMERCE شريحة الجمهور التي يوفّرها شركاء التجارة مقابل رسوم
LINEAR شريحة جمهور محتوى البث التلفزيوني المباشر

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

 تُنشئ شريحة جمهور FirstPartyAndPartnerAudience.

editCustomerMatchMembers

 تعديل قائمة أعضاء شريحة جمهور "مطابقة العملاء"

get

 الحصول على شريحة جمهور من الطرف الأول أو شريحة جمهور شريك

list

 يسرد شرائح جمهور الطرف الأول والشركاء.

patch

 تعديل شريحة جمهور حالية من النوع FirstPartyAndPartnerAudience