Package google.ads.searchads360.v0.services

Índice

CustomColumnService

Servicio para administrar columnas personalizadas.

GetCustomColumn

rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)

Devuelve la columna personalizada solicitada con todos sus detalles.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)

Devuelve todas las columnas personalizadas asociadas con el cliente con todos los detalles.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

CustomerService

Servicio para administrar clientes.

ListAccessibleCustomers

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

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

Lista de errores que se arrojan: AuthenticationError, AuthorizationError, HeaderError, InternalError, QuotaError y RequestError

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

SearchAds360FieldService

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

GetSearchAds360Field

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

Devuelve solo el campo solicitado.

Lista de errores que se arrojan: AuthenticationError, AuthorizationError, HeaderError, InternalError, QuotaError y RequestError

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)

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

Lista de errores que se arrojan: AuthenticationError, AuthorizationError, HeaderError, InternalError, QueryError, QuotaError y RequestError

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

SearchAds360Service

Servicio para recuperar datos y métricas en todos los recursos.

Buscar

rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)

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

Lista de errores que se arrojan: AuthenticationError, AuthorizationError, ChangeEventError, ChangeStatusError, ClickViewError, HeaderError, InternalError, QueryError, QuotaError y RequestError

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)

Devuelve todas las filas que coinciden con la consulta de la transmisión de búsqueda.

Lista de errores que se arrojan: AuthenticationError, AuthorizationError, ChangeEventError, ChangeStatusError, ClickViewError, HeaderError, InternalError, QueryError, QuotaError y RequestError

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

ConversionCustomDimensionHeader

Es el mensaje para el encabezado de la dimensión personalizada de conversión.

Campos
id

int64

Es 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 para el encabezado de la métrica personalizada de conversión.

Campos
id

int64

Es 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

Es el mensaje para el encabezado de la columna personalizada.

Campos
id

int64

Es el ID de la columna personalizada.

name

string

Nombre definido por el usuario de la columna personalizada.

references_metrics

bool

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

GetCustomColumnRequest

Mensaje de solicitud para CustomColumnService.GetCustomColumn.

Campos
resource_name

string

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

GetSearchAds360FieldRequest

Mensaje de solicitud para SearchAds360FieldService.GetSearchAds360Field.

Campos
resource_name

string

Obligatorio. Es 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

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

ListCustomColumnsRequest

Mensaje de solicitud para CustomColumnService.ListCustomColumns

Campos
customer_id

string

Obligatorio. Es el ID del cliente al que se aplica la operación de lista CustomColumn.

ListCustomColumnsResponse

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

Campos
custom_columns[]

CustomColumn

Son las columnas personalizadas que posee el cliente proporcionado.

RawEventConversionDimensionHeader

Es el mensaje del encabezado de la 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

Es el mensaje para el encabezado de la métrica de conversiones 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 métrica del evento sin procesar.

SearchAds360Row

Es una fila devuelta de la consulta.

Campos
ad_group

AdGroup

Es el grupo de anuncios al que se hace referencia en la búsqueda.

ad_group_ad

AdGroupAd

Es el anuncio al que se hace referencia en la búsqueda.

ad_group_ad_effective_label

AdGroupAdEffectiveLabel

Es la etiqueta efectiva del anuncio del grupo de anuncios a la que se hace referencia en la búsqueda.

ad_group_ad_label

AdGroupAdLabel

Es la etiqueta del anuncio del grupo de anuncios a la que se hace referencia en la búsqueda.

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 búsqueda.

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 búsqueda.

ad_group_criterion_effective_label

AdGroupCriterionEffectiveLabel

Es la etiqueta efectiva del criterio del grupo de anuncios a la que se hace referencia en la consulta.

ad_group_criterion_label

AdGroupCriterionLabel

Es la etiqueta del criterio del grupo de anuncios a la que se hace referencia en la búsqueda.

ad_group_effective_label

AdGroupEffectiveLabel

Es la etiqueta efectiva del grupo de anuncios a la que se hace referencia en la consulta.

ad_group_label

AdGroupLabel

Es la etiqueta del grupo de anuncios a la que se hace referencia en la búsqueda.

age_range_view

AgeRangeView

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

asset

Asset

Es el activo al que se hace referencia en la búsqueda.

asset_group_asset

AssetGroupAsset

Es el recurso del grupo de recursos al que se hace referencia en la búsqueda.

asset_group_signal

AssetGroupSignal

Es el indicador del grupo de recursos al que se hace referencia en la búsqueda.

asset_group_listing_group_filter

AssetGroupListingGroupFilter

Es el filtro de grupo de fichas y elementos del grupo de recursos al que se hace referencia en la consulta.

asset_group_top_combination_view

AssetGroupTopCombinationView

Es la vista de la combinación principal del grupo de recursos a la que se hace referencia en la búsqueda.

asset_group

AssetGroup

Es el grupo de recursos al que se hace referencia en la búsqueda.

asset_set_asset

AssetSetAsset

Es el recurso del conjunto de recursos al que se hace referencia en la búsqueda.

asset_set

AssetSet

Es el conjunto de recursos al que se hace referencia en la búsqueda.

bidding_strategy

BiddingStrategy

Es 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 búsqueda.

campaign

Campaign

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

campaign_asset

CampaignAsset

Es el recurso de la campaña al que se hace referencia en la búsqueda.

campaign_asset_set

CampaignAssetSet

Es el conjunto de recursos de la campaña al que se hace referencia en la búsqueda.

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 búsqueda.

campaign_effective_label

CampaignEffectiveLabel

Es la etiqueta efectiva de la campaña 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

Es 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 búsqueda.

conversion_action

ConversionAction

Es la acción de conversión a la que se hace referencia en la búsqueda.

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 búsqueda.

customer_asset

CustomerAsset

Es el recurso del cliente al que se hace referencia en la búsqueda.

customer_asset_set

CustomerAssetSet

Es el conjunto de recursos del cliente al que se hace referencia en la búsqueda.

accessible_bidding_strategy

AccessibleBiddingStrategy

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

customer_client

CustomerClient

Es el CustomerClient al que se hace referencia en la consulta.

dynamic_search_ads_search_term_view

DynamicSearchAdsSearchTermView

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

Es la vista de género a la que se hace referencia en la consulta.

geo_target_constant

GeoTargetConstant

Es la constante de segmentación geográfica a la que se hace referencia en la búsqueda.

keyword_view

KeywordView

Es la vista de palabras clave a la que se hace referencia en la búsqueda.

label

Label

Es la etiqueta a la que se hace referencia en la búsqueda.

language_constant

LanguageConstant

Es la constante de idioma a la que se hace referencia en la búsqueda.

location_view

LocationView

Es la vista de ubicación a la que se hace referencia en la búsqueda.

product_bidding_category_constant

ProductBiddingCategoryConstant

Es la categoría de ofertas del producto a la que se hace referencia en la búsqueda.

product_group_view

ProductGroupView

Es la vista del grupo de productos a la que se hace referencia en la búsqueda.

shopping_performance_view

ShoppingPerformanceView

Es la vista del rendimiento de Shopping a la que se hace referencia en la consulta.

user_list

UserList

Es la lista de usuarios a la que se hace referencia en la consulta.

user_location_view

UserLocationView

Es la vista de la 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 búsqueda.

visit

Visit

Es la visita a nivel del evento a la que se hace referencia en la búsqueda.

conversion

Conversion

Es la conversión a nivel del evento a la que se hace referencia en la consulta.

metrics

Metrics

Son las métricas.

segments

Segments

Son los segmentos.

custom_columns[]

Value

Son las columnas personalizadas.

SearchSearchAds360FieldsRequest

Mensaje de solicitud para SearchAds360FieldService.SearchSearchAds360Fields.

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 devolverá 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
results[]

SearchAds360Field

Es la lista de campos que coincidieron con la búsqueda.

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 próxima solicitud. next_page_token no se devuelve para la última página.

total_results_count

int64

Es la cantidad total de resultados que coinciden con la búsqueda, sin tener en cuenta la cláusula LIMIT.

SearchSearchAds360Request

Mensaje de solicitud para SearchAds360Service.Search.

Campos
customer_id

string

Obligatorio. Es el ID del cliente sobre el que se realiza la 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 devolverá 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.

validate_only

bool

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

return_total_results_count

bool

Si es verdadero, en la respuesta se incluirá la cantidad total de resultados que coinciden con la búsqueda, sin tener en cuenta la cláusula LIMIT. El valor predeterminado es falso.

summary_row_setting

SummaryRowSetting

Determina si se devolverá una fila de resumen. De forma predeterminada, no se devuelve 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 búsqueda.

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 próxima solicitud. next_page_token no se devuelve para la última página.

total_results_count

int64

Es la cantidad total de resultados que coinciden con la búsqueda, sin tener en cuenta la cláusula LIMIT.

field_mask

FieldMask

Es un objeto 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 las métricas significa la agregación de las métricas en todos los resultados. Aquí, la agregación podría ser la suma, el promedio, la 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 conversiones 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 conversiones de eventos sin procesar en los resultados.

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

Son los encabezados de las dimensiones de conversión del evento sin procesar en los resultados.

SearchSearchAds360StreamRequest

Mensaje de solicitud para SearchAds360Service.SearchStream.

Campos
customer_id

string

Obligatorio. Es el ID del cliente sobre el que se realiza la consulta.

query

string

Obligatorio. Es la cadena de consulta.

batch_size

int32

Es la cantidad de filas que se devuelven en cada lote de respuesta 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 devolverá una fila de resumen. De forma predeterminada, no se devuelve 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 búsqueda.

SearchSearchAds360StreamResponse

Mensaje de respuesta para SearchAds360Service.SearchStream.

Campos
results[]

SearchAds360Row

Es la lista de filas que coincidieron con la consulta.

field_mask

FieldMask

Es un objeto 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 las métricas significa la agregación de las métricas en todos los resultados. Aquí, la agregación podría ser la suma, el promedio, la 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 conversiones en los resultados.

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

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

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

Son los encabezados de las métricas de conversiones de eventos sin procesar en los resultados.

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

Son los encabezados de las dimensiones de conversión del evento sin procesar en los resultados.

request_id

string

Es el ID único de la solicitud que se usa para la depuración.