REST Resource: advertisers

منبع: تبلیغ‌کننده

یک تبلیغ‌کننده در Display & Video 360‏ (DV360).

نمایش JSON
{
  "name": string,
  "advertiserId": string,
  "partnerId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "generalConfig": {
    object (AdvertiserGeneralConfig)
  },
  "adServerConfig": {
    object (AdvertiserAdServerConfig)
  },
  "creativeConfig": {
    object (AdvertiserCreativeConfig)
  },
  "dataAccessConfig": {
    object (AdvertiserDataAccessConfig)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "servingConfig": {
    object (AdvertiserTargetingConfig)
  },
  "prismaEnabled": boolean,
  "billingConfig": {
    object (AdvertiserBillingConfig)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus),
  "defaultBusinessName": string,
  "defaultLogoAssetId": string
}
فیلدها
name

string

فقط خروجی. نام منبع تبلیغ‌کننده.

advertiserId

string (int64 format)

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

partnerId

string (int64 format)

الزامی. تغییرناپذیر. شناسه یکتای شریکی که تبلیغ‌کننده به آن تعلق دارد.

displayName

string

الزامی. نام نمایشی تبلیغ‌کننده.

باید با UTF-8 کدبندی شده باشد و حداکثر اندازه آن ۲۴۰ بایت باشد.

entityStatus

enum (EntityStatus)

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

  • مقادیر پذیرفتنی ENTITY_STATUS_ACTIVE، ENTITY_STATUS_PAUSED، و ENTITY_STATUS_SCHEDULED_FOR_DELETION است.
  • اگر روی ENTITY_STATUS_SCHEDULED_FOR_DELETION تنظیم شود، تبلیغ‌کننده ۳۰ روز پس‌از اولین‌باری که برای حذف زمان‌بندی شده است حذف خواهد شد.
updateTime

string (Timestamp format)

فقط خروجی. مُهر زمان آخرین به‌روزرسانی تبلیغ‌کننده. توسط سیستم اختصاص داده شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌شده است و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".

generalConfig

object (AdvertiserGeneralConfig)

الزامی. تنظیمات کلی آگهی‌دهنده.

adServerConfig

object (AdvertiserAdServerConfig)

الزامی. تغییرناپذیر. تنظیمات مربوط به سرور آگهی آگهی‌دهنده.

creativeConfig

object (AdvertiserCreativeConfig)

الزامی. تنظیمات مربوط به طرح‌آگهی آگهی‌دهنده.

dataAccessConfig

object (AdvertiserDataAccessConfig)

تنظیماتی که نحوه دسترسی به داده‌های تبلیغ‌کننده را کنترل می‌کنند.

integrationDetails

object (IntegrationDetails)

جزئیات یکپارچه‌سازی آگهی‌دهنده. درحال‌حاضر فقط integrationCode برای تبلیغ‌کننده قابل‌اجرا است. فیلدهای دیگر IntegrationDetails پشتیبانی نمی‌شود و درصورت ارائه نادیده گرفته خواهد شد.

servingConfig

object (AdvertiserTargetingConfig)

تنظیمات هدف‌یابی مربوط به ارائه آگهی تبلیغ‌کننده.

prismaEnabled

boolean

اینکه ادغام با Mediaocean (Prisma) فعال است یا نه. درصورت فعال کردن این قابلیت، با موارد زیر موافقت می‌کنید:

ازطرف شرکتم، به Mediaocean (Prisma) اجازه می‌دهم طرح‌های بخش بودجه را به Google ارسال کند، و به Google اجازه می‌دهم گزارش‌ها و صورت‌حساب‌های مربوطه را از DV360 به Mediaocean ارسال کند تا برای برنامه‌ریزی بودجه، صدور صورت‌حساب، و تطبیق برای این تبلیغ‌کننده استفاده شود.

billingConfig

object (AdvertiserBillingConfig)

الزامی. تنظیمات مربوط به صورت‌حساب تبلیغ‌کننده.

containsEuPoliticalAds

enum (EuPoliticalAdvertisingStatus)

اختیاری. اینکه آیا این تبلیغ‌کننده شامل ردیف‌های سفارشی است که آگهی‌های سیاسی اتحادیه اروپا را ارائه می‌دهند یا نه.

اگر این فیلد روی DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING تنظیم شده باشد، موارد زیر اتفاق می‌افتد:

  • هر مورد خطی جدیدی که تحت این آگهی‌دهنده ایجاد شود، به DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING اختصاص داده خواهد شد، مگر اینکه به‌طور دیگری مشخص شده باشد.
  • هرکدام از موارد خطی موجود تحت این آگهی‌دهنده که مقدار تنظیم‌شده‌ای ندارند ظرف یک روز به DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING به‌روزرسانی می‌شوند.
defaultBusinessName

string

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

این مقداری است که YouTube و آگهی‌های «تولید تقاضا» تحت این تبلیغ‌کننده درصورت ارائه نشدن نام کسب‌وکار استفاده می‌کنند.

defaultLogoAssetId

string (int64 format)

اختیاری. شناسه دارایی تصویر نشان‌واره پیش‌فرض برای تبلیغ‌کننده.

این شناسه دارایی است که اگر دارایی نشان‌واره ارائه نشود، توسط آگهی‌های YouTube و Demand تحت این تبلیغ‌کننده استفاده خواهد شد.

برای بارگذاری این دارایی بااستفاده از میانای برنامه‌سازی کاربردی، باید از advertisers.adAssets.upload استفاده کنید.

AdvertiserGeneralConfig

تنظیمات کلی آگهی‌دهنده.

نمایش JSON
{
  "domainUrl": string,
  "timeZone": string,
  "currencyCode": string
}
فیلدها
domainUrl

string

الزامی. نشانی وب دامنه وب‌سایت اصلی تبلیغ‌کننده. سیستم این اطلاعات را به ناشرانی ارسال می‌کند که برای مرتبط کردن پویش با آگهی‌دهنده به نشانی وب‌سایت نیاز دارند.

نشانی وبی بدون مسیر یا رشته پُرسمان ارائه کنید که با http: یا https: شروع می‌شود. برای مثال، http://www.example.com

timeZone

string

فقط خروجی. نام پایگاه داده TZ استاندارد منطقه زمانی تبلیغ‌کننده. به‌عنوان مثال، America/New_York.

برای اطلاعات بیشتر، به این نشانی مراجعه کنید: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

برای آگهی‌دهندگان ترکیبی CM360، منطقه زمانی همان منطقه زمانی حساب CM360 مرتبط است؛ برای آگهی‌دهندگان فقط طرف سوم، منطقه زمانی همان منطقه زمانی شریک اصلی است.

currencyCode

string

الزامی. تغییرناپذیر. واحد پول تبلیغ‌کننده در قالب ISO 4217.

کدهای پذیرفته‌شده و واحدهای پولی که نشان می‌دهند عبارت‌اند از:

کد ارز : نام ارز

  • ARS : پزوی آرژانتین
  • AUD : دلار استرالیا
  • BRL : رئال برزیل
  • CAD : دلار کانادا
  • CHF : فرانک سوئیس
  • CLP : پزوی شیلی
  • CNY : یوآن چین
  • COP : پزوی کلمبیا
  • CZK : کرونای چک
  • DKK : کرون دانمارک
  • EGP : پوند مصر
  • EUR : یورو
  • GBP : پوند بریتانیا
  • HKD : دلار هنگ‌کنگ
  • HUF : فورینت مجارستان
  • IDR : روپیه اندونزی
  • ILS : شِکِل اسرائیل
  • INR : روپیه هند
  • ‫JPY : ین ژاپن
  • KRW : وون کره جنوبی
  • MXN : پزوی مکزیک
  • MYR : رینگیت مالزی
  • NGN : نایرای نیجریه
  • NOK : کرون نروژ
  • NZD : دلار نیوزیلند
  • PEN : سول جدید پرو
  • PLN : زلوتی لهستان
  • RON : لئوی جدید رومانی
  • RUB : روبل روسیه
  • SEK : کرون سوئد
  • TRY : لیره ترکیه
  • TWD : دلار جدید تایوان
  • USD : دلار امریکا
  • ZAR : راند افریقای جنوبی

AdvertiserAdServerConfig

تنظیمات مربوط به سرور آگهی تبلیغ‌کننده.

نمایش JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of mutually exclusive fields.
}
فیلدها
الزامی. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
thirdPartyOnlyConfig

object (ThirdPartyOnlyConfig)

پیکربندی برای تبلیغ‌کنندگانی که فقط از سرورهای آگهی طرف سوم استفاده می‌کنند.

cmHybridConfig

object (CmHybridConfig)

پیکربندی برای آگهی‌دهندگانی که هم از Campaign Manager 360 (CM360) و هم از سرورهای آگهی طرف سوم استفاده می‌کنند.

پایان فیلدهای متقابلاً انحصاری.

ThirdPartyOnlyConfig

تنظیمات برای تبلیغ‌کنندگانی که فقط از سرورهای آگهی طرف سوم استفاده می‌کنند.

نمایش JSON
{
  "pixelOrderIdReportingEnabled": boolean
}
فیلدها
pixelOrderIdReportingEnabled

boolean

اینکه گزارش شناسه سفارش برای پیکسل‌ها فعال است یا نه. این مقدار را پس‌از تنظیم روی true نمی‌توان تغییر داد.

CmHybridConfig

تنظیمات برای تبلیغ‌کنندگانی که هم از Campaign Manager 360 (CM360) و هم از سرورهای آگهی شخص ثالث استفاده می‌کنند.

نمایش JSON
{
  "cmAccountId": string,
  "cmFloodlightConfigId": string,
  "cmAdvertiserIds": [
    string
  ],
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
فیلدها
cmAccountId

string (int64 format)

الزامی. تغییرناپذیر. شناسه حساب پیکربندی CM360 Floodlight پیوندشده با آگهی‌دهنده DV360.

cmFloodlightConfigId

string (int64 format)

الزامی. تغییرناپذیر. شناسه پیکربندی CM360 Floodlight پیوندشده با آگهی‌دهنده DV360.

cmAdvertiserIds[]

string (int64 format)

فقط خروجی. مجموعه «شناسه‌های آگهی‌دهنده CM360» که پیکربندی «نورافکن CM360» را هم‌رسانی می‌کنند.

cmSyncableSiteIds[]

string (int64 format)

فهرستی از سایت‌های CM360 که جای آگهی‌های آن‌ها به‌عنوان طرح‌آگهی با DV360 همگام‌سازی خواهد شد.

اگر در روش advertisers.create وجود نداشته باشد یا خالی باشد، سیستم به‌طور خودکار سایت CM360 ایجاد خواهد کرد.

برداشتن سایت‌ها از این فهرست ممکن است باعث شود طرح‌آگهی‌های DV360 همگام‌سازی‌شده از CM360 حذف شوند. حداقل یک سایت باید مشخص شود.

dv360ToCmDataSharingEnabled

boolean

اینکه داده‌های DV360 در گزارش‌های انتقال داده CM360 گنجانده شود یا نه.

dv360ToCmCostReportingEnabled

boolean

اینکه هزینه DV360 به CM360 گزارش شود یا نه.

cmFloodlightLinkingAuthorized

boolean

الزامی. تغییرناپذیر. با تنظیم این فیلد روی true، شما ازطرف شرکتتان هم‌رسانی اطلاعات از پیکربندی Floodlight داده‌شده به این تبلیغ‌کننده Display & Video 360 را مجاز می‌کنید.

AdvertiserCreativeConfig

تنظیمات مربوط به طرح‌آگهی‌های تبلیغ‌کننده.

نمایش JSON
{
  "iasClientId": string,
  "obaComplianceDisabled": boolean,
  "dynamicCreativeEnabled": boolean,
  "videoCreativeDataSharingAuthorized": boolean
}
فیلدها
iasClientId

string (int64 format)

شناسه‌ای برای پیکربندی پایش پویش که Integral Ad Service (IAS) ارائه کرده است. سیستم DV360 برچسب «پایشگر پویش» IAS حاوی این شناسه را به برچسب طرح‌آگهی اضافه خواهد کرد.

obaComplianceDisabled

boolean

غیرفعال کردن یا نکردن ویژگی «درباره این آگهی» Google که نشان (برای شناسایی محتوا به‌عنوان آگهی) و اطلاعات شفاف‌سازی (در تعامل با «درباره این آگهی») را به آگهی‌های شما برای «تبلیغات رفتاری آنلاین» (OBA) و الزامات نظارتی اضافه می‌کند. «درباره این آگهی» به کاربران کنترل بیشتری بر آگهی‌هایی که می‌بینند می‌دهد و به شما کمک می‌کند توضیح دهید چرا آگهی شما را می‌بینند. بیشتر بدانید.

اگر تصمیم بگیرید این فیلد را روی true تنظیم کنید، توجه داشته باشید که آگهی‌های ارائه‌شده ازطریق Display & Video 360 باید از موارد زیر تبعیت کنند:

  • مطابق با قراردادتان با «پلاتفرم بازاریابی Google»، از «تبلیغات رفتاری آنلاین» (OBA) تبعیت کنید.
  • در منطقه اقتصادی اروپا (EEA)، اطلاعات شفاف‌سازی و سازوکاری برای کاربران جهت گزارش محتوای غیرقانونی در آگهی‌ها ارائه دهید. اگر از راهکار جایگزین برای نشان‌گذاری، شفاف‌سازی، و گزارش‌دهی آگهی استفاده می‌کنید، باید مطمئن شوید که این راهکار حاوی اطلاعات شفاف‌سازی لازم و سازوکار پرچم‌گذاری محتوای غیرقانونی باشد و هرگونه گزارش محتوای غیرقانونی را بااستفاده از فرم مناسب به Google اطلاع دهید.
dynamicCreativeEnabled

boolean

آیا تبلیغ‌کننده برای طرح‌آگهی‌های پویا فعال است یا نه.

videoCreativeDataSharingAuthorized

boolean

با تنظیم این فیلد روی true، شما ازطرف شرکتتان به Google اجازه می‌دهید از طرح‌های آگهی ویدیویی مرتبط با این تبلیغ‌کننده Display & Video 360 برای ارائه گزارش و ویژگی‌های مربوط به پویش‌های تلویزیونی تبلیغ‌کننده استفاده کند.

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

AdvertiserDataAccessConfig

تنظیماتی که نحوه دسترسی به داده‌های مرتبط با آگهی‌دهنده را کنترل می‌کنند.

نمایش JSON
{
  "sdfConfig": {
    object (AdvertiserSdfConfig)
  }
}
فیلدها
sdfConfig

object (AdvertiserSdfConfig)

تنظیمات «فایل‌های داده ساخت‌یافته» (SDF) برای آگهی‌دهنده.

اگر مشخص نشده باشد، از تنظیمات SDF شریک اصلی استفاده می‌شود.

AdvertiserSdfConfig

تنظیمات «فایل‌های داده ساخت‌یافته» (SDF) آگهی‌دهنده.

نمایش JSON
{
  "overridePartnerSdfConfig": boolean,
  "sdfConfig": {
    object (SdfConfig)
  }
}
فیلدها
overridePartnerSdfConfig

boolean

اینکه این تبلیغ‌کننده پیکربندی SDF شریک اصلی خود را لغو می‌کند یا نه.

به‌طور پیش‌فرض، آگهی‌دهنده پیکربندی SDF را از شریک اصلی به‌ارث می‌برد. برای لغو پیکربندی شریک، این فیلد را روی true تنظیم کنید و پیکربندی جدید را در sdfConfig ارائه دهید.

sdfConfig

object (SdfConfig)

پیکربندی SDF برای تبلیغ‌کننده.

AdvertiserTargetingConfig

تنظیمات هدف‌یابی مربوط به ارائه آگهی یک آگهی‌دهنده.

نمایش JSON
{
  "exemptTvFromViewabilityTargeting": boolean
}
فیلدها
exemptTvFromViewabilityTargeting

boolean

اینکه دستگاه‌های تلویزیون اینترنت‌پذیر از هدف‌یابی رؤیت‌پذیری برای همه موارد خطی ویدیو تحت آگهی‌دهنده معاف هستند یا نه.

AdvertiserBillingConfig

تنظیمات مربوط به صورت‌حساب تبلیغ‌کننده.

نمایش JSON
{
  "billingProfileId": string
}
فیلدها
billingProfileId

string (int64 format)

الزامی. شناسه نمایه صورت‌حساب اختصاص‌داده‌شده به آگهی‌دهنده.

روش‌ها

audit

آگهی‌دهنده را ممیزی می‌کند.

create

تبلیغ‌کننده جدیدی ایجاد می‌کند.

delete

تبلیغ‌کننده‌ای را حذف می‌کند.

editAssignedTargetingOptions

گزینه‌های هدف‌یابی را تحت یک تبلیغ‌کننده ویرایش می‌کند.

get

آگهی‌دهنده‌ای را دریافت می‌کند.

list

آگهی‌دهندگانی را که برای کاربر کنونی قابل‌دسترسی هستند فهرست می‌کند.

listAssignedTargetingOptions

گزینه‌های هدف‌یابی اختصاص‌داده‌شده تبلیغ‌کننده را در انواع هدف‌یابی فهرست می‌کند.

patch

تبلیغ‌کننده موجود را به‌روز می‌کند.