Package google.ads.searchads360.v0.resources

string

نام منبع استراتژی مناقصه قابل دسترس. نام‌های منابع AccessibleBiddingStrategy به شکل زیر هستند:

customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}

int64

شناسه استراتژی پیشنهاد قیمت.

string

نام استراتژی مناقصه.

BiddingStrategyType

نوع استراتژی مناقصه.

int64

شناسه مشتری که مالک استراتژی پیشنهاد قیمت است.

string

نام_توصیفی مشتری که مالک استراتژی پیشنهاد قیمت است.

MaximizeConversionValue

یک استراتژی پیشنهاد قیمت خودکار برای کمک به کسب بیشترین ارزش تبدیل برای کمپین‌های شما در عین صرفه‌جویی در بودجه‌تان.

MaximizeConversions

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

TargetCpa

یک استراتژی پیشنهاد قیمت که پیشنهادها را طوری تنظیم می‌کند که به شما کمک کند تا با توجه به هزینه به ازای هر جذب (CPA) هدفی که تعیین کرده‌اید، تا حد امکان تبدیل‌های بیشتری داشته باشید.

TargetImpressionShare

یک استراتژی پیشنهاد قیمت که به طور خودکار درصد مشخصی از نمایش‌ها را بهینه می‌کند.

TargetRoas

یک استراتژی پیشنهاد قیمت که به شما کمک می‌کند تا درآمد خود را به حداکثر برسانید و در عین حال میانگینی از بازگشت هزینه تبلیغات (ROAS) هدف خاص را به دست آورید.

TargetSpend

یک استراتژی پیشنهاد قیمت که پیشنهادهای شما را طوری تنظیم می‌کند که به شما کمک کند تا حد امکان کلیک‌های بیشتری را در محدوده بودجه خود دریافت کنید.

double

گزینه بازگشت سرمایه هدف از هزینه تبلیغات (ROAS). در صورت تنظیم، استراتژی پیشنهاد، درآمد را به حداکثر می‌رساند و در عین حال میانگین بازگشت سرمایه هدف از هزینه تبلیغات را محاسبه می‌کند. اگر ROAS هدف بالا باشد، استراتژی پیشنهاد ممکن است نتواند کل بودجه را خرج کند. اگر ROAS هدف تعیین نشده باشد، استراتژی پیشنهاد با هدف دستیابی به بالاترین ROAS ممکن برای بودجه خواهد بود.

int64

گزینه هزینه هدف برای هر جذب (CPA). این میانگین مبلغی است که مایلید برای هر جذب هزینه کنید.

int64

گزینه هزینه هدف برای هر جذب (CPA). این میانگین مبلغی است که مایلید برای هر جذب هزینه کنید.

int64

میانگین هدف CPA. این هدف باید بزرگتر یا مساوی حداقل واحد قابل پرداخت بر اساس ارز حساب باشد.

TargetImpressionShareLocation

مکان مورد نظر در صفحه نتایج جستجو.

int64

کسر انتخاب‌شده از تبلیغات که باید در مکان مورد نظر نمایش داده شوند (به میکرومتر). برای مثال، ۱٪ برابر با ۱۰۰۰۰ است.

int64

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

double

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

int64

هدف هزینه‌ای که تحت آن می‌توان کلیک‌ها را به حداکثر رساند. پیشنهاددهنده‌ی TargetSpend سعی می‌کند کمترین مقدار از این مقدار یا مقدار هزینه‌ی طبیعیِ محدودکننده را هزینه کند. در صورت عدم مشخص شدن، از بودجه به عنوان هدف هزینه استفاده می‌شود. این فیلد منسوخ شده است و دیگر نباید استفاده شود. برای جزئیات بیشتر به https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html مراجعه کنید.

int64

حداکثر محدودیت پیشنهاد قیمت که می‌تواند توسط استراتژی پیشنهاد قیمت تعیین شود. این محدودیت برای همه کلمات کلیدی مدیریت شده توسط استراتژی اعمال می‌شود.

string

نام منبع تبلیغ. نام منابع تبلیغ به شکل زیر است:

customers/{customer_id}/ads/{ad_id}

string

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

FinalAppUrl

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

string

فهرست URL های نهایی موبایل ممکن پس از همه ریدایرکت‌های بین دامنه‌ای برای تبلیغ.

AdType

نوع تبلیغ.

int64

شناسه آگهی.

string

الگوی URL برای ساخت یک URL ردیابی.

string

پسوندی که هنگام ساخت URL نهایی استفاده می‌شود.

string

نشانی اینترنتی (URL) که در توضیحات تبلیغ برای برخی از قالب‌های تبلیغ نمایش داده می‌شود.

string

نام تبلیغ. این فقط برای شناسایی تبلیغ استفاده می‌شود. نیازی به منحصر به فرد بودن ندارد و بر تبلیغ نمایش داده شده تأثیری نمی‌گذارد.

SearchAds360TextAdInfo

جزئیات مربوط به آگهی متنی

SearchAds360ExpandedTextAdInfo

جزئیات مربوط به یک تبلیغ متنی گسترش‌یافته.

SearchAds360ResponsiveSearchAdInfo

جزئیات مربوط به یک تبلیغ جستجوی واکنش‌گرا.

SearchAds360ProductAdInfo

جزئیات مربوط به تبلیغ محصول.

SearchAds360ExpandedDynamicSearchAdInfo

جزئیات مربوط به یک تبلیغ جستجوی پویای توسعه‌یافته.

string

نام منبع گروه تبلیغاتی. نام منابع گروه تبلیغاتی به شکل زیر است:

customers/{customer_id}/adGroups/{ad_group_id}

AdGroupStatus

وضعیت گروه تبلیغاتی.

AdGroupType

نوع گروه تبلیغاتی.

AdGroupAdRotationMode

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

string

مهر زمانی که این گروه تبلیغاتی ایجاد شده است. مهر زمانی در منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss" است.

TargetingSetting

تنظیم برای هدف قرار دادن ویژگی‌های مرتبط.

string

نام منابع برچسب‌های پیوست شده به این گروه تبلیغاتی.

string

نام منابع برچسب‌های مؤثر متصل به این گروه تبلیغاتی. یک برچسب مؤثر، برچسبی است که به ارث رسیده یا مستقیماً به این گروه تبلیغاتی اختصاص داده شده است.

string

شناسه گروه تبلیغاتی در حساب موتور خارجی. این فیلد فقط برای حساب‌های غیر گوگل ادز است، برای مثال، یاهو ژاپن، مایکروسافت، بایدو و غیره. برای موجودیت گوگل ادز، به جای آن از "ad_group.id" استفاده کنید.

string

تاریخی که این گروه تبلیغاتی شروع به ارائه تبلیغات می‌کند. به طور پیش‌فرض، گروه تبلیغاتی اکنون یا تاریخ شروع گروه تبلیغاتی، هر کدام که دیرتر باشد، شروع می‌شود. اگر این فیلد تنظیم شود، گروه تبلیغاتی در ابتدای تاریخ مشخص شده در منطقه زمانی مشتری شروع می‌شود. این فیلد فقط برای حساب‌های Microsoft Advertising و Facebook gateway در دسترس است.

قالب: YYYY-MM-DD مثال: 2019-03-14

string

تاریخ پایان نمایش تبلیغات در گروه تبلیغاتی. به طور پیش‌فرض، گروه تبلیغاتی در تاریخ پایان گروه تبلیغاتی به پایان می‌رسد. اگر این فیلد تنظیم شود، گروه تبلیغاتی در پایان تاریخ مشخص شده در منطقه زمانی مشتری پایان می‌یابد. این فیلد فقط برای حساب‌های Microsoft Advertising و Facebook gateway در دسترس است.

قالب: YYYY-MM-DD مثال: 2019-03-14

string

زبان تبلیغات و کلمات کلیدی در یک گروه تبلیغاتی. این فیلد فقط برای حساب‌های تبلیغاتی مایکروسافت در دسترس است. جزئیات بیشتر: https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage

string

تاریخ و زمان آخرین باری که این گروه تبلیغاتی تغییر کرده است. تاریخ و زمان بر اساس منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss.ssssss" است.

int64

شناسه گروه تبلیغاتی.

string

نام گروه تبلیغاتی.

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

باید شامل کمتر از ۲۵۵ کاراکتر UTF-8 با عرض کامل باشد.

نباید حاوی هیچ کاراکتر تهی (کد نقطه 0x0)، تغذیه خط NL (کد نقطه 0xA) یا بازگشت به ابتدای سطر (کد نقطه 0xD) باشد.

string

الگوی URL برای ساخت یک URL ردیابی.

int64

حداکثر پیشنهاد CPC (هزینه به ازای هر کلیک).

AdGroupEngineStatus

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

string

الگوی URL برای افزودن پارامترها به URL نهایی.

string

نام منبع تبلیغ. نام منابع تبلیغاتی گروه تبلیغاتی به شکل زیر است:

customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}

AdGroupAdStatus

وضعیت آگهی.

Ad

آگهی.

string

مهر زمانی که این ad_group_ad ایجاد شده است. تاریخ و زمان بر اساس منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss.ssssss" است.

string

نام منابع برچسب‌های پیوست شده به این تبلیغ گروه تبلیغاتی.

string

نام منابع برچسب‌های مؤثر پیوست شده به این آگهی. برچسب مؤثر، برچسبی است که به ارث رسیده یا مستقیماً به این آگهی اختصاص داده شده است.

string

شناسه تبلیغ در حساب موتور خارجی. این فیلد فقط برای حساب تبلیغات جستجو ۳۶۰ است، برای مثال، یاهو ژاپن، مایکروسافت، بایدو و غیره. برای موجودیت‌های غیر از تبلیغات جستجو ۳۶۰، به جای آن از "ad_group_ad.ad.id" استفاده کنید.

AdGroupAdEngineStatus

وضعیت اضافی تبلیغ در حساب موتور خارجی. وضعیت‌های ممکن (بسته به نوع حساب خارجی) شامل فعال، واجد شرایط، در انتظار بررسی و غیره می‌شود.

string

تاریخ و زمان آخرین باری که این آگهی گروه تبلیغاتی اصلاح شده است. تاریخ و زمان بر اساس منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss.ssssss" است.

string

نام منبع برچسب مؤثر برای گروه تبلیغاتی. نام‌های منبع برچسب مؤثر برای گروه تبلیغاتی به شکل زیر است: customers/{owner_customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id}~{label_id}

string

گروه تبلیغاتی که برچسب مؤثر به آن متصل است.

string

برچسب مؤثری که به تبلیغ گروه تبلیغاتی اختصاص داده شده است.

int64

شناسه مشتری که مالک برچسب مؤثر است.

string

نام منبع برچسب تبلیغاتی گروه تبلیغاتی. نام‌های منبع برچسب تبلیغاتی گروه تبلیغاتی به این شکل هستند: customers/{owner_customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}

string

گروه تبلیغاتی که برچسب به آن متصل است.

string

برچسبی که به تبلیغ گروه تبلیغاتی اختصاص داده شده است.

int64

شناسه مشتری که مالک برچسب است.

string

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

customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}

string

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

string

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

AssetLinkStatus

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

string

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

customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}

string

گروه تبلیغاتی که این مجموعه دارایی به آن متصل است.

string

مجموعه دارایی که به گروه تبلیغاتی مرتبط است.

AssetSetLinkStatus

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

string

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

customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}

string

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

customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}

double

اصلاح‌کننده‌ی پیشنهاد زمانی که معیار مطابقت داشته باشد. اصلاح‌کننده باید در محدوده‌ی: 0.1 - 10.0 باشد. محدوده برای PreferredContent 1.0 - 6.0 است. برای انصراف از نوع دستگاه از 0 استفاده کنید.

DeviceInfo

معیار دستگاه.

string

نام منبع معیار گروه تبلیغاتی. نام منابع معیار گروه تبلیغاتی به شکل زیر است:

customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}

string

معیار زمان ایجاد این گروه تبلیغاتی. این زمان بر اساس منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss" است.

AdGroupCriterionStatus

وضعیت معیار.

این وضعیت موجودیت معیار گروه تبلیغاتی است که توسط مشتری تنظیم شده است. توجه: گزارش‌های رابط کاربری ممکن است شامل اطلاعات اضافی باشند که بر واجد شرایط بودن یک معیار برای اجرا تأثیر می‌گذارند. در برخی موارد، معیاری که در API حذف شده است، همچنان می‌تواند در رابط کاربری به عنوان فعال نشان داده شود. به عنوان مثال، کمپین‌ها به طور پیش‌فرض برای کاربران در تمام محدوده‌های سنی نمایش داده می‌شوند، مگر اینکه مستثنی شوند. رابط کاربری هر محدوده سنی را به عنوان "فعال" نشان می‌دهد، زیرا آنها واجد شرایط دیدن تبلیغات هستند. اما AdGroupCriterion.status "حذف شده" را نشان می‌دهد، زیرا هیچ معیار مثبتی اضافه نشده است.

QualityInfo

اطلاعات مربوط به کیفیت معیار.

CriterionType

نوع معیار.

string

نام منابع برچسب‌های پیوست شده به این معیار گروه تبلیغاتی.

string

نام منابع برچسب‌های مؤثر متصل به این معیار گروه تبلیغاتی. یک برچسب مؤثر، برچسبی است که به ارث رسیده یا مستقیماً به این معیار گروه تبلیغاتی اختصاص داده شده است.

PositionEstimates

تخمین‌ها برای پیشنهادهای معیار در موقعیت‌های مختلف.

string

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

string

فهرست URL های نهایی موبایل ممکن پس از همه ریدایرکت‌های بین دامنه‌ای.

CustomParameter

فهرست نگاشت‌های مورد استفاده برای جایگزینی تگ‌های پارامتر سفارشی در tracking_url_template ، final_urls یا mobile_final_urls .

string

شناسه معیار گروه تبلیغاتی در حساب موتور خارجی. این فیلد فقط برای حساب‌های غیر گوگل ادز است، برای مثال، یاهو ژاپن، مایکروسافت، بایدو و غیره. برای موجودیت گوگل ادز، به جای آن از "ad_group_criterion.criterion_id" استفاده کنید.

string

تاریخ و زمان آخرین باری که معیار این گروه تبلیغاتی تغییر کرده است. تاریخ و زمان بر اساس منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss.ssssss" است.

int64

شناسه معیار.

string

گروه تبلیغاتی که معیار به آن تعلق دارد.

bool

اینکه آیا معیار را هدف قرار دهیم ( false ) یا آن را حذف کنیم ( true ).

این فیلد تغییرناپذیر است. برای تغییر یک معیار از مثبت به منفی، آن را حذف و سپس دوباره اضافه کنید.

double

اصلاح‌کننده برای پیشنهاد زمانی که معیار مطابقت دارد. اصلاح‌کننده باید در محدوده 0.1 تا 10.0 باشد. اکثر انواع معیارهای قابل هدف‌گیری از اصلاح‌کننده‌ها پشتیبانی می‌کنند.

int64

پیشنهاد CPC (هزینه به ازای هر کلیک).

int64

پیشنهاد قیمت مؤثر CPC (هزینه به ازای هر کلیک).

AdGroupCriterionEngineStatus

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

string

الگوی URL برای افزودن پارامترها به URL نهایی.

string

الگوی URL برای ساخت یک URL ردیابی.

KeywordInfo

کلمه کلیدی.

ListingGroupInfo

گروه فهرست‌بندی.

AgeRangeInfo

محدوده سنی.

GenderInfo

جنسیت.

UserListInfo

فهرست کاربران.

WebpageInfo

صفحه وب

LocationInfo

مکان.

int64

تخمین هزینه هر کلیک (CPC) مورد نیاز برای نمایش تبلیغ در بالای صفحه اول نتایج جستجو.

int32

امتیاز کیفیت.

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

string

نام منبع برچسب مؤثر معیار گروه تبلیغاتی. نام‌های منبع برچسب مؤثر معیار گروه تبلیغاتی به شکل زیر هستند: customers/{owner_customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~{criterion_id}~{label_id}

string

معیار گروه تبلیغاتی که برچسب مؤثر به آن متصل است.

string

برچسب مؤثر اختصاص داده شده به معیار گروه تبلیغاتی.

int64

شناسه مشتری که مالک برچسب مؤثر است.

string

نام منبع برچسب معیار گروه تبلیغاتی. نام‌های منابع برچسب معیار گروه تبلیغاتی به شکل زیر هستند: customers/{owner_customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}

string

معیار گروه تبلیغاتی که برچسب به آن متصل است.

string

برچسبی که به معیار گروه تبلیغاتی اختصاص داده شده است.

int64

شناسه مشتری که مالک برچسب است.

string

نام منبع برچسب مؤثر گروه تبلیغاتی. نام‌های منبع برچسب مؤثر گروه تبلیغاتی به شکل زیر هستند: customers/{owner_customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}

string

گروه تبلیغاتی که برچسب مؤثر به آن متصل است.

string

برچسب مؤثری که به گروه تبلیغاتی اختصاص داده شده است.

int64

شناسه مشتری که مالک برچسب مؤثر است.

string

نام منبع برچسب گروه تبلیغاتی. نام‌های منبع برچسب گروه تبلیغاتی به این شکل هستند: customers/{owner_customer_id}/adGroupLabels/{ad_group_id}~{label_id}

string

گروه تبلیغاتی که برچسب به آن متصل است.

string

برچسبی که به گروه تبلیغاتی اختصاص داده شده است.

int64

شناسه مشتری که مالک برچسب است.

string

نام منبع نمای محدوده سنی. نام منابع نمای محدوده سنی به شکل زیر است:

customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}

string

نام منبع دارایی. نام منابع دارایی به شکل زیر است:

customers/{customer_id}/assets/{asset_id}

AssetType

نوع دارایی.

string

فهرستی از آدرس‌های اینترنتی نهایی ممکن پس از همه ریدایرکت‌های بین دامنه‌ای.

string

فهرستی از URL های نهایی موبایل ممکن پس از همه ریدایرکت‌های بین دامنه‌ای.

CustomParameter

فهرستی از نگاشت‌هایی که برای جایگزینی تگ‌های پارامتر سفارشی URL در tracking_url_template، final_urls و/یا final_mobile_urls استفاده می‌شوند.

AssetStatus

وضعیت دارایی.

string

مهر زمانی که این دارایی ایجاد شده است. مهر زمانی در منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss" است.

string

تاریخ و زمان آخرین باری که این دارایی تغییر کرده است. تاریخ و زمان بر اساس منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss.ssssss" است.

int64

شناسه دارایی.

string

نام اختیاری دارایی.

string

الگوی URL برای ساخت یک URL ردیابی.

string

الگوی URL برای افزودن پارامترها به URL های صفحه فرود که با ردیابی موازی ارائه می‌شوند.

AssetEngineStatus

وضعیت موتور برای یک دارایی.

YoutubeVideoAsset

یک فایل ویدیویی یوتیوب.

ImageAsset

یک دارایی تصویری.

TextAsset

یک دارایی متنی.

UnifiedCalloutAsset

یک دارایی فراخوان یکپارچه.

UnifiedSitelinkAsset

یک دارایی یکپارچه برای لینک‌های سایت.

UnifiedPageFeedAsset

یک منبع فید صفحه یکپارچه.

MobileAppAsset

یک دارایی اپلیکیشن موبایل.

UnifiedCallAsset

یک دارایی تماس یکپارچه.

CallToActionAsset

یک ابزار فراخوان برای اقدام.

UnifiedLocationAsset

یک دارایی مکانی یکپارچه.

string

نام منبع گروه دارایی. نام منابع گروه دارایی به شکل زیر است:

customers/{customer_id}/assetGroups/{asset_group_id}

int64

شناسه گروه دارایی.

string

کمپینی که این گروه دارایی با آن مرتبط است. دارایی که به گروه دارایی مرتبط است.

string

الزامی. نام گروه دارایی. الزامی. حداقل طول آن ۱ و حداکثر طول آن ۱۲۸ باشد. باید در هر کمپین منحصر به فرد باشد.

string

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

string

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

AssetGroupStatus

وضعیت گروه دارایی‌ها

string

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

string

بخش دوم متنی که ممکن است به آدرس اینترنتی نمایش داده شده در تبلیغ اضافه شود. این فیلد فقط زمانی قابل تنظیم است که path1 تنظیم شده باشد.

AdStrength

قدرت کلی تبلیغات این گروه دارایی.

string

نام منبع دارایی گروه دارایی. نام منبع دارایی گروه دارایی به شکل زیر است:

customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}

string

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

string

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

AssetFieldType

شرح جایگاه محتوا در گروه محتوا. برای مثال: HEADLINE، YOUTUBE_VIDEO و غیره.

AssetLinkStatus

وضعیت ارتباط بین یک دارایی و گروه دارایی.

AssetUsage

دارایی‌های ارائه شده.

string

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

customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}

string

گروه دارایی که این فیلتر فهرست گروه دارایی بخشی از آن است.

int64

شناسه‌ی فیلتر ListingGroup.

ListingGroupFilterType

نوع گره فیلتر گروه فهرست‌بندی.

ListingGroupFilterVertical

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

ListingGroupFilterDimension

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

string

نام منبع زیرمجموعه گروه فهرست والد. برای گره فیلتر گروه فهرست ریشه، مقدار null است.

ListingGroupFilterDimensionPath

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

string

نام منبع سیگنال گروه دارایی. نام منبع سیگنال گروه دارایی به شکل زیر است:

customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}

string

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

AudienceInfo

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

string

نام منبع نمای ترکیبی بالای گروه دارایی. نام منابع نمای ترکیبی بالای گروه دارایی به شکل زیر است: `"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}"

AssetGroupAssetCombinationData

برترین ترکیب‌های دارایی‌هایی که با هم خدمت کرده‌اند.

int64

شناسه مجموعه دارایی.

string

نام منبع مجموعه دارایی. نام منابع مجموعه دارایی به شکل زیر است:

customers/{customer_id}/assetSets/{asset_set_id}

string

نام منبعِ مجموعه دارایی. نام‌های منابع داراییِ مجموعه دارایی به شکل زیر هستند:

customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}

string

مجموعه دارایی که این مجموعه دارایی به آن پیوند دارد.

string

دارایی که این مجموعه دارایی به آن لینک می‌دهد.

AssetSetAssetStatus

وضعیت مجموعه دارایی. فقط خواندنی.

string

نام منبع مخاطب. نام‌های مخاطب به این شکل هستند:

customers/{customer_id}/audiences/{audience_id}

int64

شناسنامه مخاطب.

string

الزامی. نام مخاطب. باید در بین همه مخاطبان منحصر به فرد باشد. حداقل طول آن ۱ و حداکثر طول آن ۲۵۵ باشد.

string

توصیف این مخاطب.

string

نام منبع استراتژی پیشنهاد قیمت. نام منابع استراتژی پیشنهاد قیمت به شکل زیر است:

customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

BiddingStrategyStatus

وضعیت استراتژی مناقصه.

این فیلد فقط خواندنی است.

BiddingStrategyType

نوع استراتژی پیشنهاد قیمت. با تنظیم طرح پیشنهاد قیمت، یک استراتژی پیشنهاد قیمت ایجاد کنید.

این فیلد فقط خواندنی است.

string

واحد پول مورد استفاده در استراتژی پیشنهاد قیمت (کد سه حرفی ISO 4217).

برای استراتژی‌های پیشنهاد قیمت در مشتریان مدیر، این واحد پول می‌تواند هنگام ایجاد تنظیم شود و به طور پیش‌فرض روی واحد پول مشتری مدیر تنظیم شود. برای مشتریان خدمت‌رسان، این فیلد قابل تنظیم نیست؛ همه استراتژی‌ها در یک مشتری خدمت‌رسان به طور ضمنی از واحد پول مشتری خدمت‌رسان استفاده می‌کنند. در همه موارد، فیلد effective_currency_code واحد پول مورد استفاده توسط استراتژی را برمی‌گرداند.

int64

شناسه استراتژی پیشنهاد قیمت.

string

نام استراتژی پیشنهاد قیمت. تمام استراتژی‌های پیشنهاد قیمت در یک حساب باید به طور مجزا نامگذاری شوند.

طول این رشته باید بین ۱ تا ۲۵۵، شامل، بر حسب بایت‌های UTF-8 (برش داده شده) باشد.

string

واحد پول مورد استفاده در استراتژی پیشنهاد قیمت (کد سه حرفی ISO 4217).

برای استراتژی‌های پیشنهاد قیمت در مشتریان مدیر، این واحد پولی است که توسط تبلیغ‌کننده هنگام ایجاد استراتژی تعیین می‌شود. برای مشتریان خدماتی، این کد_ارز مشتری است.

معیارهای استراتژی پیشنهاد قیمت با این واحد پول گزارش می‌شوند.

این فیلد فقط خواندنی است.

int64

تعداد کمپین‌های مرتبط با این استراتژی پیشنهاد قیمت.

این فیلد فقط خواندنی است.

int64

تعداد کمپین‌های حذف نشده متصل به این استراتژی پیشنهاد قیمت.

این فیلد فقط خواندنی است.

EnhancedCpc

یک استراتژی پیشنهاد قیمت که پیشنهادها را برای کلیک‌هایی که به نظر می‌رسد احتمال بیشتری برای تبدیل شدن به مشتری دارند، افزایش می‌دهد و برای کلیک‌هایی که احتمال کمتری دارند، آنها را کاهش می‌دهد.

MaximizeConversionValue

یک استراتژی پیشنهاد قیمت خودکار برای کمک به کسب بیشترین ارزش تبدیل برای کمپین‌های شما در عین صرفه‌جویی در بودجه‌تان.

MaximizeConversions

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

TargetCpa

یک استراتژی پیشنهاد قیمت که پیشنهادها را طوری تنظیم می‌کند که به شما کمک کند تا با توجه به هزینه به ازای هر جذب (CPA) هدفی که تعیین کرده‌اید، تا حد امکان تبدیل‌های بیشتری داشته باشید.

TargetImpressionShare

یک استراتژی پیشنهاد قیمت که به طور خودکار درصد مشخصی از نمایش‌ها را بهینه می‌کند.

TargetOutrankShare

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

TargetRoas

یک استراتژی پیشنهاد قیمت که به شما کمک می‌کند تا درآمد خود را به حداکثر برسانید و در عین حال میانگینی از بازگشت هزینه تبلیغات (ROAS) هدف خاص را به دست آورید.

TargetSpend

یک استراتژی پیشنهاد قیمت که پیشنهادهای شما را طوری تنظیم می‌کند که به شما کمک کند تا حد امکان کلیک‌های بیشتری را در محدوده بودجه خود دریافت کنید.

string

نام منبع کمپین. نام منابع کمپین به شکل زیر است:

customers/{customer_id}/campaigns/{campaign_id}

CampaignStatus

وضعیت کمپین.

وقتی یک کمپین جدید اضافه می‌شود، وضعیت به صورت پیش‌فرض روی فعال (ENABLED) قرار می‌گیرد.

CampaignServingStatus

وضعیت نمایش تبلیغات در کمپین.

BiddingStrategySystemStatus

وضعیت سیستم استراتژی پیشنهاد قیمت کمپین.

AdServingOptimizationStatus

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

AdvertisingChannelType

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

این فیلد الزامی است و هنگام ایجاد کمپین‌های جدید نباید خالی باشد.

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

AdvertisingChannelSubType

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

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

CustomParameter

فهرست نگاشت‌های مورد استفاده برای جایگزینی تگ‌های پارامتر سفارشی در tracking_url_template ، final_urls یا mobile_final_urls .

RealTimeBiddingSetting

تنظیمات مربوط به پیشنهاد قیمت آنی، قابلیتی که فقط برای کمپین‌هایی که شبکه‌ی تبادل تبلیغات (Ad Exchange) را هدف قرار می‌دهند، در دسترس است.

NetworkSettings

تنظیمات شبکه برای کمپین.

DynamicSearchAdsSetting

تنظیمات مربوط به کنترل تبلیغات جستجوی پویا (DSA).

ShoppingSetting

تنظیمات مربوط به کنترل کمپین‌های خرید.

GeoTargetTypeSetting

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

string

نام منابع برچسب‌های مؤثر متصل به این کمپین. یک برچسب مؤثر، برچسبی است که به ارث رسیده یا مستقیماً به این کمپین اختصاص داده شده است.

string

نام منابع برچسب‌های پیوست شده به این کمپین.

BiddingStrategyType

نوع استراتژی پیشنهاد قیمت.

یک استراتژی پیشنهاد قیمت را می‌توان با تنظیم طرح پیشنهاد قیمت برای ایجاد یک استراتژی پیشنهاد قیمت استاندارد یا با تنظیم فیلد bidding_strategy برای ایجاد یک استراتژی پیشنهاد قیمت سبد سهام ایجاد کرد.

این فیلد فقط خواندنی است.

string

نام منبع AccessibleBiddingStrategy، یک نمای فقط خواندنی از ویژگی‌های نامحدود استراتژی پیشنهاد سبد سهام پیوست شده که با 'bidding_strategy' مشخص شده است. خالی، اگر کمپین از یک استراتژی سبد سهام استفاده نمی‌کند. ویژگی‌های استراتژی نامحدود برای همه مشتریانی که استراتژی با آنها به اشتراک گذاشته شده است در دسترس است و از منبع AccessibleBiddingStrategy خوانده می‌شوند. در مقابل، ویژگی‌های محدود فقط برای مشتری مالک استراتژی و مدیران آنها در دسترس است. ویژگی‌های محدود فقط از منبع BiddingStrategy قابل خواندن هستند.

FrequencyCapEntry

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

SelectiveOptimization

تنظیمات بهینه‌سازی انتخابی برای این کمپین، که شامل مجموعه‌ای از اقدامات تبدیل برای بهینه‌سازی این کمپین است. این ویژگی فقط برای کمپین‌های اپلیکیشنی اعمال می‌شود که از MULTI_CHANNEL به عنوان AdvertisingChannelType و APP_CAMPAIGN یا APP_CAMPAIGN_FOR_ENGAGEMENT به عنوان AdvertisingChannelSubType استفاده می‌کنند.

OptimizationGoalSetting

تعیین هدف بهینه‌سازی برای این کمپین، که شامل مجموعه‌ای از انواع اهداف بهینه‌سازی است.

TrackingSetting

تنظیمات سطح کمپین برای ردیابی اطلاعات.

string

شناسه کمپین در حساب موتور خارجی. این فیلد فقط برای حساب‌های غیر گوگل ادز است، برای مثال، یاهو ژاپن، مایکروسافت، بایدو و غیره. برای موجودیت گوگل ادز، به جای آن از "campaign.id" استفاده کنید.

AssetFieldType

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

string

مهر زمانی که این کمپین ایجاد شده است. مهر زمانی در منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss" است. create_time در نسخه ۱ منسوخ خواهد شد. به جای آن از creation_time استفاده کنید.

string

مهر زمانی که این کمپین ایجاد شده است. مهر زمانی در منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss" است.

string

تاریخ و زمان آخرین باری که این کمپین اصلاح شده است. تاریخ و زمان بر اساس منطقه زمانی مشتری و با فرمت "yyyy-MM-dd HH:mm:ss.ssssss" است.

AssetSetType

انواع فیدهایی که مستقیماً به این کمپین پیوست شده‌اند.

int64

شناسه کمپین.

string

نام کمپین.

این فیلد الزامی است و هنگام ایجاد کمپین‌های جدید نباید خالی باشد.

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

string

The URL template for constructing a tracking URL.

string

The resource name of the campaign budget of the campaign.

string

The date when campaign started in serving customer's timezone in YYYY-MM-DD format.

string

The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.

string

Suffix used to append query parameters to landing pages that are served with parallel tracking.

bool

Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.

string

The resource name of the portfolio bidding strategy used by the campaign.

ManualCpa

Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.

ManualCpc

Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.

ManualCpm

Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.

MaximizeConversions

Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.

MaximizeConversionValue

Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.

TargetCpa

Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

TargetImpressionShare

Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.

TargetRoas

Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).

TargetSpend

Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.

PercentCpc

Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.

TargetCpm

A bidding strategy that automatically optimizes cost per thousand impressions.

string

Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".

string

Required. The language code specifying the language of the domain, for example, "en".

bool

Whether the campaign uses advertiser supplied URLs exclusively.

PositiveGeoTargetType

The setting used for positive geotargeting in this particular campaign.

NegativeGeoTargetType

The setting used for negative geotargeting in this particular campaign.

bool

Whether ads will be served with google.com search results.

bool

Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true ).

bool

Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.

bool

Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.

OptimizationGoalType

The list of optimization goal types.

string

The selected set of resource names for conversion actions for optimizing this campaign.

string

Feed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.

bool

Whether to target Vehicle Listing inventory.

int64

ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.

string

Sales country of products to include in the campaign.

int32

Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.

bool

Whether to include local products.

string

The url used for dynamic tracking.

string

The resource name of the campaign asset. CampaignAsset resource names have the form:

customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}

AssetLinkStatus

Status of the campaign asset.

string

The campaign to which the asset is linked.

string

The asset which is linked to the campaign.

string

The resource name of the campaign asset set. Asset set asset resource names have the form:

customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}

string

The campaign to which this asset set is linked.

string

The asset set which is linked to the campaign.

AssetSetLinkStatus

The status of the campaign asset set asset. Read-only.

string

The resource name of the campaign audience view. Campaign audience view resource names have the form:

customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}

string

The resource name of the campaign budget. Campaign budget resource names have the form:

customers/{customer_id}/campaignBudgets/{campaign_budget_id}

BudgetDeliveryMethod

The delivery method that determines the rate at which the campaign budget is spent.

Defaults to STANDARD if unspecified in a create operation.

BudgetPeriod

Period over which to spend the budget. Defaults to DAILY if not specified.

int64

The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.

string

The resource name of the campaign criterion. Campaign criterion resource names have the form:

customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}

string

The display name of the criterion.

This field is ignored for mutates.

CriterionType

The type of the criterion.

CampaignCriterionStatus

The status of the criterion.

string

The datetime when this campaign criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

int64

The ID of the criterion.

This field is ignored during mutate.

float

The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.

bool

Whether to target ( false ) or exclude ( true ) the criterion.

KeywordInfo

Keyword.

LocationInfo

Location.

DeviceInfo

Device.

AgeRangeInfo

Age range.

GenderInfo

Gender.

UserListInfo

User List.

LanguageInfo

زبان.

WebpageInfo

Webpage.

LocationGroupInfo

Location Group

string

Name of the resource. CampaignEffectivelabel resource names have the form: customers/{owner_customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}

string

The campaign to which the effective label is attached.

string

The effective label assigned to the campaign.

int64

The ID of the Customer which owns the effective label.

string

Name of the resource. Campaign label resource names have the form: customers/{owner_customer_id}/campaignLabels/{campaign_id}~{label_id}

string

The campaign to which the label is attached.

string

The label assigned to the campaign.

int64

The ID of the Customer which owns the label.

string

The resource name of the Cart data sales view. Cart data sales view resource names have the form: customers/{customer_id}/cartDataSalesView

string

The resource name of the conversion. Conversion resource names have the form:

customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}

int64

The ID of the conversion

int64

Search Ads 360 criterion ID. A value of 0 indicates that the criterion is unattributed.

int64

The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.

int64

Ad ID. A value of 0 indicates that the ad is unattributed.

string

A unique string, for the visit that the conversion is attributed to, that is passed to the landing page as the click id URL parameter.

int64

The Search Ads 360 visit ID that the conversion is attributed to.

string

For offline conversions, this is an ID provided by advertisers. If an advertiser doesn't specify such an ID, Search Ads 360 generates one. For online conversions, this is equal to the id column or the floodlight_order_id column depending on the advertiser's Floodlight instructions.

string

The ID of the product clicked on.

ProductChannel

The sales channel of the product that was clicked on: Online or Local.

string

The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.

string

The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.

string

The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on.

AttributionType

What the conversion is attributed to: Visit or Keyword+Ad.

string

The timestamp of the conversion event.

string

The timestamp of the last time the conversion was modified.

string

The timestamp of the visit that the conversion is attributed to.

int64

The quantity of items recorded by the conversion, as determined by the qty url parameter. The advertiser is responsible for dynamically populating the parameter (such as number of items sold in the conversion), otherwise it defaults to 1.

int64

The adjusted revenue in micros for the conversion event. This will always be in the currency of the serving account.

int64

The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications.

string

The Floodlight order ID provided by the advertiser for the conversion.

ConversionStatus

The status of the conversion, either ENABLED or REMOVED..

int64

ID of the asset which was interacted with during the conversion event.

AssetFieldType

Asset field type of the conversion event.

string

The resource name of the conversion action. Conversion action resource names have the form:

customers/{customer_id}/conversionActions/{conversion_action_id}

string

Timestamp of the Floodlight activity's creation, formatted in ISO 8601.

ConversionActionStatus

The status of this conversion action for conversion event accrual.

ConversionActionType

The type of this conversion action.

ConversionActionCategory

The category of conversions reported for this conversion action.

ValueSettings

Settings related to the value for conversion events associated with this conversion action.

AttributionModelSettings

Settings related to this conversion action's attribution model.

FloodlightSettings

Floodlight settings for Floodlight conversion types.

int64

The ID of the conversion action.

string

The name of the conversion action.

This field is required and should not be empty when creating new conversion actions.

bool

If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.

string

The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.

bool

Whether this conversion action should be included in the "client_account_conversions" metric.

bool

Whether this conversion action should be included in the "conversions" metric.

int64

The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.

string

App ID for an app conversion action.

AttributionModel

The attribution model type of this conversion action.

DataDrivenModelStatus

The status of the data-driven attribution model for the conversion action.

string

String used to identify a Floodlight activity group when reporting conversions.

string

String used to identify a Floodlight activity when reporting conversions.

int64

ID of the Floodlight activity in DoubleClick Campaign Manager (DCM).

double

The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.

string

The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.

bool

Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.

string

The resource name of the conversion custom variable. Conversion custom variable resource names have the form:

customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}

int64

The ID of the conversion custom variable.

string

Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.

string

Required. The tag of the conversion custom variable. Tag should be unique and consist of a "u" character directly followed with a number less than ormequal to 100. For example: "u4".

ConversionCustomVariableStatus

The status of the conversion custom variable for conversion event accrual.

string

The resource name of the customer that owns the conversion custom variable.

ConversionCustomVariableFamily

Family of the conversion custom variable.

ConversionCustomVariableCardinality

Cardinality of the conversion custom variable.

FloodlightConversionCustomVariableInfo

Fields for Search Ads 360 floodlight conversion custom variables.

int64

The IDs of custom columns that use this conversion custom variable.

FloodlightVariableType

Floodlight variable type defined in Search Ads 360.

FloodlightVariableDataType

Floodlight variable data type defined in Search Ads 360.

bool

Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 .

ConversionTrackingStatus

Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request.

bool

Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.

string

The resource name of the customer where conversions are created and managed. This field is read-only.

int64

The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.

int64

The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.

int64

The conversion tracking id of the customer's manager. This is set when the customer is opted into cross-account conversion tracking, and it overrides conversion_tracking_id.

string

The resource name of the custom column. Custom column resource names have the form:

customers/{customer_id}/customColumns/{custom_column_id}

int64

ID of the custom column.

string

User-defined name of the custom column.

string

User-defined description of the custom column.

CustomColumnValueType

The type of the result value of the custom column.

bool

True when the custom column is referring to one or more attributes.

bool

True when the custom column is referring to one or more metrics.

bool

True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.

string

The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.

CustomColumnRenderType

How the result value of the custom column should be interpreted.

string

The resource name of the customer. Customer resource names have the form:

customers/{customer_id}

ConversionTrackingSetting

Conversion tracking setting for a customer.

AccountType

Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc.

DoubleClickCampaignManagerSetting

DoubleClick Campaign Manager (DCM) setting for a manager customer.

AccountStatus

Account status, for example, Enabled, Paused, Removed, etc.

string

The datetime when this customer was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

string

ID of the account in the external engine account.

CustomerStatus

The status of the customer.

string

The timestamp when this customer was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

int64

The customer ID of the manager. A 0 value indicates that the customer has no SA360 manager.

string

The descriptive name of the manager.

int64

The customer ID of the sub manager. A 0 value indicates that the customer has no sub SA360 manager.

string

The descriptive name of the sub manager.

int64

The customer ID of the associate manager. A 0 value indicates that the customer has no SA360 associate manager.

string

The descriptive name of the associate manager.

AccountLevelType

The account level of the customer: Manager, Sub-manager, Associate manager, Service account.

int64

The ID of the customer.

string

Optional, non-unique descriptive name of the customer.

string

The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.

string

The local timezone ID of the customer.

string

The URL template for constructing a tracking URL out of parameters.

string

The URL template for appending params to the final URL.

bool

Whether auto-tagging is enabled for the customer.

bool

Whether the customer is a manager.

string

The resource name of the customer asset. CustomerAsset resource names have the form:

customers/{customer_id}/customerAssets/{asset_id}~{field_type}

string

Required. The asset which is linked to the customer.

AssetLinkStatus

Status of the customer asset.

string

The resource name of the customer asset set. Asset set asset resource names have the form:

customers/{customer_id}/customerAssetSets/{asset_set_id}

string

The asset set which is linked to the customer.

string

The customer to which this asset set is linked.

AssetSetLinkStatus

The status of the customer asset set asset. Read-only.

string

The resource name of the customer client. CustomerClient resource names have the form: customers/{customer_id}/customerClients/{client_customer_id}

string

The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form:

customers/{customer_id}/labels/{label_id}

CustomerStatus

The status of the client customer. Read only.

string

The resource name of the client-customer which is linked to the given customer. Read only.

bool

Specifies whether this is a hidden account.

فقط خواندنی.

int64

Distance between given customer and client. For self link, the level value will be 0. Read only.

string

Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.

bool

Identifies if the client is a test account. Read only.

bool

Identifies if the client is a manager. Read only.

string

Descriptive name for the client. Read only.

string

Currency code (for example, 'USD', 'EUR') for the client. Read only.

int64

The ID of the client customer. Read only.

string

Name of the resource. CustomerManagerLink resource names have the form: customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}

ManagerLinkStatus

Status of the link between the customer and the manager.

string

The manager customer linked to the customer.

int64

ID of the customer-manager link. This field is read only.

string

The timestamp when the CustomerManagerLink was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

int64

ID of the Campaign Manager advertiser associated with this customer.

int64

ID of the Campaign Manager network associated with this customer.

string

Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York.

string

The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form:

customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}

string

The dynamically selected landing page URL of the impression.

This field is read-only.

string

The resource name of the gender view. Gender view resource names have the form:

customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}

string

The resource name of the geo target constant. Geo target constant resource names have the form:

geoTargetConstants/{geo_target_constant_id}

GeoTargetConstantStatus

Geo target constant status.

int64

The ID of the geo target constant.

string

Geo target constant English name.

string

The ISO-3166-1 alpha-2 country code that is associated with the target.

string

Geo target constant target type.

string

The fully qualified English name, consisting of the target's name and that of its parent and country.

string

The resource name of the parent geo target constant. Geo target constant resource names have the form:

geoTargetConstants/{parent_geo_target_constant_id}

string

The resource name of the keyword view. Keyword view resource names have the form:

customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}

string

Name of the resource. Label resource names have the form: customers/{owner_customer_id}/labels/{label_id}

LabelStatus

Status of the label. Read only.

TextLabel

A type of label displaying text on a colored background.

int64

ID of the label. Read only.

string

The name of the label.

This field is required and should not be empty when creating a new label.

The length of this string should be between 1 and 80, inclusive.

string

The resource name of the language constant. Language constant resource names have the form:

languageConstants/{criterion_id}

int64

The ID of the language constant.

string

The language code, for example, "en_US", "en_AU", "es", "fr", etc.

string

The full name of the language in English, for example, "English (US)", "Spanish", etc.

bool

Whether the language is targetable.

ProductBiddingCategory

Bidding category of a product offer.

ProductBrand

Brand of a product offer.

ProductChannel

Locality of a product offer.

ProductCondition

Condition of a product offer.

ProductCustomAttribute

Custom attribute of a product offer.

ProductItemId

Item id of a product offer.

ProductType

Type of a product offer.

ListingGroupFilterBiddingCategoryLevel

Indicates the level of the category in the taxonomy.

int64

ID of the product bidding category.

This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436

string

String value of the product brand.

ListingGroupFilterProductChannel

Value of the locality.

ListingGroupFilterProductCondition

Value of the condition.

ListingGroupFilterCustomAttributeIndex

Indicates the index of the custom attribute.

string

String value of the product custom attribute.

string

Value of the id.

ListingGroupFilterProductTypeLevel

Level of the type.

string

Value of the type.

ListingGroupFilterDimension

The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.

string

The resource name of the location view. Location view resource names have the form:

customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}

string

The resource name of the product bidding category. Product bidding category resource names have the form:

productBiddingCategoryConstants/{country_code}~{level}~{id}

ProductBiddingCategoryLevel

Level of the product bidding category.

ProductBiddingCategoryStatus

Status of the product bidding category.

int64

ID of the product bidding category.

This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436 .

string

Two-letter upper-case country code of the product bidding category.

string

Resource name of the parent product bidding category.

string

Language code of the product bidding category.

string

Display value of the product bidding category localized according to language_code.

string

The resource name of the product group view. Product group view resource names have the form:

customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}

string

The resource name of the artifact. Artifact resource names have the form:

SearchAds360Fields/{name}

SearchAds360FieldCategory

The category of the artifact.

string

The names of all resources, segments, and metrics that are selectable with the described artifact.

string

The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries.

This field is only set for artifacts whose category is RESOURCE.

string

This field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

string

This field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

string

Values the artifact can assume if it is a field of type ENUM.

This field is only set for artifacts of category SEGMENT or ATTRIBUTE.

SearchAds360FieldDataType

This field determines the operators that can be used with the artifact in WHERE clauses.

string

The name of the artifact.

bool

Whether the artifact can be used in a SELECT clause in search queries.

bool

Whether the artifact can be used in a WHERE clause in search queries.

bool

Whether the artifact can be used in a ORDER BY clause in search queries.

string

The URL of proto describing the artifact's data type.

bool

Whether the field artifact is repeated.

string

The resource name of the Shopping performance view. Shopping performance view resource names have the form: customers/{customer_id}/shoppingPerformanceView

string

The resource name of the user list. User list resource names have the form:

customers/{customer_id}/userLists/{user_list_id}

UserListType

Type of this list.

This field is read-only.

int64

Id of the user list.

string

Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)

string

The resource name of the user location view. UserLocation view resource names have the form:

customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location}

int64

Criterion Id for the country.

bool

Indicates whether location was targeted or not.

string

The resource name of the visit. Visit resource names have the form:

customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}

int64

The ID of the visit.

int64

Search Ads 360 keyword ID. A value of 0 indicates that the keyword is unattributed.

int64

The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.

int64

Ad ID. A value of 0 indicates that the ad is unattributed.

string

A unique string for each visit that is passed to the landing page as the click id URL parameter.

string

The timestamp of the visit event. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

string

The ID of the product clicked on.

ProductChannel

The sales channel of the product that was clicked on: Online or Local.

string

The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.

string

The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.

string

The country (ISO-3166 format) registered for the inventory feed that contains the product clicked on.

int64

ID of the asset which was interacted with during the visit event.

AssetFieldType

Asset field type of the visit event.

string

The resource name of the webpage view. Webpage view resource names have the form:

customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}