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

CustomerService

用於管理客戶的服務。

ListAccessibleCustomers

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

傳回驗證呼叫的使用者可直接存取的客戶資源名稱。

擲回錯誤清單:AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

授權範圍

需要下列 OAuth 範圍:

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

SearchAds360FieldService

用於擷取 Search Ads 360 API 欄位的服務。

GetSearchAds360Field

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

僅傳回要求的欄位。

擲回錯誤清單:AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

授權範圍

需要下列 OAuth 範圍:

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

rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)

傳回與搜尋查詢相符的所有欄位。

擲回錯誤清單:AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

授權範圍

需要下列 OAuth 範圍:

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

SearchAds360Service

跨資源擷取資料與指標的服務。

搜尋

rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)

傳回符合搜尋查詢的所有資料列。

擲回錯誤清單:AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

授權範圍

需要下列 OAuth 範圍:

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

rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)

傳回符合搜尋串流查詢的所有資料列。

擲回錯誤清單:AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

授權範圍

需要下列 OAuth 範圍:

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

ConversionCustomDimensionHeader

轉換自訂維度標題的訊息。

欄位
id

int64

轉換自訂維度 ID。

name

string

使用者定義的轉換自訂維度名稱。

ConversionCustomMetricHeader

轉換自訂指標標題的訊息。

欄位
id

int64

轉換自訂指標 ID。

name

string

使用者定義的轉換自訂指標名稱。

CustomColumnHeader

自訂欄標題的訊息。

欄位
id

int64

自訂欄 ID。

name

string

使用者定義的自訂欄名稱。

references_metrics

bool

如果自訂欄參照指標,則為 True。

GetCustomColumnRequest

CustomColumnService.GetCustomColumn」的要求訊息。

欄位
resource_name

string

必要欄位。要擷取的自訂欄資源名稱。

GetSearchAds360FieldRequest

SearchAds360FieldService.GetSearchAds360Field」的要求訊息。

欄位
resource_name

string

必要欄位。要取得的欄位資源名稱。

ListAccessibleCustomersRequest

這個類型沒有任何欄位。

CustomerService.ListAccessibleCustomers」的要求訊息。

ListAccessibleCustomersResponse

CustomerService.ListAccessibleCustomers」的回應訊息。

欄位
resource_names[]

string

驗證呼叫的使用者可直接存取的客戶資源名稱。

ListCustomColumnsRequest

CustomColumnService.ListCustomColumns」的要求訊息

欄位
customer_id

string

必要欄位。要套用 CustomColumn 清單作業的客戶 ID。

ListCustomColumnsResponse

擷取客戶所有相關自訂欄的回應訊息。

欄位
custom_columns[]

CustomColumn

所提供客戶擁有的 CustomColumn。

RawEventConversionDimensionHeader

原始事件轉換維度標題的訊息。

欄位
id

int64

轉換自訂變數 ID。

name

string

使用者定義的原始事件維度名稱。

RawEventConversionMetricHeader

原始事件轉換指標標題的訊息。

欄位
id

int64

轉換自訂變數 ID。

name

string

使用者定義的原始事件指標名稱。

Search Ads360 資料列

查詢傳回的資料列。

欄位
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

查詢中參照的 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 子句)。

SearchSearchAds360Request

SearchAds360Service.Search」的要求訊息。

欄位
customer_id

string

必要欄位。所查詢客戶的 ID。

query

string

必要欄位。查詢字串。

page_token

string

要擷取的網頁權杖。如未指定,系統會傳回第一頁的結果。使用在上一個回應中從 next_page_token 取得的值,要求下一頁的結果。

page_size

int32

單一頁面中要擷取的元素數量。當要求過大的網頁時,伺服器可能會決定進一步限制傳回的資源數量。

validate_only

bool

如果為 true,表示要求會完成驗證,但尚未執行。

return_total_results_count

bool

如果為 true,則回應中包含忽略 LIMIT 子句且符合查詢的結果總數。預設值為 false。

summary_row_setting

SummaryRowSetting

決定是否要傳回摘要列。根據預設,系統不會傳回摘要列。依要求,在傳回所有其他查詢結果後,系統會單獨傳送摘要列做為回應。

SearchSearchAds360Response

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

必要欄位。所查詢客戶的 ID。

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

用於偵錯的要求專屬 ID。