Package google.ads.searchads360.v0.services

فهرست

سرویس ستون سفارشی

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

ستون سفارشی را دریافت کنید

rpc GetCustomColumn( GetCustomColumnRequest ) returns ( CustomColumn )

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

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/doubleclicksearch
ستون‌های سفارشی لیست

rpc ListCustomColumns( ListCustomColumnsRequest ) returns ( ListCustomColumnsResponse )

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

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/doubleclicksearch

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

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

لیست مشتریان قابل دسترس

rpc ListAccessibleCustomers( ListAccessibleCustomersRequest ) returns ( ListAccessibleCustomersResponse )

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

لیست خطاهای رخ داده: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/doubleclicksearch

خدمات میدانی جستجوAds360

سرویسی برای دریافت فیلدهای API تبلیغات جستجو ۳۶۰.

GetSearchAds360Field

rpc GetSearchAds360Field( GetSearchAds360FieldRequest ) returns ( SearchAds360Field )

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

لیست خطاهای رخ داده: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/doubleclicksearch
جستجوجستجوتبلیغات360فیلد

rpc SearchSearchAds360Fields( SearchSearchAds360FieldsRequest ) returns ( SearchSearchAds360FieldsResponse )

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

لیست خطاهای رخ داده: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/doubleclicksearch

خدمات جستجوAds360

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

جستجو

rpc Search( SearchSearchAds360Request ) returns ( SearchSearchAds360Response )

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

لیست خطاهای رخ داده: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/doubleclicksearch
جریان جستجو

rpc SearchStream( SearchSearchAds360StreamRequest ) returns ( SearchSearchAds360StreamResponse )

تمام ردیف‌هایی را که با عبارت جستجو مطابقت دارند، برمی‌گرداند.

لیست خطاهای رخ داده: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/doubleclicksearch

هدر ConversionCustomDimension

پیام برای تبدیل هدر با ابعاد سفارشی.

فیلدها
id

int64

شناسه‌ی بُعد سفارشی تبدیل.

name

string

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

تبدیلسفارشی هدر متریک

پیام برای تبدیل سربرگ متریک سفارشی.

فیلدها
id

int64

شناسه معیار سفارشی تبدیل.

name

string

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

سرستون سفارشی

پیام برای سرستون سفارشی.

فیلدها
id

int64

شناسه ستون سفارشی.

name

string

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

references_metrics

bool

زمانی که ستون سفارشی به معیارها اشاره می‌کند، صحیح است.

درخواست ستون سفارشی

درخواست پیام برای CustomColumnService.GetCustomColumn .

فیلدها
resource_name

string

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

GetSearchAds360Fieldدرخواست

درخواست پیام برای SearchAds360FieldService.GetSearchAds360Field .

فیلدها
resource_name

string

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

ListAccessibleCustomers Request

این نوع هیچ فیلدی ندارد.

درخواست پیام برای CustomerService.ListAccessibleCustomers .

ListAccessibleCustomers Response

پیام پاسخ برای CustomerService.ListAccessibleCustomers .

فیلدها
resource_names[]

string

نام منبع مشتریانی که مستقیماً توسط کاربری که تماس را تأیید می‌کند، قابل دسترسی است.

درخواست ستون‌های سفارشی لیست

درخواست پیام برای CustomColumnService.ListCustomColumns

فیلدها
customer_id

string

الزامی. شناسه مشتری که عملیات لیست CustomColumn روی آن اعمال می‌شود.

پاسخ ستون‌های سفارشی لیست

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

فیلدها
custom_columns[]

CustomColumn

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

هدر RawEventConversionDimension

پیام مربوط به هدر بُعد تبدیل رویداد خام.

فیلدها
id

int64

شناسه متغیر سفارشی تبدیل.

name

string

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

هدر RawEventConversionMetric

پیام مربوط به سربرگ معیار تبدیل رویداد خام.

فیلدها
id

int64

شناسه متغیر سفارشی تبدیل.

name

string

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

جستجوی تبلیغات ۳۶۰ ردیف

یک ردیف برگردانده شده از پرس و جو.

فیلدها
ad_group

AdGroup

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

ad_group_ad

AdGroupAd

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

ad_group_ad_effective_label

AdGroupAdEffectiveLabel

برچسب اثربخشی تبلیغات گروه تبلیغاتی که در عبارت جستجو به آن اشاره شده است.

ad_group_ad_label

AdGroupAdLabel

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

ad_group_asset

AdGroupAsset

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

ad_group_asset_set

AdGroupAssetSet

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

ad_group_audience_view

AdGroupAudienceView

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

ad_group_bid_modifier

AdGroupBidModifier

اصلاح‌کننده‌ی پیشنهاد قیمت که در پرس‌وجو به آن اشاره شده است.

ad_group_criterion

AdGroupCriterion

معیاری که در پرسش به آن اشاره شده است.

ad_group_criterion_effective_label

AdGroupCriterionEffectiveLabel

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

ad_group_criterion_label

AdGroupCriterionLabel

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

ad_group_effective_label

AdGroupEffectiveLabel

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

ad_group_label

AdGroupLabel

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

age_range_view

AgeRangeView

نمای محدوده سنی که در پرس و جو به آن اشاره شده است.

asset

Asset

دارایی مورد اشاره در پرس و جو.

asset_group_asset

AssetGroupAsset

دارایی گروه دارایی که در پرس و جو به آن اشاره شده است.

asset_group_signal

AssetGroupSignal

سیگنال گروه دارایی که در پرس و جو به آن اشاره شده است.

asset_group_listing_group_filter

AssetGroupListingGroupFilter

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

asset_group_top_combination_view

AssetGroupTopCombinationView

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

asset_group

AssetGroup

گروه دارایی که در پرس و جو به آن اشاره شده است.

asset_set_asset

AssetSetAsset

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

asset_set

AssetSet

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

bidding_strategy

BiddingStrategy

استراتژی پیشنهاد قیمت که در پرس و جو به آن اشاره شده است.

campaign_budget

CampaignBudget

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

campaign

Campaign

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

campaign_asset

CampaignAsset

دارایی کمپین که در پرس و جو به آن اشاره شده است.

campaign_asset_set

CampaignAssetSet

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

campaign_audience_view

CampaignAudienceView

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

campaign_criterion

CampaignCriterion

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

campaign_effective_label

CampaignEffectiveLabel

برچسب مؤثر کمپین که در عبارت جستجو به آن اشاره شده است.

campaign_label

CampaignLabel

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

cart_data_sales_view

CartDataSalesView

نمای فروش داده‌های سبد خرید که در پرس‌وجو به آن اشاره شده است.

audience

Audience

مخاطبی که در پرسش به آن اشاره شده است.

conversion_action

ConversionAction

عمل تبدیلی که در کوئری به آن اشاره شده است.

conversion_custom_variable

ConversionCustomVariable

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

customer

Customer

مشتری مورد اشاره در استعلام.

customer_asset

CustomerAsset

دارایی مشتری که در پرس و جو به آن اشاره شده است.

customer_asset_set

CustomerAssetSet

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

accessible_bidding_strategy

AccessibleBiddingStrategy

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

customer_client

CustomerClient

CustomerClient که در کوئری به آن اشاره شده است.

dynamic_search_ads_search_term_view

DynamicSearchAdsSearchTermView

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

gender_view

GenderView

دیدگاه جنسیتی که در پرس‌وجو به آن اشاره شده است.

geo_target_constant

GeoTargetConstant

ثابت هدف جغرافیایی که در پرس و جو به آن اشاره شده است.

keyword_view

KeywordView

نمای کلمه کلیدی که در پرس و جو به آن اشاره شده است.

label

Label

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

language_constant

LanguageConstant

ثابت زبانی که در پرس و جو به آن اشاره شده است.

location_view

LocationView

نمای مکانی که در پرس و جو به آن اشاره شده است.

product_bidding_category_constant

ProductBiddingCategoryConstant

دسته بندی پیشنهاد قیمت محصول که در پرس و جو به آن اشاره شده است.

product_group_view

ProductGroupView

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

shopping_performance_view

ShoppingPerformanceView

نمای عملکرد خرید که در پرس و جو به آن اشاره شده است.

user_list

UserList

فهرست کاربرانی که در پرس‌وجو به آنها ارجاع داده شده است.

user_location_view

UserLocationView

نمای موقعیت مکانی کاربر که در پرس و جو به آن اشاره شده است.

webpage_view

WebpageView

نمای صفحه وب که در پرس و جو به آن اشاره شده است.

visit

Visit

بازدید سطح رویداد که در پرس و جو به آن اشاره شده است.

conversion

Conversion

تبدیل سطح رویداد که در پرس و جو به آن اشاره شده است.

metrics

Metrics

معیارها.

segments

Segments

بخش‌ها

custom_columns[]

Value

ستون‌های سفارشی.

جستجوجستجوتبلیغات۳۶۰فیلددرخواست

درخواست پیام برای SearchAds360FieldService.SearchSearchAds360Fields .

فیلدها
query

string

الزامی. رشته‌ی پرس‌وجو.

page_token

string

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

page_size

int32

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

جستجوجستجوتبلیغات۳۶۰فیلدپاسخ

پیام پاسخ برای SearchAds360FieldService.SearchSearchAds360Fields .

فیلدها
results[]

SearchAds360Field

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

next_page_token

string

توکن صفحه‌بندی برای بازیابی صفحه بعدی نتایج استفاده می‌شود. محتوای این رشته را به عنوان ویژگی page_token درخواست بعدی ارسال کنید. next_page_token برای صفحه آخر بازگردانده نمی‌شود.

total_results_count

int64

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

جستجوجستجوتبلیغات360درخواست

درخواست پیام برای SearchAds360Service.Search .

فیلدها
customer_id

string

الزامی. شناسه مشتری مورد نظر.

query

string

الزامی. رشته‌ی پرس‌وجو.

page_token

string

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

page_size

int32

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

validate_only

bool

اگر درست باشد، درخواست اعتبارسنجی می‌شود اما اجرا نمی‌شود.

return_total_results_count

bool

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

summary_row_setting

SummaryRowSetting

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

جستجوجستجوتبلیغات360پاسخ

پیام پاسخ برای SearchAds360Service.Search .

فیلدها
results[]

SearchAds360Row

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

next_page_token

string

توکن صفحه‌بندی برای بازیابی صفحه بعدی نتایج استفاده می‌شود. محتوای این رشته را به عنوان ویژگی page_token درخواست بعدی ارسال کنید. next_page_token برای صفحه آخر بازگردانده نمی‌شود.

total_results_count

int64

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

field_mask

FieldMask

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

summary_row

SearchAds360Row

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

custom_column_headers[]

CustomColumnHeader

سرتیترهای ستون‌های سفارشی در نتایج.

conversion_custom_metric_headers[]

ConversionCustomMetricHeader

سرتیترهای معیارهای سفارشی تبدیل در نتایج.

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

هدرهای ابعاد سفارشی تبدیل در نتایج.

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

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

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

هدرهای ابعاد تبدیل رویداد خام در نتایج.

جستجوجستجوتبلیغات360جریاندرخواست

درخواست پیام برای SearchAds360Service.SearchStream .

فیلدها
customer_id

string

الزامی. شناسه مشتری مورد نظر.

query

string

الزامی. رشته‌ی پرس‌وجو.

batch_size

int32

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

summary_row_setting

SummaryRowSetting

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

جستجوتبلیغات جستجو360جریانپاسخ

پیام پاسخ برای SearchAds360Service.SearchStream .

فیلدها
results[]

SearchAds360Row

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

field_mask

FieldMask

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

summary_row

SearchAds360Row

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

custom_column_headers[]

CustomColumnHeader

سرتیترهای ستون‌های سفارشی در نتایج.

conversion_custom_metric_headers[]

ConversionCustomMetricHeader

سرتیترهای معیارهای سفارشی تبدیل در نتایج.

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

هدرهای بُعد سفارشی تبدیل در نتایج.

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

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

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

هدرهای ابعاد تبدیل رویداد خام در نتایج.

request_id

string

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