Package google.ads.searchads360.v0.services

Índice

CustomColumnService

Servicio para administrar columnas personalizadas.

GetCustomColumn

rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)

Muestra la columna personalizada solicitada en detalle.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)

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

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

CustomerService

Servicio para administrar clientes.

ListAccessibleCustomers

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

Muestra los nombres de los 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

Permisos 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

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

Devuelve solo el campo solicitado.

Lista de errores arrojados: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)

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

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

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

SearchAds360Service

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

Buscar

rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)

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

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

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)

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

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

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

ConversionCustomDimensionHeader

Mensaje del encabezado de la dimensión personalizada de conversión.

Campos
id

int64

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

name

string

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

ConversionCustomMetricHeader

Mensaje del encabezado de la métrica personalizada de conversión.

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 conversión.

CustomColumnHeader

Mensaje para el encabezado de la columna personalizada.

Campos
id

int64

El ID de la columna personalizada.

name

string

Es el nombre de la columna personalizada definida por 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
resource_name

string

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

GetSearchAds360FieldRequest

Mensaje de solicitud para SearchAds360FieldService.GetSearchAds360Field.

Campos
resource_name

string

Obligatorio. El nombre del recurso del campo que se obtendrá.

ListAccessibleCustomersRequest

Este tipo no tiene campos.

Mensaje de solicitud para CustomerService.ListAccessibleCustomers.

ListAccessibleCustomersResponse

Mensaje de respuesta para CustomerService.ListAccessibleCustomers.

Campos
resource_names[]

string

Nombre de recurso de los clientes a los que puede acceder directamente el usuario que autentica la llamada

ListCustomColumnsRequest

Mensaje de solicitud para CustomColumnService.ListCustomColumns

Campos
customer_id

string

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

ListCustomColumnsResponse

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

Campos
custom_columns[]

CustomColumn

Las columnas personalizadas que son propiedad del cliente proporcionado

RawEventConversionDimensionHeader

Mensaje del encabezado de dimensión de conversión de eventos sin procesar.

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.

RawEventConversionMetricHeader

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

Campos
id

int64

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

name

string

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

SearchAds360Row

Una fila que se muestra de la consulta.

Campos
ad_group

AdGroup

Es el grupo de anuncios al que se hace referencia en la consulta.

ad_group_ad

AdGroupAd

El anuncio al 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

Es el conjunto de recursos del grupo de anuncios al que se hace referencia en la consulta.

ad_group_audience_view

AdGroupAudienceView

Es la vista del 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_label

AdGroupCriterionLabel

La etiqueta de criterio 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 consulta.

age_range_view

AgeRangeView

La vista de rango de edad a la que se hace referencia en la consulta.

asset

Asset

El recurso 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 del grupo de recursos al que se hace referencia en la consulta.

asset_group_listing_group_filter

AssetGroupListingGroupFilter

El filtro de grupo de fichas y elementos al que se hace referencia en la consulta.

asset_group_top_combination_view

AssetGroupTopCombinationView

La vista de combinación superior del grupo de recursos a la que se hace referencia en la consulta.

asset_group

AssetGroup

El grupo de recursos al que se hace referencia en la consulta.

asset_set_asset

AssetSetAsset

El recurso del conjunto de recursos al que se hace referencia en la consulta.

asset_set

AssetSet

El conjunto de recursos al que se hace referencia en la consulta.

bidding_strategy

BiddingStrategy

Es la estrategia de ofertas a la que se hace referencia en la búsqueda.

campaign_budget

CampaignBudget

El presupuesto de la campaña al que se hace referencia en la consulta.

campaign

Campaign

La campaña a la que se hace referencia en la búsqueda.

campaign_asset

CampaignAsset

El recurso de campaña al que se hace referencia en la consulta.

campaign_asset_set

CampaignAssetSet

El conjunto de recursos de campaña al que se hace referencia en la consulta.

campaign_audience_view

CampaignAudienceView

Es la vista del público de la campaña a la que se hace referencia en la consulta.

campaign_criterion

CampaignCriterion

Es el criterio de campaña al que se hace referencia en la consulta.

campaign_label

CampaignLabel

La etiqueta de 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

El público al que se hace referencia en la consulta.

conversion_action

ConversionAction

La acción de conversión a la que se hace referencia en la consulta.

conversion_custom_variable

ConversionCustomVariable

La variable personalizada de conversión a la que se hace referencia en la consulta.

customer

Customer

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

El conjunto de recursos del cliente al que se hace referencia en la consulta.

accessible_bidding_strategy

AccessibleBiddingStrategy

Es la estrategia de ofertas accesible a la 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

Es la vista de los términos de búsqueda de los 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

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

La vista de la 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

La vista del rendimiento de compras 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.

webpage_view

WebpageView

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

La conversión a nivel del evento a la que se hace referencia en la búsqueda.

metrics

Metrics

Las métricas

segments

Segments

Los segmentos.

custom_columns[]

Value

Las columnas personalizadas

SearchSearchAds360FieldsRequest

Mensaje de solicitud para SearchAds360FieldService.SearchSearchAds360Fields.

Campos
query

string

Obligatorio. Cadena de consulta

page_token

string

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 página siguiente de resultados.

page_size

int32

Cantidad de elementos que se recuperan 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
results[]

SearchAds360Field

La lista de campos que coincidieron con la consulta.

next_page_token

string

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

Número 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 que se consulta.

query

string

Obligatorio. Cadena de consulta

page_token

string

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 página siguiente de resultados.

page_size

int32

Cantidad de elementos que se recuperan 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.

validate_only

bool

Si es verdadero, la solicitud se valida, pero no se ejecuta.

return_total_results_count

bool

Si es verdadero, el número total de resultados que coinciden con la consulta ignorando la cláusula LIMIT se incluirá en la respuesta. 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á por sí misma en una respuesta después de que se muestren todos los demás resultados de la consulta.

SearchSearchAds360Response

Mensaje de respuesta para SearchAds360Service.Search.

Campos
results[]

SearchAds360Row

La lista de filas que coincidieron con la consulta.

next_page_token

string

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

Número total de resultados que coinciden con la consulta ignorando la cláusula LIMIT.

field_mask

FieldMask

FieldMask que representa los campos que solicitó el usuario.

summary_row

SearchAds360Row

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, que puede ser suma, promedio, tasa, etcétera.

custom_column_headers[]

CustomColumnHeader

Son los encabezados de las columnas personalizadas en los resultados.

conversion_custom_metric_headers[]

ConversionCustomMetricHeader

Son los encabezados de las métricas personalizadas de conversión en los resultados.

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

Son los encabezados de las dimensiones personalizadas de conversión en los resultados.

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

Son los encabezados de las métricas de conversión de eventos sin procesar en los resultados.

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

Son los encabezados de las dimensiones de conversión de eventos sin procesar que aparecen en los resultados.

SearchSearchAds360StreamRequest

Mensaje de solicitud para SearchAds360Service.SearchStream.

Campos
customer_id

string

Obligatorio. El ID del cliente que se consulta.

query

string

Obligatorio. Cadena de consulta

batch_size

int32

La cantidad de filas que se muestran en cada lote de respuestas de transmisión. 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á por sí misma en una 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

La lista de filas que coincidieron con la consulta.

field_mask

FieldMask

FieldMask que representa los campos que solicitó el usuario.

summary_row

SearchAds360Row

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, que puede ser suma, promedio, tasa, etc.

custom_column_headers[]

CustomColumnHeader

Son los encabezados de las columnas personalizadas en los resultados.

conversion_custom_metric_headers[]

ConversionCustomMetricHeader

Son los encabezados de las métricas personalizadas de conversión en los resultados.

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

Son los encabezados de la dimensión personalizada de la conversión en los resultados.

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

Son los encabezados de las métricas de conversión de eventos sin procesar en los resultados.

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

Son los encabezados de las dimensiones de conversión de eventos sin procesar que aparecen en los resultados.

request_id

string

El ID único de la solicitud que se utiliza con fines de depuración.