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)

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

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

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

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

displayDesktopAudienceSize

string ( int64 format)

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

اگر اندازه کمتر از 1000 باشد، به دلایل حفظ حریم خصوصی، عدد پنهان می شود و 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

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

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

نوع مخاطب

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

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 ایجاد شد.
THIRD_PARTY مخاطب برای استفاده از شخص ثالث مجوز گرفته است.
COMMERCE مخاطبین توسط شرکای تجاری با هزینه ای ارائه می شود.
LINEAR مخاطب برای محتوای تلویزیونی خطی.

منبع مخاطب

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

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 نشات گرفته از یوتیوب.
ADS_DATA_HUB نشات گرفته از Ads Data Hub.

ContactInfoList

پیام Wrapper برای لیستی از اطلاعات تماس که اعضای مخاطبان مطابقت مشتری را تعریف می کند.

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

object ( ContactInfo )

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

consent

object ( Consent )

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

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

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

اطلاعات تماس

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

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

کد کشور عضو

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

وضعیت رضایت

وضعیت رضایت

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

MobileDeviceIdList

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

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

string

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

consent

object ( Consent )

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

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

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

روش ها

create

 یک FirstPartyAndPartnerAudience ایجاد می کند.

editCustomerMatchMembers

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

get

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

list

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

patch

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