احتیاط: شما در حال مشاهده اسناد رابط REST API هستید. اکثر کتابخانه های مشتری رسمی ما از gRPC استفاده می کنند. برای جزئیات بیشتر به مقدمه REST مراجعه کنید.

این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

AdGroup

نمایندگی JSON
AdGroupStatus
AdGroupAdRotationMode
AudienceSetting
- نمایندگی JSON
AdGroupPrimaryStatus
AdGroupPrimaryStatusReason

یک گروه تبلیغاتی

نمایندگی JSON

نمایندگی JSON
{ "resourceName": string, "status": enum (`AdGroupStatus`), "type": enum (`AdGroupType`), "adRotationMode": enum (`AdGroupAdRotationMode`), "urlCustomParameters": [ { object (`CustomParameter`) } ], "optimizedTargetingEnabled": boolean, "displayCustomBidDimension": enum (`TargetingDimension`), "targetingSetting": { object (`TargetingSetting`) }, "audienceSetting": { object (`AudienceSetting`) }, "effectiveTargetCpaSource": enum (`BiddingSource`), "effectiveTargetRoasSource": enum (`BiddingSource`), "labels": [ string ], "excludedParentAssetFieldTypes": [ enum (`AssetFieldType`) ], "excludedParentAssetSetTypes": [ enum (`AssetSetType`) ], "primaryStatus": enum (`AdGroupPrimaryStatus`), "primaryStatusReasons": [ enum (`AdGroupPrimaryStatusReason`) ], "id": string, "name": string, "baseAdGroup": string, "trackingUrlTemplate": string, "campaign": string, "cpcBidMicros": string, "effectiveCpcBidMicros": string, "cpmBidMicros": string, "targetCpaMicros": string, "cpvBidMicros": string, "targetCpmMicros": string, "targetRoas": number, "percentCpcBidMicros": string, "finalUrlSuffix": string, "effectiveTargetCpaMicros": string, "effectiveTargetRoas": number }

{
  "resourceName": string,
  "status": enum (AdGroupStatus),
  "type": enum (AdGroupType),
  "adRotationMode": enum (AdGroupAdRotationMode),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "optimizedTargetingEnabled": boolean,
  "displayCustomBidDimension": enum (TargetingDimension),
  "targetingSetting": {
    object (TargetingSetting)
  },
  "audienceSetting": {
    object (AudienceSetting)
  },
  "effectiveTargetCpaSource": enum (BiddingSource),
  "effectiveTargetRoasSource": enum (BiddingSource),
  "labels": [
    string
  ],
  "excludedParentAssetFieldTypes": [
    enum (AssetFieldType)
  ],
  "excludedParentAssetSetTypes": [
    enum (AssetSetType)
  ],
  "primaryStatus": enum (AdGroupPrimaryStatus),
  "primaryStatusReasons": [
    enum (AdGroupPrimaryStatusReason)
  ],
  "id": string,
  "name": string,
  "baseAdGroup": string,
  "trackingUrlTemplate": string,
  "campaign": string,
  "cpcBidMicros": string,
  "effectiveCpcBidMicros": string,
  "cpmBidMicros": string,
  "targetCpaMicros": string,
  "cpvBidMicros": string,
  "targetCpmMicros": string,
  "targetRoas": number,
  "percentCpcBidMicros": string,
  "finalUrlSuffix": string,
  "effectiveTargetCpaMicros": string,
  "effectiveTargetRoas": number
}

زمینه های
`resourceName`	`string` تغییرناپذیر. نام منبع گروه تبلیغاتی نام منابع گروه تبلیغات به شکل زیر است: `customers/{customerId}/adGroups/{adGroupId}`
`status`	`enum ( AdGroupStatus )` وضعیت گروه تبلیغاتی
`type`	`enum ( AdGroupType )` تغییرناپذیر. نوع گروه تبلیغاتی
`adRotationMode`	`enum ( AdGroupAdRotationMode )` حالت چرخش تبلیغات گروه تبلیغاتی.
`urlCustomParameters[]`	`object ( CustomParameter )` فهرست نگاشت‌هایی که برای جایگزینی برچسب‌های پارامتر سفارشی در `trackingUrlTemplate` ، `finalUrls` یا `mobile_final_urls` استفاده می‌شوند.
`optimizedTargetingEnabled`	`boolean` درست است اگر هدف گذاری بهینه شده فعال باشد. هدف گذاری بهینه جایگزینی برای گسترش مخاطب است.
`displayCustomBidDimension`	`enum ( TargetingDimension )` به تبلیغ‌کنندگان اجازه می‌دهد یک بعد هدف را تعیین کنند تا قیمت‌های مطلق را روی آن قرار دهند. این فقط برای کمپین هایی قابل اجرا است که فقط شبکه نمایش را هدف قرار می دهند و جستجو نمی کنند.
`targetingSetting`	`object ( TargetingSetting )` تنظیم برای هدف قرار دادن ویژگی های مرتبط.
`audienceSetting`	`object ( AudienceSetting )` تغییرناپذیر. تنظیم برای ویژگی های مرتبط با مخاطب
`effectiveTargetCpaSource`	`enum ( BiddingSource )` فقط خروجی منبع CPA هدف موثر. این فیلد فقط خواندنی است.
`effectiveTargetRoasSource`	`enum ( BiddingSource )` فقط خروجی منبع ROAS هدف موثر. این فیلد فقط خواندنی است.
`labels[]`	`string` فقط خروجی نام منابع برچسب های پیوست شده به این گروه تبلیغاتی.
`excludedParentAssetFieldTypes[]`	`enum ( AssetFieldType )` انواع فیلد دارایی که باید از این گروه تبلیغاتی حذف شوند. پیوندهای دارایی با این نوع فیلدها توسط این گروه تبلیغاتی از سطوح بالا به ارث نمی رسد.
`excludedParentAssetSetTypes[]`	`enum ( AssetSetType )` انواع مجموعه دارایی که باید از این گروه تبلیغاتی حذف شوند. پیوندهای مجموعه دارایی با این انواع توسط این گروه تبلیغاتی از سطوح بالا به ارث نمی رسد. انواع گروه مکان (GMB_DYNAMIC_LOCATION_GROUP، CHAIN_DYNAMIC_LOCATION_GROUP، و STATIC_LOCATION_GROUP) انواع فرزند LOCATION_SYNC هستند. بنابراین، اگر LOCATION_SYNC برای این فیلد تنظیم شده باشد، همه مجموعه‌های دارایی گروه مکان مجاز به پیوند به این گروه تبلیغاتی نیستند و همه برنامه‌های افزودنی موقعیت مکانی (LE) و برنامه‌های افزودنی مکان وابسته (ALE) تحت این گروه تبلیغاتی ارائه نمی‌شوند. در حال حاضر فقط LOCATION_SYNC پشتیبانی می شود.
`primaryStatus`	`enum ( AdGroupPrimaryStatus )` فقط خروجی نمای کلی در مورد اینکه چرا یک گروه تبلیغاتی به طور بهینه ارائه نمی شود یا ارائه نمی دهد، ارائه می دهد.
`primaryStatusReasons[]`	`enum ( AdGroupPrimaryStatusReason )` فقط خروجی دلایلی برای عدم ارائه یا عدم ارائه بهینه یک گروه تبلیغاتی ارائه می دهد.
`id`	`string ( int64 format)` فقط خروجی شناسه گروه تبلیغاتی
`name`	`string` نام گروه تبلیغاتی این قسمت الزامی است و نباید هنگام ایجاد گروه های تبلیغاتی جدید خالی باشد. باید کمتر از 255 نویسه تمام عرض UTF-8 داشته باشد. نباید دارای هیچ نویسه تهی (نقطه کد 0x0)، خوراک خط NL (نقطه کد 0xA) یا نویسه برگشتی (نقطه کد 0xD) باشد.
`baseAdGroup`	`string` فقط خروجی برای گروه‌های آگهی پیش‌نویس یا آزمایشی، این فیلد نام منبع گروه آگهی پایه است که این گروه آگهی از آن ایجاد شده است. اگر یک گروه تبلیغاتی پیش‌نویس یا آزمایشی، گروه تبلیغاتی پایه نداشته باشد، این قسمت خالی است. برای گروه های تبلیغاتی پایه، این فیلد برابر با نام منبع گروه تبلیغات است. این فیلد فقط خواندنی است.
`trackingUrlTemplate`	`string` الگوی URL برای ساخت URL ردیابی.
`campaign`	`string` تغییرناپذیر. کمپینی که گروه تبلیغاتی به آن تعلق دارد.
`cpcBidMicros`	`string ( int64 format)` حداکثر پیشنهاد CPC (هزینه به ازای هر کلیک).
`effectiveCpcBidMicros`	`string ( int64 format)` فقط خروجی زمانی که استراتژی مناقصه یکی از CPC دستی، cpc افزایش یافته، صفحه اول ارتقا یافته یا سهم بالاتر از هدف باشد، با ارزش پیشنهادی CPC (هزینه به ازای هر کلیک) یکسان خواهد بود، در غیر این صورت ارزش صفر خواهد بود.
`cpmBidMicros`	`string ( int64 format)` حداکثر پیشنهاد CPM (هزینه به ازای هر هزار نمایش قابل مشاهده).
`targetCpaMicros`	`string ( int64 format)` CPA هدف (هزینه هر خرید). اگر استراتژی مناقصه کمپین گروه تبلیغاتی TargetCpa یا MaximizeConversions باشد (با فیلد targetCpa آن)، این فیلد بر CPA هدف مشخص شده در استراتژی مناقصه کمپین لغو می شود. در غیر این صورت، این مقدار نادیده گرفته می شود.
`cpvBidMicros`	`string ( int64 format)` پیشنهاد CPV (هزینه به ازای هر بازدید).
`targetCpmMicros`	`string ( int64 format)` مبلغ متوسط بر حسب میکرو که تبلیغ کننده حاضر است برای هر هزار بار نمایش تبلیغ بپردازد.
`targetRoas`	`number` نادیده گرفتن ROAS هدف (بازده در هزینه تبلیغات). اگر استراتژی مناقصه کمپین گروه تبلیغاتی TargetRoas یا MaximizeConversionValue باشد (با فیلد targetRoas آن)، این فیلد بر ROAS هدف مشخص شده در استراتژی مناقصه کمپین لغو می‌شود. در غیر این صورت، این مقدار نادیده گرفته می شود.
`percentCpcBidMicros`	`string ( int64 format)` مبلغ پیشنهادی درصد بر ارزش افزوده، که به عنوان کسری از قیمت اعلام شده برای برخی کالاها یا خدمات بیان می شود. محدوده معتبر برای کسری [0،1) است و مقدار ذخیره شده در اینجا 1,000,000 * [کسری] است.
`finalUrlSuffix`	`string` الگوی URL برای الحاق پارامترها به URL نهایی.
`effectiveTargetCpaMicros`	`string ( int64 format)` فقط خروجی CPA هدف موثر (هزینه به ازای هر خرید). این فیلد فقط خواندنی است.
`effectiveTargetRoas`	`number` فقط خروجی ROAS هدف موثر (بازده در هزینه تبلیغات). این فیلد فقط خواندنی است.

AdGroupStatus

وضعیت های احتمالی یک گروه تبلیغاتی

Enums
`UNSPECIFIED`	وضعیت مشخص نشده است.
`UNKNOWN`	مقدار دریافتی در این نسخه مشخص نیست. این یک مقدار فقط پاسخگویی است.
`ENABLED`	گروه تبلیغات فعال است.
`PAUSED`	گروه تبلیغات متوقف شده است.
`REMOVED`	گروه تبلیغات حذف می شود.

AdGroupAdRotationMode

حالت های احتمالی چرخش تبلیغات یک گروه تبلیغاتی.

Enums
`UNSPECIFIED`	حالت چرخش تبلیغات مشخص نشده است.
`UNKNOWN`	مقدار دریافتی در این نسخه مشخص نیست. این یک مقدار فقط پاسخگویی است.
`OPTIMIZE`	تبلیغات گروه تبلیغات را بر اساس کلیک یا تبدیل بهینه کنید.
`ROTATE_FOREVER`	برای همیشه یکنواخت بچرخانید.

AudienceSetting

تنظیمات برای هدف گیری مخاطب

نمایندگی JSON
{ "useAudienceGrouped": boolean }

زمینه های

زمینه های
`useAudienceGrouped`	`boolean` تغییرناپذیر. اگر درست باشد، این گروه تبلیغاتی از یک منبع مخاطب برای هدف‌یابی مخاطبان استفاده می‌کند. اگر نادرست باشد، این گروه تبلیغاتی ممکن است به جای آن از معیارهای بخش مخاطب استفاده کند.

useAudienceGrouped

boolean

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

AdGroupPrimaryStatus

وضعیت های ممکن یک AdGroup.

Enums
`UNSPECIFIED`	مشخص نشده است.
`UNKNOWN`	فقط برای مقدار برگشتی استفاده می شود. نشان دهنده مقدار ناشناخته در این نسخه است.
`ELIGIBLE`	گروه تبلیغاتی واجد شرایط ارائه خدمات است.
`PAUSED`	گروه تبلیغات متوقف شده است.
`REMOVED`	گروه تبلیغات حذف می شود.
`PENDING`	گروه تبلیغاتی ممکن است در آینده ارائه شود.
`NOT_ELIGIBLE`	گروه تبلیغاتی واجد شرایط ارائه خدمات نیست.
`LIMITED`	گروه تبلیغاتی قابلیت سرویس دهی محدودی دارد.

AdGroupPrimaryStatusReason

دلایل احتمالی وضعیت گروه تبلیغاتی

Enums
`UNSPECIFIED`	مشخص نشده است.
`UNKNOWN`	فقط برای مقدار برگشتی استفاده می شود. نشان دهنده مقدار ناشناخته در این نسخه است.
`CAMPAIGN_REMOVED`	وضعیت کمپین مشخص شده توسط کاربر حذف شده است. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`CAMPAIGN_PAUSED`	وضعیت کمپین مشخص شده توسط کاربر متوقف شده است. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`CAMPAIGN_PENDING`	زمان مشخص شده توسط کاربر برای شروع این کمپین در آینده است. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند
`CAMPAIGN_ENDED`	زمان مشخص شده توسط کاربر برای پایان این کمپین گذشته است. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`AD_GROUP_PAUSED`	وضعیت گروه آگهی مشخص شده توسط کاربر متوقف شده است. به AdGroupPrimaryStatus.PAUSED کمک می کند.
`AD_GROUP_REMOVED`	وضعیت گروه آگهی مشخص شده توسط کاربر حذف می شود. به AdGroupPrimaryStatus.REMOVED کمک می کند.
`AD_GROUP_INCOMPLETE`	ساخت این گروه تبلیغاتی هنوز کامل نشده است. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`KEYWORDS_PAUSED`	وضعیت‌های کلمه کلیدی مشخص شده توسط کاربر در این گروه تبلیغاتی همگی متوقف شده‌اند. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`NO_KEYWORDS`	هیچ کلمه کلیدی واجد شرایطی در این گروه تبلیغاتی وجود ندارد. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`AD_GROUP_ADS_PAUSED`	وضعیت های تبلیغات گروه تبلیغاتی مشخص شده توسط کاربر در این گروه تبلیغاتی همگی متوقف شده اند. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`NO_AD_GROUP_ADS`	هیچ آگهی گروه آگهی واجد شرایطی در این گروه تبلیغاتی وجود ندارد. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`HAS_ADS_DISAPPROVED`	دلیل وضعیت خط‌مشی زمانی که حداقل یک آگهی تأیید نشده است. به چند AdGroupPrimaryStatus کمک می کند.
`HAS_ADS_LIMITED_BY_POLICY`	دلیل وضعیت خط‌مشی زمانی که حداقل یک تبلیغ توسط خط‌مشی محدود شده باشد. به چند AdGroupPrimaryStatus کمک می کند.
`MOST_ADS_UNDER_REVIEW`	دلیل وضعیت خط‌مشی زمانی که اکثر تبلیغات در انتظار بررسی هستند. به AdGroupPrimaryStatus.PENDING کمک می کند.
`CAMPAIGN_DRAFT`	AdGroup متعلق به یک کمپین پیش نویس است. به AdGroupPrimaryStatus.NOT_ELIGIBLE کمک می کند.
`AD_GROUP_PAUSED_DUE_TO_LOW_ACTIVITY`	گروه آگهی به دلیل فعالیت کم طولانی مدت در ارائه، موقتاً متوقف شده است. به AdGroupPrimaryStatus.PAUSED کمک می کند.