Package google.ads.searchads360.v0.services

فهرست مطالب

CustomColumnService

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

GetCustomColumn

rpc GetCustomColumn( GetCustomColumnRequest ) returns ( CustomColumn )

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

محدوده مجوز

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

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

rpc ListCustomColumns( ListCustomColumnsRequest ) returns ( ListCustomColumnsResponse )

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

محدوده مجوز

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

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

خدمات مشتری

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

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

rpc ListAccessibleCustomers( ListAccessibleCustomersRequest ) returns ( ListAccessibleCustomersResponse )

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

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

محدوده مجوز

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

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

SearchAds360FieldService

خدماتی برای واکشی فیلدهای Search Ads 360 API.

GetSearchAds360Field

rpc GetSearchAds360Field( GetSearchAds360FieldRequest ) returns ( SearchAds360Field )

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

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

محدوده مجوز

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

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

rpc SearchSearchAds360Fields( SearchSearchAds360FieldsRequest ) returns ( SearchSearchAds360FieldsResponse )

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

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

محدوده مجوز

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

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

SearchAds360 Service

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

جستجو کردن

rpc Search( SearchSearchAds360Request ) returns ( SearchSearchAds360Response )

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

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

محدوده مجوز

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

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

rpc SearchStream( SearchSearchAds360StreamRequest ) returns ( SearchSearchAds360StreamResponse )

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

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

محدوده مجوز

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

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

ConversionCustomDimensionHeader

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

زمینه های
id

int64

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

name

string

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

ConversionCustomMetricHeader

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

زمینه های
id

int64

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

name

string

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

CustomColumnHeader

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

زمینه های
id

int64

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

name

string

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

references_metrics

bool

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

GetCustomColumnRequest

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

زمینه های
resource_name

string

ضروری. نام منبع ستون سفارشی برای واکشی.

GetSearchAds360FieldRequest

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

زمینه های
resource_name

string

ضروری. نام منبع فیلد برای دریافت.

ListAccessibleCustomers Request

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

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

ListAccessibleCustomers Response

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

زمینه های
resource_names[]

string

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

ListCustomColumnsRequest

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

زمینه های
customer_id

string

ضروری. شناسه مشتری برای اعمال عملیات فهرست CustomColumn.

ListCustomColumnsResponse

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

زمینه های
custom_columns[]

CustomColumn

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

RawEventConversionDimensionHeader

پیام برای سرصفحه بعد تبدیل رویداد خام.

زمینه های
id

int64

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

name

string

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

RawEventConversionMetricHeader

پیام برای سرصفحه متریک تبدیل رویداد خام.

زمینه های
id

int64

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

name

string

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

SearchAds360Row

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

زمینه های
ad_group

AdGroup

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

ad_group_ad

AdGroupAd

آگهی اشاره شده در پرس و جو.

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_label

AdGroupCriterionLabel

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

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_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

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

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

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

webpage_view

WebpageView

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

visit

Visit

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

conversion

Conversion

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

metrics

Metrics

معیارها

segments

Segments

بخش ها

custom_columns[]

Value

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

SearchSearchAds360FieldsRequest

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

زمینه های
query

string

ضروری. رشته پرس و جو.

page_token

string

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

page_size

int32

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

SearchSearchAds360FieldsResponse

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

زمینه های
results[]

SearchAds360Field

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

next_page_token

string

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

total_results_count

int64

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

SearchSearchAds360 Request

درخواست پیام برای 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

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

SearchSearchAds360 Response

پیام پاسخ برای 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

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

SearchSearchAds360StreamRequest

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

زمینه های
customer_id

string

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

query

string

ضروری. رشته پرس و جو.

batch_size

int32

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

summary_row_setting

SummaryRowSetting

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

SearchSearchAds360StreamResponse

پیام پاسخ برای 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

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