Package google.ads.searchads360.v0.services

Index

• CustomColumnService (interface)
• CustomerService (interface)
• SearchAds360FieldService (interface)
• SearchAds360Service (interface)
• ConversionCustomDimensionHeader (message)
• ConversionCustomMetricHeader (message)
• CustomColumnHeader (message)
• GetCustomColumnRequest (message)
• GetSearchAds360FieldRequest (message)
• ListAccessibleCustomersRequest (message)
• ListAccessibleCustomersResponse (message)
• ListCustomColumnsRequest (message)
• ListCustomColumnsResponse (message)
• RawEventConversionDimensionHeader (message)
• RawEventConversionMetricHeader (message)
• SearchAds360Row (message)
• SearchSearchAds360FieldsRequest (message)
• SearchSearchAds360FieldsResponse (message)
• SearchSearchAds360Request (message)
• SearchSearchAds360Response (message)
• SearchSearchAds360StreamRequest (message)
• SearchSearchAds360StreamResponse (message)

CustomColumnService

Service to manage custom columns.

GetCustomColumn
rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn) Returns the requested custom column in full detail. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/doubleclicksearch

ListCustomColumns
rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse) Returns all the custom columns associated with the customer in full detail. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/doubleclicksearch

CustomerService

Service to manage customers.

ListAccessibleCustomers

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse) Returns resource names of customers directly accessible by the user authenticating the call. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/doubleclicksearch

SearchAds360FieldService

Service to fetch Search Ads 360 API fields.

GetSearchAds360Field
rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field) Returns just the requested field. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/doubleclicksearch

SearchSearchAds360Fields
rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse) Returns all fields that match the search query. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/doubleclicksearch

SearchAds360Service

Service to fetch data and metrics across resources.

Search
rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response) Returns all rows that match the search query. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/doubleclicksearch

SearchStream
rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse) Returns all rows that match the search stream query. List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/doubleclicksearch

ConversionCustomDimensionHeader

Message for conversion custom dimension header.

Fields
id	int64 The conversion custom dimension ID.
name	string The user defined name of the conversion custom dimension.

ConversionCustomMetricHeader

Message for conversion custom metric header.

Fields
id	int64 The conversion custom metric ID.
name	string The user defined name of the conversion custom metric.

CustomColumnHeader

Message for custom column header.

Fields
id	int64 The custom column ID.
name	string The user defined name of the custom column.
references_metrics	bool True when the custom column references metrics.

GetCustomColumnRequest

Request message for CustomColumnService.GetCustomColumn.

Fields
resource_name	string Required. The resource name of the custom column to fetch.

GetSearchAds360FieldRequest

Request message for SearchAds360FieldService.GetSearchAds360Field.

Fields
resource_name	string Required. The resource name of the field to get.

ListAccessibleCustomersRequest

This type has no fields.

Request message for CustomerService.ListAccessibleCustomers.

ListAccessibleCustomersResponse

Response message for CustomerService.ListAccessibleCustomers.

Fields
resource_names[]	string Resource name of customers directly accessible by the user authenticating the call.

ListCustomColumnsRequest

Request message for CustomColumnService.ListCustomColumns

Fields
customer_id	string Required. The ID of the customer to apply the CustomColumn list operation to.

ListCustomColumnsResponse

Response message for fetching all custom columns associated with a customer.

Fields
custom_columns[]	CustomColumn The CustomColumns owned by the provided customer.

RawEventConversionDimensionHeader

Message for raw event conversion dimension header.

Fields
id	int64 The conversion custom variable ID.
name	string The user defined name of the raw event dimension.

RawEventConversionMetricHeader

Message for raw event conversion metric header.

Fields
id	int64 The conversion custom variable ID.
name	string The user defined name of the raw event metric.

SearchAds360Row

A returned row from the query.

Fields
ad_group	AdGroup The ad group referenced in the query.
ad_group_ad	AdGroupAd The ad referenced in the query.
ad_group_ad_label	AdGroupAdLabel The ad group ad label referenced in the query.
ad_group_asset	AdGroupAsset The ad group asset referenced in the query.
ad_group_asset_set	AdGroupAssetSet The ad group asset set referenced in the query.
ad_group_audience_view	AdGroupAudienceView The ad group audience view referenced in the query.
ad_group_bid_modifier	AdGroupBidModifier The bid modifier referenced in the query.
ad_group_criterion	AdGroupCriterion The criterion referenced in the query.
ad_group_criterion_label	AdGroupCriterionLabel The ad group criterion label referenced in the query.
ad_group_effective_label	AdGroupEffectiveLabel The ad group effective label referenced in the query.
ad_group_label	AdGroupLabel The ad group label referenced in the query.
age_range_view	AgeRangeView The age range view referenced in the query.
asset	Asset The asset referenced in the query.
asset_group_asset	AssetGroupAsset The asset group asset referenced in the query.
asset_group_signal	AssetGroupSignal The asset group signal referenced in the query.
asset_group_listing_group_filter	AssetGroupListingGroupFilter The asset group listing group filter referenced in the query.
asset_group_top_combination_view	AssetGroupTopCombinationView The asset group top combination view referenced in the query.
asset_group	AssetGroup The asset group referenced in the query.
asset_set_asset	AssetSetAsset The asset set asset referenced in the query.
asset_set	AssetSet The asset set referenced in the query.
bidding_strategy	BiddingStrategy The bidding strategy referenced in the query.
campaign_budget	CampaignBudget The campaign budget referenced in the query.
campaign	Campaign The campaign referenced in the query.
campaign_asset	CampaignAsset The campaign asset referenced in the query.
campaign_asset_set	CampaignAssetSet The campaign asset set referenced in the query.
campaign_audience_view	CampaignAudienceView The campaign audience view referenced in the query.
campaign_criterion	CampaignCriterion The campaign criterion referenced in the query.
campaign_effective_label	CampaignEffectiveLabel The campaign effective label referenced in the query.
campaign_label	CampaignLabel The campaign label referenced in the query.
cart_data_sales_view	CartDataSalesView The cart data sales view referenced in the query.
audience	Audience The Audience referenced in the query.
conversion_action	ConversionAction The conversion action referenced in the query.
conversion_custom_variable	ConversionCustomVariable The conversion custom variable referenced in the query.
customer	Customer The customer referenced in the query.
customer_asset	CustomerAsset The customer asset referenced in the query.
customer_asset_set	CustomerAssetSet The customer asset set referenced in the query.
accessible_bidding_strategy	AccessibleBiddingStrategy The accessible bidding strategy referenced in the query.
customer_manager_link	CustomerManagerLink The CustomerManagerLink referenced in the query.
customer_client	CustomerClient The CustomerClient referenced in the query.
dynamic_search_ads_search_term_view	DynamicSearchAdsSearchTermView The dynamic search ads search term view referenced in the query.
gender_view	GenderView The gender view referenced in the query.
geo_target_constant	GeoTargetConstant The geo target constant referenced in the query.
keyword_view	KeywordView The keyword view referenced in the query.
label	Label The label referenced in the query.
language_constant	LanguageConstant The language constant referenced in the query.
location_view	LocationView The location view referenced in the query.
product_bidding_category_constant	ProductBiddingCategoryConstant The Product Bidding Category referenced in the query.
product_group_view	ProductGroupView The product group view referenced in the query.
shopping_performance_view	ShoppingPerformanceView The shopping performance view referenced in the query.
user_list	UserList The user list referenced in the query.
webpage_view	WebpageView The webpage view referenced in the query.
visit	Visit The event level visit referenced in the query.
conversion	Conversion The event level conversion referenced in the query.
metrics	Metrics The metrics.
segments	Segments The segments.
custom_columns[]	Value The custom columns.

SearchSearchAds360FieldsRequest

Request message for SearchAds360FieldService.SearchSearchAds360Fields.

Fields
query	string Required. The query string.
page_token	string Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results.
page_size	int32 Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources.

SearchSearchAds360FieldsResponse

Response message for SearchAds360FieldService.SearchSearchAds360Fields.

Fields
results[]	SearchAds360Field The list of fields that matched the query.
next_page_token	string Pagination token used to retrieve the next page of results. Pass the content of this string as the page_token attribute of the next request. next_page_token is not returned for the last page.
total_results_count	int64 Total number of results that match the query ignoring the LIMIT clause.

SearchSearchAds360Request

Request message for SearchAds360Service.Search.

Fields
customer_id	string Required. The ID of the customer being queried.
query	string Required. The query string.
page_token	string Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results.
page_size	int32 Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources.
validate_only	bool If true, the request is validated but not executed.
return_total_results_count	bool If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response. Default is false.
summary_row_setting	SummaryRowSetting Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned.

SearchSearchAds360Response

Response message for SearchAds360Service.Search.

Fields
results[]	SearchAds360Row The list of rows that matched the query.
next_page_token	string Pagination token used to retrieve the next page of results. Pass the content of this string as the page_token attribute of the next request. next_page_token is not returned for the last page.
total_results_count	int64 Total number of results that match the query ignoring the LIMIT clause.
field_mask	FieldMask FieldMask that represents what fields were requested by the user.
summary_row	SearchAds360Row Summary row that contains summary of metrics in results. Summary of metrics means aggregation of metrics across all results, here aggregation could be sum, average, rate, etc.
custom_column_headers[]	CustomColumnHeader The headers of the custom columns in the results.
conversion_custom_metric_headers[]	ConversionCustomMetricHeader The headers of the conversion custom metrics in the results.
conversion_custom_dimension_headers[]	ConversionCustomDimensionHeader The headers of the conversion custom dimensions in the results.
raw_event_conversion_metric_headers[]	RawEventConversionMetricHeader The headers of the raw event conversion metrics in the results.
raw_event_conversion_dimension_headers[]	RawEventConversionDimensionHeader The headers of the raw event conversion dimensions in the results.

SearchSearchAds360StreamRequest

Request message for SearchAds360Service.SearchStream.

Fields
customer_id	string Required. The ID of the customer being queried.
query	string Required. The query string.
batch_size	int32 The number of rows that are returned in each stream response batch. When too large batch is requested, the server may decide to further limit the number of returned rows.
summary_row_setting	SummaryRowSetting Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned.

SearchSearchAds360StreamResponse

Response message for SearchAds360Service.SearchStream.

Fields
results[]	SearchAds360Row The list of rows that matched the query.
field_mask	FieldMask FieldMask that represents what fields were requested by the user.
summary_row	SearchAds360Row Summary row that contains summary of metrics in results. Summary of metrics means aggregation of metrics across all results, here aggregation could be sum, average, rate, etc.
custom_column_headers[]	CustomColumnHeader The headers of the custom columns in the results.
conversion_custom_metric_headers[]	ConversionCustomMetricHeader The headers of the conversion custom metrics in the results.
conversion_custom_dimension_headers[]	ConversionCustomDimensionHeader The headers of the conversion custom dimension in the results.
raw_event_conversion_metric_headers[]	RawEventConversionMetricHeader The headers of the raw event conversion metrics in the results.
raw_event_conversion_dimension_headers[]	RawEventConversionDimensionHeader The headers of the raw event conversion dimensions in the results.
request_id	string The unique id of the request that is used for debugging purposes.