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)

فقط خروجی. مدت زمانی که یک ورودی پس از رویداد واجد شرایط در بین مخاطبان باقی می‌ماند (به روز). مقدار تعیین شده باید بزرگتر از ۰ و کوچکتر یا مساوی ۵۴۰ باشد.

فقط برای مخاطبان شخص اول قابل اجرا است.

اگر یکی از audienceType زیر استفاده شود، این فیلد الزامی است:

  • CUSTOMER_MATCH_CONTACT_INFO
  • CUSTOMER_MATCH_DEVICE_ID
displayAudienceSize

string ( int64 format)

فقط خروجی. اندازه تخمینی مخاطب برای شبکه نمایش.

اگر اندازه کمتر از ۱۰۰۰ باشد، عدد پنهان شده و به دلایل حفظ حریم خصوصی عدد ۰ برگردانده می‌شود. در غیر این صورت، عدد به دو رقم معنی‌دار گرد می‌شود.

فقط در درخواست GET برگردانده می‌شود.

activeDisplayAudienceSize

string ( int64 format)

فقط خروجی. اندازه تخمینی مخاطبان برای شبکه نمایش در ماه گذشته.

اگر اندازه کمتر از ۱۰۰۰ باشد، عدد پنهان شده و به دلایل حفظ حریم خصوصی عدد ۰ برگردانده می‌شود. در غیر این صورت، عدد به دو رقم معنی‌دار گرد می‌شود.

فقط در درخواست GET برگردانده می‌شود.

youtubeAudienceSize

string ( int64 format)

فقط خروجی. اندازه تخمینی مخاطبان برای شبکه یوتیوب.

اگر اندازه کمتر از ۱۰۰۰ باشد، عدد پنهان شده و به دلایل حفظ حریم خصوصی عدد ۰ برگردانده می‌شود. در غیر این صورت، عدد به دو رقم معنی‌دار گرد می‌شود.

فقط برای مخاطبان شخص اول قابل اجرا است.

فقط در درخواست GET برگردانده می‌شود.

gmailAudienceSize

string ( int64 format)

فقط خروجی. اندازه تخمینی مخاطبان برای شبکه جیمیل.

اگر اندازه کمتر از ۱۰۰۰ باشد، عدد پنهان شده و به دلایل حفظ حریم خصوصی عدد ۰ برگردانده می‌شود. در غیر این صورت، عدد به دو رقم معنی‌دار گرد می‌شود.

فقط برای مخاطبان شخص اول قابل اجرا است.

فقط در درخواست GET برگردانده می‌شود.

displayMobileAppAudienceSize

string ( int64 format)

فقط خروجی. اندازه تخمینی مخاطبان اپلیکیشن موبایل در شبکه نمایش.

اگر اندازه کمتر از ۱۰۰۰ باشد، عدد پنهان شده و به دلایل حفظ حریم خصوصی عدد ۰ برگردانده می‌شود. در غیر این صورت، عدد به دو رقم معنی‌دار گرد می‌شود.

فقط برای مخاطبان شخص اول قابل اجرا است.

فقط در درخواست GET برگردانده می‌شود.

displayMobileWebAudienceSize

string ( int64 format)

فقط خروجی. اندازه تخمینی مخاطبان وب موبایل در شبکه نمایش.

اگر اندازه کمتر از ۱۰۰۰ باشد، عدد پنهان شده و به دلایل حفظ حریم خصوصی عدد ۰ برگردانده می‌شود. در غیر این صورت، عدد به دو رقم معنی‌دار گرد می‌شود.

فقط برای مخاطبان شخص اول قابل اجرا است.

فقط در درخواست GET برگردانده می‌شود.

displayDesktopAudienceSize

string ( int64 format)

فقط خروجی. اندازه تخمینی مخاطبان دسکتاپ در شبکه نمایش.

اگر اندازه کمتر از ۱۰۰۰ باشد، عدد پنهان شده و به دلایل حفظ حریم خصوصی عدد ۰ برگردانده می‌شود. در غیر این صورت، عدد به دو رقم معنی‌دار گرد می‌شود.

فقط برای مخاطبان شخص اول قابل اجرا است.

فقط در درخواست GET برگردانده می‌شود.

appId

string

اختیاری. appId با نوع mobileDeviceIds که آپلود می‌شود، مطابقت دارد.

فقط برای audienceType CUSTOMER_MATCH_DEVICE_ID قابل اجرا است.

members فیلد اتحادیه. اعضای اولیه مخاطب Customer Match. members می‌توانند فقط یکی از موارد زیر باشند:
contactInfoList

object ( ContactInfoList )

فقط ورودی. فهرستی از اطلاعات تماس برای تعریف اعضای اولیه مخاطب.

فقط برای audienceType قابل اجرا است. نوع مخاطب: CUSTOMER_MATCH_CONTACT_INFO

mobileDeviceIdList

object ( MobileDeviceIdList )

فقط ورودی. فهرستی از شناسه‌های دستگاه‌های تلفن همراه برای تعریف اعضای اولیه مخاطب.

فقط برای audienceType CUSTOMER_MATCH_DEVICE_ID قابل اجرا است.

نوع مخاطب FirstPartyAndPartner

انواع احتمالی منابع مخاطب شخص اول و شریک.

انوم‌ها
FIRST_PARTY_AND_PARTNER_AUDIENCE_TYPE_UNSPECIFIED مقدار پیش‌فرض زمانی که نوع مشخص نشده یا ناشناخته است.
TYPE_FIRST_PARTY مخاطبی که از طریق استفاده از داده‌های مشتری ایجاد می‌شود.
TYPE_PARTNER مخاطبی که توسط ارائه دهندگان داده شخص ثالث ارائه می‌شود.

نوع مخاطب

انواع احتمالی مخاطبان.

انوم‌ها
AUDIENCE_TYPE_UNSPECIFIED مقدار پیش‌فرض زمانی که نوع مشخص نشده یا ناشناخته است.
CUSTOMER_MATCH_CONTACT_INFO مخاطبان از طریق تطبیق مشتریان با اطلاعات تماس شناخته شده ایجاد شدند.
CUSTOMER_MATCH_DEVICE_ID مخاطبان از طریق تطبیق مشتریان با شناسه‌های شناخته‌شده‌ی دستگاه‌های تلفن همراه ایجاد شدند.
CUSTOMER_MATCH_USER_ID مخاطبان از طریق تطبیق مشتریان با شناسه‌های کاربری شناخته‌شده ایجاد شدند.
ACTIVITY_BASED

مخاطب بر اساس فعالیت کمپین ایجاد شد.

FREQUENCY_CAP

مخاطب بر اساس حذف تعداد دفعات نمایش تبلیغ ایجاد شد.

TAG_BASED مخاطب بر اساس متغیرهای سفارشی متصل به پیکسل ایجاد شد.
YOUTUBE_USERS مخاطب بر اساس تعاملات گذشته با ویدیوها، تبلیغات یوتیوب یا کانال یوتیوب ایجاد شد.
THIRD_PARTY مجوز استفاده از سوی شخص ثالث به Audience اعطا شده است.
COMMERCE مخاطبانی که توسط شرکای تجاری با پرداخت هزینه ارائه می‌شوند.
LINEAR مخاطب محتوای تلویزیون خطی.
AGENCY مخاطبی که توسط یک آژانس ارائه می‌شود.

منبع مخاطب

منابع احتمالی مخاطبان.

انوم‌ها
AUDIENCE_SOURCE_UNSPECIFIED مقدار پیش‌فرض زمانی که منبع مخاطب مشخص نشده یا ناشناخته است.
DISPLAY_VIDEO_360 برگرفته از Display & Video 360.
CAMPAIGN_MANAGER برگرفته از Campaign Manager 360.
AD_MANAGER از مدیر تبلیغات گوگل سرچشمه گرفته است.
SEARCH_ADS_360 برگرفته از Search Ads 360.
YOUTUBE از یوتیوب سرچشمه گرفته است.
ADS_DATA_HUB برگرفته از مرکز داده‌های تبلیغاتی (Ads Data Hub).

اطلاعات تماس

پیام بسته‌بندی برای فهرستی از اطلاعات تماس که اعضای مخاطب Customer Match را تعریف می‌کند.

نمایش JSON 
{
  "contactInfos": [
    {
      object (ContactInfo)
    }
  ],
  "consent": {
    object (Consent)
  }
}
فیلدها
contactInfos[]

object ( ContactInfo )

فهرستی از اشیاء ContactInfo که اعضای مخاطب Customer Match را تعریف می‌کنند. اندازه اعضا پس از تقسیم contactInfos نباید بیشتر از ۵۰۰۰۰۰ باشد.

consent

object ( Consent )

فقط ورودی. تنظیم رضایت برای کاربران در contactInfos .

تنظیم نکردن این فیلد نشان می‌دهد که رضایت مشخص نشده است.

اگر فیلدهای adUserData یا adPersonalization روی CONSENT_STATUS_DENIED تنظیم شده باشند، درخواست خطا برمی‌گرداند.

اطلاعات تماس

اطلاعات تماس که یک عضو مخاطب Customer Match را تعریف می‌کند.

نمایش 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

کد کشور عضو.

همچنین باید با فیلدهای زیر تنظیم شود:

وضعیت رضایت

وضعیت رضایت.

انوم‌ها
CONSENT_STATUS_UNSPECIFIED مقدار نوع در این نسخه مشخص نشده یا ناشناخته است.
CONSENT_STATUS_GRANTED رضایت داده می‌شود.
CONSENT_STATUS_DENIED رضایت رد می‌شود.

فهرست شناسه‌های دستگاه موبایل

پیام بسته‌بندی برای فهرستی از شناسه‌های دستگاه تلفن همراه که اعضای مخاطب Customer Match را تعریف می‌کنند.

نمایش JSON 
{
  "mobileDeviceIds": [
    string
  ],
  "consent": {
    object (Consent)
  }
}
فیلدها
mobileDeviceIds[]

string

فهرستی از شناسه‌های دستگاه‌های تلفن همراه که اعضای مخاطب Customer Match را تعریف می‌کنند. اندازه mobileDeviceIds نباید بیشتر از ۵۰۰۰۰۰ باشد.

consent

object ( Consent )

فقط ورودی. تنظیم رضایت برای کاربران در mobileDeviceIds .

تنظیم نکردن این فیلد نشان می‌دهد که رضایت مشخص نشده است.

اگر فیلدهای adUserData یا adPersonalization روی CONSENT_STATUS_DENIED تنظیم شده باشند، درخواست خطا برمی‌گرداند.

روش‌ها

create

 یک مخاطب FirstPartyAndPartner ایجاد می‌کند.

editCustomerMatchMembers

 فهرست اعضای مخاطبان Customer Match را به‌روزرسانی می‌کند.

get

 مخاطبِ طرفِ اول یا شریک را جذب می‌کند.

list

 مخاطبان طرف اول و شریک را فهرست می‌کند.

patch

 یک FirstPartyAndPartnerAudience موجود را به‌روزرسانی می‌کند.