La nueva API de informes de Search Ads 360 ya está disponible. Únete al grupo de Google searchads-api-announcements para mantenerte al tanto de las próximas mejoras y lanzamientos.

Se usó la API de Cloud Translation para traducir esta página.

Package google.ads.searchads360.v0.services

Índice

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

CustomColumnService

Servicio para administrar columnas personalizadas.

GetCustomColumn

GetCustomColumn
`rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)` Muestra la columna personalizada solicitada con todos los detalles. Alcances de autorización Requiere el siguiente alcance de OAuth: `https://www.googleapis.com/auth/doubleclicksearch`

rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)

Muestra la columna personalizada solicitada con todos los detalles.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

ListCustomColumns

ListCustomColumns
`rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)` Muestra todas las columnas personalizadas asociadas con el cliente en detalle. Alcances de autorización Requiere el siguiente alcance de OAuth: `https://www.googleapis.com/auth/doubleclicksearch`

rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)

Muestra todas las columnas personalizadas asociadas con el cliente en detalle.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

CustomerService

Servicio para administrar clientes.

ListAccessibleCustomers

ListAccessibleCustomers
`rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)` Muestra los nombres de recursos de los clientes a los que puede acceder directamente el usuario que autentica la llamada. Lista de errores arrojados: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError Alcances de autorización Requiere el siguiente alcance de OAuth: `https://www.googleapis.com/auth/doubleclicksearch`

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

Muestra los nombres de recursos de los clientes a los que puede acceder directamente el usuario que autentica la llamada.

Lista de errores arrojados: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

SearchAds360FieldService

Servicio para recuperar los campos de la API de Search Ads 360.

GetSearchAds360Field

GetSearchAds360Field
`rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)` Muestra solo el campo solicitado. Lista de errores arrojados: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError Alcances de autorización Requiere el siguiente alcance de OAuth: `https://www.googleapis.com/auth/doubleclicksearch`

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

Muestra solo el campo solicitado.

Lista de errores arrojados: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

SearchSearchAds360Fields

SearchSearchAds360Fields
`rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)` Muestra todos los campos que coinciden con la búsqueda. Lista de errores generados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Alcances de autorización Requiere el siguiente alcance de OAuth: `https://www.googleapis.com/auth/doubleclicksearch`

rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)

Muestra todos los campos que coinciden con la búsqueda.

Lista de errores generados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

SearchAds360Service

Servicio para recuperar datos y métricas de todos los recursos

Buscar

Buscar
`rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)` Muestra todas las filas que coinciden con la búsqueda. Lista de errores generados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Alcances de autorización Requiere el siguiente alcance de OAuth: `https://www.googleapis.com/auth/doubleclicksearch`

rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)

Muestra todas las filas que coinciden con la búsqueda.

Lista de errores generados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

SearchStream

SearchStream
`rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)` Muestra todas las filas que coinciden con la consulta del flujo de búsqueda. Lista de errores generados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Alcances de autorización Requiere el siguiente alcance de OAuth: `https://www.googleapis.com/auth/doubleclicksearch`

rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)

Muestra todas las filas que coinciden con la consulta del flujo de búsqueda.

Lista de errores generados: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

ConversionCustomDimensionHeader

Mensaje para el encabezado de la dimensión personalizada de conversión.

Campos

Campos
`id`	`int64` El ID de la dimensión personalizada de conversión.
`name`	`string` Es el nombre definido por el usuario de la dimensión personalizada de conversión.

id

int64

El ID de la dimensión personalizada de conversión.

name

string

Es el nombre definido por el usuario de la dimensión personalizada de conversión.

ConversionCustomMetricHeader

Es el mensaje del encabezado de la métrica personalizada de conversión.

Campos

Campos
`id`	`int64` El ID de la métrica personalizada de conversión.
`name`	`string` Es el nombre definido por el usuario de la métrica personalizada de conversiones.

id

int64

El ID de la métrica personalizada de conversión.

name

string

Es el nombre definido por el usuario de la métrica personalizada de conversiones.

CustomColumnHeader

Es el mensaje para el encabezado de la columna personalizada.

Campos

Campos
`id`	`int64` Es el ID de la columna personalizada.
`name`	`string` Es el nombre de la columna personalizada que definió el usuario.
`references_metrics`	`bool` Es verdadero cuando la columna personalizada hace referencia a las métricas.

id

int64

Es el ID de la columna personalizada.

name

string

Es el nombre de la columna personalizada que definió el usuario.

references_metrics

bool

Es verdadero cuando la columna personalizada hace referencia a las métricas.

GetCustomColumnRequest

Mensaje de solicitud para CustomColumnService.GetCustomColumn.

Campos

Campos
`resource_name`	`string` Obligatorio. Es el nombre del recurso de la columna personalizada que se recuperará.

resource_name

string

Obligatorio. Es el nombre del recurso de la columna personalizada que se recuperará.

GetSearchAds360FieldRequest

Mensaje de solicitud para SearchAds360FieldService.GetSearchAds360Field.

Campos

Campos
`resource_name`	`string` Obligatorio. Es el nombre del recurso del campo que se debe obtener.

resource_name

string

Obligatorio. Es el nombre del recurso del campo que se debe obtener.

ListAccessibleCustomersRequest

Este tipo no tiene campos.

Mensaje de solicitud para CustomerService.ListAccessibleCustomers.

ListAccessibleCustomersResponse

Mensaje de respuesta para CustomerService.ListAccessibleCustomers.

Campos

Campos
`resource_names[]`	`string` Es el nombre del recurso de los clientes al que el usuario que autentica la llamada puede acceder directamente.

resource_names[]

string

Es el nombre del recurso de los clientes al que el usuario que autentica la llamada puede acceder directamente.

ListCustomColumnsRequest

Mensaje de solicitud para CustomColumnService.ListCustomColumns

Campos

Campos
`customer_id`	`string` Obligatorio. El ID del cliente al que se aplicará la operación de lista CustomColumn.

customer_id

string

Obligatorio. El ID del cliente al que se aplicará la operación de lista CustomColumn.

ListCustomColumnsResponse

Es un mensaje de respuesta para recuperar todas las columnas personalizadas asociadas con un cliente.

Campos

Campos
`custom_columns[]`	`CustomColumn` Las CustomColumns que pertenecen al cliente proporcionado.

custom_columns[]

CustomColumn

Las CustomColumns que pertenecen al cliente proporcionado.

RawEventConversionDimensionHeader

Mensaje para el encabezado de dimensión de conversión de evento sin procesar.

Campos

Campos
`id`	`int64` Es el ID de la variable personalizada de conversión.
`name`	`string` Es el nombre definido por el usuario de la dimensión del evento sin procesar.

id

int64

Es el ID de la variable personalizada de conversión.

name

string

Es el nombre definido por el usuario de la dimensión del evento sin procesar.

RawEventConversionMetricHeader

Mensaje para el encabezado de la métrica de conversión de eventos sin procesar.

Campos

Campos
`id`	`int64` El ID de la variable personalizada de conversión.
`name`	`string` Es el nombre definido por el usuario de la métrica de evento sin procesar.

id

int64

El ID de la variable personalizada de conversión.

name

string

Es el nombre definido por el usuario de la métrica de evento sin procesar.

SearchAds360Row

Es una fila que muestra la consulta.

Campos
`ad_group`	`AdGroup` Es el grupo de anuncios al que se hace referencia en la consulta.
`ad_group_ad`	`AdGroupAd` Es el anuncio al que se hace referencia en la consulta.
`ad_group_ad_effective_label`	`AdGroupAdEffectiveLabel` La etiqueta de grupo de anuncios eficaz a la que se hace referencia en la consulta.
`ad_group_ad_label`	`AdGroupAdLabel` La etiqueta del anuncio del grupo de anuncios a la que se hace referencia en la consulta.
`ad_group_asset`	`AdGroupAsset` Es el recurso del grupo de anuncios al que se hace referencia en la consulta.
`ad_group_asset_set`	`AdGroupAssetSet` El conjunto de recursos del grupo de anuncios al que se hace referencia en la consulta.
`ad_group_audience_view`	`AdGroupAudienceView` La vista de público del grupo de anuncios a la que se hace referencia en la consulta.
`ad_group_bid_modifier`	`AdGroupBidModifier` Es el modificador de ofertas al que se hace referencia en la consulta.
`ad_group_criterion`	`AdGroupCriterion` Es el criterio al que se hace referencia en la consulta.
`ad_group_criterion_effective_label`	`AdGroupCriterionEffectiveLabel` Es la etiqueta de vigencia del criterio del grupo de anuncios a la que se hace referencia en la consulta.
`ad_group_criterion_label`	`AdGroupCriterionLabel` La etiqueta del criterio del grupo de anuncios a la que se hace referencia en la consulta.
`ad_group_effective_label`	`AdGroupEffectiveLabel` La etiqueta efectiva del grupo de anuncios a la que se hace referencia en la consulta.
`ad_group_label`	`AdGroupLabel` La etiqueta del grupo de anuncios a la que se hace referencia en la búsqueda.
`age_range_view`	`AgeRangeView` Es la vista de rango de edad a la que se hace referencia en la consulta.
`asset`	`Asset` Es el activo al que se hace referencia en la consulta.
`asset_group_asset`	`AssetGroupAsset` El recurso del grupo de recursos al que se hace referencia en la consulta.
`asset_group_signal`	`AssetGroupSignal` El indicador de grupo de recursos al que se hace referencia en la consulta.
`asset_group_listing_group_filter`	`AssetGroupListingGroupFilter` El filtro de grupo de fichas del grupo de recursos al que se hace referencia en la consulta.
`asset_group_top_combination_view`	`AssetGroupTopCombinationView` La vista de combinación principal del grupo de recursos a la que se hace referencia en la consulta.
`asset_group`	`AssetGroup` Es el grupo de recursos al que se hace referencia en la consulta.
`asset_set_asset`	`AssetSetAsset` El conjunto de recursos al que se hace referencia en la consulta.
`asset_set`	`AssetSet` Es el conjunto de recursos al que se hace referencia en la consulta.
`bidding_strategy`	`BiddingStrategy` Indica la estrategia de ofertas a la que se hace referencia en la búsqueda.
`campaign_budget`	`CampaignBudget` Es el presupuesto de la campaña al que se hace referencia en la consulta.
`campaign`	`Campaign` Es la campaña a la que se hace referencia en la consulta.
`campaign_asset`	`CampaignAsset` El recurso de campaña al que se hace referencia en la búsqueda.
`campaign_asset_set`	`CampaignAssetSet` Es el conjunto de recursos de campaña al que se hace referencia en la consulta.
`campaign_audience_view`	`CampaignAudienceView` Es la vista de público de la campaña a la que se hace referencia en la búsqueda.
`campaign_criterion`	`CampaignCriterion` El criterio de campaña al que se hace referencia en la búsqueda.
`campaign_effective_label`	`CampaignEffectiveLabel` La etiqueta de campaña efectiva a la que se hace referencia en la consulta.
`campaign_label`	`CampaignLabel` Es la etiqueta de la campaña a la que se hace referencia en la búsqueda.
`cart_data_sales_view`	`CartDataSalesView` La vista de ventas de datos del carrito a la que se hace referencia en la consulta
`audience`	`Audience` Es el público al que se hace referencia en la consulta.
`conversion_action`	`ConversionAction` Es la acción de conversión a la que se hace referencia en la consulta.
`conversion_custom_variable`	`ConversionCustomVariable` Es la variable personalizada de conversión a la que se hace referencia en la consulta.
`customer`	`Customer` Es el cliente al que se hace referencia en la consulta.
`customer_asset`	`CustomerAsset` El recurso del cliente al que se hace referencia en la consulta.
`customer_asset_set`	`CustomerAssetSet` Es el conjunto de recursos del cliente al que se hace referencia en la consulta.
`accessible_bidding_strategy`	`AccessibleBiddingStrategy` La estrategia de ofertas a la que se hace referencia en la consulta.
`customer_manager_link`	`CustomerManagerLink` El CustomerManagerLink al que se hace referencia en la consulta.
`customer_client`	`CustomerClient` El CustomerClient al que se hace referencia en la consulta.
`dynamic_search_ads_search_term_view`	`DynamicSearchAdsSearchTermView` La vista de términos de búsqueda de anuncios dinámicos de búsqueda a la que se hace referencia en la consulta
`gender_view`	`GenderView` La vista de género a la que se hace referencia en la consulta.
`geo_target_constant`	`GeoTargetConstant` La constante de segmentación geográfica a la que se hace referencia en la consulta.
`keyword_view`	`KeywordView` La vista de palabras clave a la que se hace referencia en la consulta.
`label`	`Label` Es la etiqueta a la que se hace referencia en la consulta.
`language_constant`	`LanguageConstant` La constante de lenguaje a la que se hace referencia en la consulta.
`location_view`	`LocationView` Es la vista de ubicación a la que se hace referencia en la consulta.
`product_bidding_category_constant`	`ProductBiddingCategoryConstant` Es la categoría de ofertas del producto a la que se hace referencia en la consulta.
`product_group_view`	`ProductGroupView` La vista del grupo de productos a la que se hace referencia en la consulta.
`shopping_performance_view`	`ShoppingPerformanceView` Es la vista de rendimiento de Shopping a la que se hace referencia en la consulta.
`user_list`	`UserList` La lista de usuarios a la que se hace referencia en la consulta.
`user_location_view`	`UserLocationView` Es la vista de ubicación del usuario a la que se hace referencia en la consulta.
`webpage_view`	`WebpageView` Es la vista de la página web a la que se hace referencia en la consulta.
`visit`	`Visit` La visita a nivel del evento a la que se hace referencia en la consulta.
`conversion`	`Conversion` Es la conversión a nivel del evento a la que se hace referencia en la consulta.
`metrics`	`Metrics` Las métricas
`segments`	`Segments` Los segmentos.
`custom_columns[]`	`Value` Las columnas personalizadas

SearchSearchAds360FieldsRequest

Mensaje de solicitud para SearchAds360FieldService.SearchSearchAds360Fields.

Campos

Campos
`query`	`string` Obligatorio. Es la cadena de consulta.
`page_token`	`string` Es el token de la página que se recuperará. Si no se especifica, se mostrará la primera página de resultados. Usa el valor obtenido de `next_page_token` en la respuesta anterior para solicitar la siguiente página de resultados.
`page_size`	`int32` Es la cantidad de elementos que se recuperarán en una sola página. Cuando se solicita una página demasiado grande, el servidor puede decidir limitar aún más la cantidad de recursos que se muestran.

query

string

Obligatorio. Es la cadena de consulta.

page_token

string

Es el token de la página que se recuperará. Si no se especifica, se mostrará la primera página de resultados. Usa el valor obtenido de next_page_token en la respuesta anterior para solicitar la siguiente página de resultados.

page_size

int32

Es la cantidad de elementos que se recuperarán en una sola página. Cuando se solicita una página demasiado grande, el servidor puede decidir limitar aún más la cantidad de recursos que se muestran.

SearchSearchAds360FieldsResponse

Mensaje de respuesta para SearchAds360FieldService.SearchSearchAds360Fields.

Campos

Campos
`results[]`	`SearchAds360Field` Es la lista de campos que coincidieron con la consulta.
`next_page_token`	`string` Es el token de paginación que se usa para recuperar la siguiente página de resultados. Pasa el contenido de esta cadena como el atributo `page_token` de la siguiente solicitud. No se muestra `next_page_token` para la última página.
`total_results_count`	`int64` Cantidad total de resultados que coinciden con la consulta ignorando la cláusula LIMIT.

results[]

SearchAds360Field

Es la lista de campos que coincidieron con la consulta.

next_page_token

string

Es el token de paginación que se usa para recuperar la siguiente página de resultados. Pasa el contenido de esta cadena como el atributo page_token de la siguiente solicitud. No se muestra next_page_token para la última página.

total_results_count

int64

Cantidad total de resultados que coinciden con la consulta ignorando la cláusula LIMIT.

SearchSearchAds360Request

Mensaje de solicitud para SearchAds360Service.Search.

Campos
`customer_id`	`string` Obligatorio. El ID del cliente sobre el que se consulta.
`query`	`string` Obligatorio. Es la cadena de consulta.
`page_token`	`string` Es el token de la página que se recuperará. Si no se especifica, se mostrará la primera página de resultados. Usa el valor obtenido de `next_page_token` en la respuesta anterior para solicitar la siguiente página de resultados.
`page_size`	`int32` Cantidad de elementos que se deben recuperar en una sola página. Cuando se solicita una página demasiado grande, el servidor puede decidir limitar aún más el número de recursos mostrados.
`validate_only`	`bool` Si es verdadero, la solicitud se valida, pero no se ejecuta.
`return_total_results_count`	`bool` Si es verdadero, la respuesta incluirá la cantidad total de resultados que coincidan con la consulta sin tener en cuenta la cláusula LIMIT. El valor predeterminado es falso.
`summary_row_setting`	`SummaryRowSetting` Determina si se mostrará una fila de resumen. De forma predeterminada, no se muestra la fila de resumen. Si se solicita, la fila de resumen se enviará en una respuesta por sí sola después de que se muestren todos los demás resultados de la consulta.

SearchSearchAds360Response

Mensaje de respuesta para SearchAds360Service.Search.

Campos
`results[]`	`SearchAds360Row` Es la lista de filas que coincidieron con la consulta.
`next_page_token`	`string` Es el token de paginación que se usa para recuperar la siguiente página de resultados. Pasa el contenido de esta cadena como el atributo `page_token` de la siguiente solicitud. No se muestra `next_page_token` para la última página.
`total_results_count`	`int64` Cantidad total de resultados que coinciden con la consulta ignorando la cláusula LIMIT.
`field_mask`	`FieldMask` Es un FieldMask que representa los campos que solicitó el usuario.
`summary_row`	`SearchAds360Row` Es la fila de resumen que contiene el resumen de las métricas en los resultados. El resumen de métricas significa la agregación de métricas en todos los resultados. Aquí, la agregación puede ser la suma, el promedio, la tasa, etcétera.
`custom_column_headers[]`	`CustomColumnHeader` Los encabezados de las columnas personalizadas en los resultados.
`conversion_custom_metric_headers[]`	`ConversionCustomMetricHeader` Los encabezados de las métricas personalizadas de conversión en los resultados.
`conversion_custom_dimension_headers[]`	`ConversionCustomDimensionHeader` Los encabezados de las dimensiones personalizadas de conversión en los resultados
`raw_event_conversion_metric_headers[]`	`RawEventConversionMetricHeader` Los encabezados de las métricas de conversión de eventos sin procesar en los resultados.
`raw_event_conversion_dimension_headers[]`	`RawEventConversionDimensionHeader` Los encabezados de las dimensiones de conversión de eventos sin procesar en los resultados

SearchSearchAds360StreamRequest

Mensaje de solicitud para SearchAds360Service.SearchStream.

Campos
`customer_id`	`string` Obligatorio. El ID del cliente sobre el que se consulta.
`query`	`string` Obligatorio. La cadena de consulta.
`batch_size`	`int32` Es la cantidad de filas que se devuelven en cada lote de respuesta de flujo. Cuando se solicita un lote demasiado grande, el servidor puede decidir limitar aún más la cantidad de filas que se muestran.
`summary_row_setting`	`SummaryRowSetting` Determina si se mostrará una fila de resumen. De forma predeterminada, no se muestra la fila de resumen. Si se solicita, la fila de resumen se enviará sola como respuesta después de que se muestren todos los demás resultados de la consulta.

SearchSearchAds360StreamResponse

Mensaje de respuesta para SearchAds360Service.SearchStream.

Campos
`results[]`	`SearchAds360Row` Es la lista de filas que coincidieron con la consulta.
`field_mask`	`FieldMask` FieldMask que representa qué campos solicitó el usuario.
`summary_row`	`SearchAds360Row` Es la fila de resumen que contiene el resumen de las métricas en los resultados. El resumen de métricas significa la agregación de métricas en todos los resultados. Aquí, la agregación puede ser la suma, el promedio, la tasa, etcétera.
`custom_column_headers[]`	`CustomColumnHeader` Los encabezados de las columnas personalizadas en los resultados.
`conversion_custom_metric_headers[]`	`ConversionCustomMetricHeader` Los encabezados de las métricas personalizadas de conversiones en los resultados
`conversion_custom_dimension_headers[]`	`ConversionCustomDimensionHeader` Los encabezados de la dimensión personalizada de conversión en los resultados
`raw_event_conversion_metric_headers[]`	`RawEventConversionMetricHeader` Los encabezados de las métricas de conversión de eventos sin procesar en los resultados
`raw_event_conversion_dimension_headers[]`	`RawEventConversionDimensionHeader` Los encabezados de las dimensiones de conversión de eventos sin procesar en los resultados
`request_id`	`string` El ID único de la solicitud que se usa para depurar.