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)

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

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 الجمهور المستهدف لمحتوى البرامج التلفزيونية المُجدوَلة
AGENCY شريحة الجمهور التي تقدّمها وكالة

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 حالي