La nouvelle API Search Ads 360 Reporting est désormais disponible. Rejoignez le groupe Google searchads-api-announcements pour vous tenir informé des améliorations et versions à venir.

Cette page a été traduite par l'API Cloud Translation.

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 permettant de gérer les colonnes personnalisées

GetCustomColumn

GetCustomColumn
`rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)` Affiche la colonne personnalisée demandée en détail. Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : `https://www.googleapis.com/auth/doubleclicksearch`

rpc GetCustomColumn(GetCustomColumnRequest) returns (CustomColumn)

Affiche la colonne personnalisée demandée en détail.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

ListCustomColumns

ListCustomColumns
`rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)` Renvoie toutes les colonnes personnalisées associées au client en détail. Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : `https://www.googleapis.com/auth/doubleclicksearch`

rpc ListCustomColumns(ListCustomColumnsRequest) returns (ListCustomColumnsResponse)

Renvoie toutes les colonnes personnalisées associées au client en détail.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

CustomerService

Service de gestion des clients

ListAccessibleCustomers

ListAccessibleCustomers
`rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)` Renvoie les noms de ressources des clients directement accessibles par l'utilisateur qui authentifie l'appel. Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : `https://www.googleapis.com/auth/doubleclicksearch`

rpc ListAccessibleCustomers(ListAccessibleCustomersRequest) returns (ListAccessibleCustomersResponse)

Renvoie les noms de ressources des clients directement accessibles par l'utilisateur qui authentifie l'appel.

Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

SearchAds360FieldService

Service permettant d'extraire les champs de l'API Search Ads 360.

GetSearchAds360Field

GetSearchAds360Field
`rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)` Renvoie uniquement le champ demandé. Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : `https://www.googleapis.com/auth/doubleclicksearch`

rpc GetSearchAds360Field(GetSearchAds360FieldRequest) returns (SearchAds360Field)

Renvoie uniquement le champ demandé.

Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

SearchSearchAds360Fields

SearchSearchAds360Fields
`rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)` Renvoie tous les champs correspondant à la requête de recherche. Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : `https://www.googleapis.com/auth/doubleclicksearch`

rpc SearchSearchAds360Fields(SearchSearchAds360FieldsRequest) returns (SearchSearchAds360FieldsResponse)

Renvoie tous les champs correspondant à la requête de recherche.

Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

SearchAds360Service

Service permettant d'extraire des données et des métriques pour l'ensemble des ressources

Rechercher

Rechercher
`rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)` Renvoie toutes les lignes correspondant à la requête de recherche. Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : `https://www.googleapis.com/auth/doubleclicksearch`

rpc Search(SearchSearchAds360Request) returns (SearchSearchAds360Response)

Renvoie toutes les lignes correspondant à la requête de recherche.

Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

SearchStream

SearchStream
`rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)` Renvoie toutes les lignes correspondant à la requête de flux de recherche. Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError Champs d'application des autorisations Requiert le niveau d'accès OAuth suivant : `https://www.googleapis.com/auth/doubleclicksearch`

rpc SearchStream(SearchSearchAds360StreamRequest) returns (SearchSearchAds360StreamResponse)

Renvoie toutes les lignes correspondant à la requête de flux de recherche.

Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

ConversionCustomDimensionHeader

Message pour l'en-tête de dimension personnalisée de conversion.

Champs

Champs
`id`	`int64` ID de la dimension personnalisée pour la conversion.
`name`	`string` Nom de la dimension personnalisée de conversion défini par l'utilisateur.

id

int64

ID de la dimension personnalisée pour la conversion.

name

string

Nom de la dimension personnalisée de conversion défini par l'utilisateur.

ConversionCustomMetricHeader

Message pour l'en-tête de la métrique personnalisée de conversion.

Champs

Champs
`id`	`int64` ID de la métrique personnalisée de conversion.
`name`	`string` Nom de la métrique personnalisée de conversion défini par l'utilisateur.

id

int64

ID de la métrique personnalisée de conversion.

name

string

Nom de la métrique personnalisée de conversion défini par l'utilisateur.

CustomColumnHeader

Message pour l'en-tête de colonne personnalisé.

Champs

Champs
`id`	`int64` ID de la colonne personnalisée.
`name`	`string` Nom de la colonne personnalisée défini par l'utilisateur.
`references_metrics`	`bool` Vrai quand la colonne personnalisée fait référence à des métriques.

id

int64

ID de la colonne personnalisée.

name

string

Nom de la colonne personnalisée défini par l'utilisateur.

references_metrics

bool

Vrai quand la colonne personnalisée fait référence à des métriques.

GetCustomColumnRequest

Message de requête pour CustomColumnService.GetCustomColumn.

Champs

Champs
`resource_name`	`string` Obligatoire. Nom de ressource de la colonne personnalisée à récupérer.

resource_name

string

Obligatoire. Nom de ressource de la colonne personnalisée à récupérer.

GetSearchAds360FieldRequest

Message de requête pour SearchAds360FieldService.GetSearchAds360Field.

Champs

Champs
`resource_name`	`string` Obligatoire. Nom de ressource du champ à obtenir.

resource_name

string

Obligatoire. Nom de ressource du champ à obtenir.

ListAccessibleCustomersRequest

Ce type ne comporte aucun champ.

Message de requête pour CustomerService.ListAccessibleCustomers.

ListAccessibleCustomersResponse

Message de réponse pour CustomerService.ListAccessibleCustomers.

Champs

Champs
`resource_names[]`	`string` Nom de ressource des clients directement accessible par l'utilisateur qui authentifie l'appel.

resource_names[]

string

Nom de ressource des clients directement accessible par l'utilisateur qui authentifie l'appel.

ListCustomColumnsRequest

Message de requête pour CustomColumnService.ListCustomColumns

Champs

Champs
`customer_id`	`string` Obligatoire. ID du client auquel appliquer l'opération de liste CustomColumn.

customer_id

string

Obligatoire. ID du client auquel appliquer l'opération de liste CustomColumn.

ListCustomColumnsResponse

Message de réponse pour la récupération de toutes les colonnes personnalisées associées à un client.

Champs

Champs
`custom_columns[]`	`CustomColumn` Colonne personnalisée dont le client indiqué est propriétaire.

custom_columns[]

CustomColumn

Colonne personnalisée dont le client indiqué est propriétaire.

RawEventConversionDimensionHeader

Message pour l'en-tête de la dimension de conversion d'événement brut.

Champs

Champs
`id`	`int64` ID de la variable personnalisée de conversion.
`name`	`string` Nom défini par l'utilisateur de la dimension d'événement brut.

id

int64

ID de la variable personnalisée de conversion.

name

string

Nom défini par l'utilisateur de la dimension d'événement brut.

RawEventConversionMetricHeader

Message pour l'en-tête de la métrique de conversion d'événement brut.

Champs

Champs
`id`	`int64` ID de la variable personnalisée de conversion.
`name`	`string` Nom défini par l'utilisateur de la métrique d'événement brut.

id

int64

ID de la variable personnalisée de conversion.

name

string

Nom défini par l'utilisateur de la métrique d'événement brut.

SearchAds360Row

Ligne renvoyée par la requête.

Champs
`ad_group`	`AdGroup` Groupe d'annonces référencé dans la requête.
`ad_group_ad`	`AdGroupAd` Annonce référencée dans la requête.
`ad_group_ad_label`	`AdGroupAdLabel` Libellé d'annonce du groupe d'annonces référencé dans la requête.
`ad_group_asset`	`AdGroupAsset` Composant du groupe d'annonces référencé dans la requête.
`ad_group_asset_set`	`AdGroupAssetSet` Ensemble de composants du groupe d'annonces référencé dans la requête.
`ad_group_audience_view`	`AdGroupAudienceView` Vue d'audience du groupe d'annonces référencée dans la requête.
`ad_group_bid_modifier`	`AdGroupBidModifier` Modificateur d'enchères référencé dans la requête.
`ad_group_criterion`	`AdGroupCriterion` Critère référencé dans la requête.
`ad_group_criterion_label`	`AdGroupCriterionLabel` Libellé du critère du groupe d'annonces référencé dans la requête.
`ad_group_label`	`AdGroupLabel` Libellé du groupe d'annonces référencé dans la requête.
`age_range_view`	`AgeRangeView` Vue de la tranche d'âge référencée dans la requête.
`asset`	`Asset` Élément référencé dans la requête.
`asset_group_asset`	`AssetGroupAsset` Asset du groupe de composants référencé dans la requête.
`asset_group_signal`	`AssetGroupSignal` Signal du groupe d'assets référencé dans la requête.
`asset_group_listing_group_filter`	`AssetGroupListingGroupFilter` Filtre de groupe de fiches (groupe de composants) référencé dans la requête.
`asset_group_top_combination_view`	`AssetGroupTopCombinationView` Vue des meilleures combinaisons de groupes d'assets référencée dans la requête.
`asset_group`	`AssetGroup` Groupe d'assets référencé dans la requête.
`asset_set_asset`	`AssetSetAsset` Asset de l'ensemble d'assets référencé dans la requête.
`asset_set`	`AssetSet` Ensemble de composants référencé dans la requête.
`bidding_strategy`	`BiddingStrategy` Stratégie d'enchères référencée dans la requête.
`campaign_budget`	`CampaignBudget` Budget de la campagne référencé dans la requête.
`campaign`	`Campaign` Campagne référencée dans la requête.
`campaign_asset`	`CampaignAsset` Composant de campagne référencé dans la requête.
`campaign_asset_set`	`CampaignAssetSet` Ensemble de composants de la campagne référencé dans la requête.
`campaign_audience_view`	`CampaignAudienceView` Vue d'audience de la campagne référencée dans la requête.
`campaign_criterion`	`CampaignCriterion` Critère de campagne référencé dans la requête.
`campaign_label`	`CampaignLabel` Libellé de la campagne référencé dans la requête.
`cart_data_sales_view`	`CartDataSalesView` Vue des ventes des données du panier référencée dans la requête.
`audience`	`Audience` Audience référencée dans la requête.
`conversion_action`	`ConversionAction` Action de conversion référencée dans la requête.
`conversion_custom_variable`	`ConversionCustomVariable` Variable personnalisée de conversion référencée dans la requête.
`customer`	`Customer` Client référencé dans la requête.
`customer_asset`	`CustomerAsset` Asset client référencé dans la requête.
`customer_asset_set`	`CustomerAssetSet` Ensemble de composants client référencé dans la requête.
`accessible_bidding_strategy`	`AccessibleBiddingStrategy` Stratégie d'enchères accessible référencée dans la requête.
`customer_manager_link`	`CustomerManagerLink` CustomerManagerLink référencé dans la requête.
`customer_client`	`CustomerClient` CustomerClient référencé dans la requête.
`dynamic_search_ads_search_term_view`	`DynamicSearchAdsSearchTermView` Vue des termes de recherche des annonces dynamiques du Réseau de Recherche référencée dans la requête.
`gender_view`	`GenderView` Vue par genre référencée dans la requête.
`geo_target_constant`	`GeoTargetConstant` Constante de cible géographique référencée dans la requête.
`keyword_view`	`KeywordView` Vue des mots clés référencée dans la requête.
`label`	`Label` Étiquette référencée dans la requête.
`language_constant`	`LanguageConstant` Constante de langue référencée dans la requête.
`location_view`	`LocationView` Vue de l'établissement référencée dans la requête.
`product_bidding_category_constant`	`ProductBiddingCategoryConstant` Catégorie d'enchères pour les produits référencée dans la requête.
`product_group_view`	`ProductGroupView` Vue du groupe de produits référencée dans la requête.
`shopping_performance_view`	`ShoppingPerformanceView` Vue des performances Shopping référencée dans la requête.
`user_list`	`UserList` Liste d'utilisateurs référencée dans la requête.
`webpage_view`	`WebpageView` Vue de la page Web référencée dans la requête.
`visit`	`Visit` Visite au niveau de l'événement référencée dans la requête.
`conversion`	`Conversion` Conversion au niveau de l'événement référencée dans la requête.
`metrics`	`Metrics` Les métriques.
`segments`	`Segments` Les segments.
`custom_columns[]`	`Value` Colonnes personnalisées

SearchSearchAds360FieldsRequest

Message de requête pour SearchAds360FieldService.SearchSearchAds360Fields.

Champs

Champs
`query`	`string` Obligatoire. Chaîne de requête.
`page_token`	`string` Jeton de la page à récupérer. Si aucune valeur n'est spécifiée, la première page de résultats est affichée. Pour demander la page de résultats suivante, utilisez la valeur obtenue à partir de `next_page_token` dans la réponse précédente.
`page_size`	`int32` Nombre d'éléments à récupérer sur une seule page. Lorsqu'une page trop volumineuse est demandée, le serveur peut décider de limiter davantage le nombre de ressources renvoyées.

query

string

Obligatoire. Chaîne de requête.

page_token

string

Jeton de la page à récupérer. Si aucune valeur n'est spécifiée, la première page de résultats est affichée. Pour demander la page de résultats suivante, utilisez la valeur obtenue à partir de next_page_token dans la réponse précédente.

page_size

int32

Nombre d'éléments à récupérer sur une seule page. Lorsqu'une page trop volumineuse est demandée, le serveur peut décider de limiter davantage le nombre de ressources renvoyées.

SearchSearchAds360FieldsResponse

Message de réponse pour SearchAds360FieldService.SearchSearchAds360Fields.

Champs

Champs
`results[]`	`SearchAds360Field` Liste des champs correspondant à la requête.
`next_page_token`	`string` Jeton de pagination utilisé pour récupérer la page de résultats suivante. Transmettez le contenu de cette chaîne en tant qu'attribut `page_token` de la requête suivante. `next_page_token` n'est pas renvoyé pour la dernière page.
`total_results_count`	`int64` Nombre total de résultats correspondant à la requête en ignorant la clause LIMIT.

results[]

SearchAds360Field

Liste des champs correspondant à la requête.

next_page_token

string

Jeton de pagination utilisé pour récupérer la page de résultats suivante. Transmettez le contenu de cette chaîne en tant qu'attribut page_token de la requête suivante. next_page_token n'est pas renvoyé pour la dernière page.

total_results_count

int64

Nombre total de résultats correspondant à la requête en ignorant la clause LIMIT.

SearchSearchAds360Request

Message de requête pour SearchAds360Service.Search.

Champs
`customer_id`	`string` Obligatoire. Identifiant du client interrogé.
`query`	`string` Obligatoire. Chaîne de requête.
`page_token`	`string` Jeton de la page à récupérer. Si aucune valeur n'est spécifiée, la première page de résultats est affichée. Pour demander la page de résultats suivante, utilisez la valeur obtenue à partir de `next_page_token` dans la réponse précédente.
`page_size`	`int32` Nombre d'éléments à récupérer sur une seule page. Lorsqu'une page trop volumineuse est demandée, le serveur peut décider de limiter davantage le nombre de ressources renvoyées.
`validate_only`	`bool` Si la valeur est "true", la requête est validée, mais pas exécutée.
`return_total_results_count`	`bool` Si la valeur est "true", le nombre total de résultats correspondant à la requête en ignorant la clause LIMIT sera inclus dans la réponse. La valeur par défaut est "false".
`summary_row_setting`	`SummaryRowSetting` Détermine si une ligne récapitulative sera renvoyée. Par défaut, la ligne récapitulative n'est pas renvoyée. Si elle est demandée, la ligne récapitulative sera envoyée seule dans une réponse après le renvoi de tous les autres résultats de requête.

SearchSearchAds360Response

Message de réponse pour SearchAds360Service.Search.

Champs
`results[]`	`SearchAds360Row` Liste des lignes correspondant à la requête.
`next_page_token`	`string` Jeton de pagination utilisé pour récupérer la page de résultats suivante. Transmettez le contenu de cette chaîne en tant qu'attribut `page_token` de la requête suivante. `next_page_token` n'est pas renvoyé pour la dernière page.
`total_results_count`	`int64` Nombre total de résultats correspondant à la requête en ignorant la clause LIMIT.
`field_mask`	`FieldMask` FieldMask, qui représente les champs demandés par l'utilisateur.
`summary_row`	`SearchAds360Row` Ligne récapitulative contenant un résumé des métriques dans les résultats. Le résumé des métriques correspond à l'agrégation des métriques de tous les résultats. Ici, l'agrégation peut être la somme, la moyenne, le taux, etc.
`custom_column_headers[]`	`CustomColumnHeader` En-têtes des colonnes personnalisées dans les résultats.
`conversion_custom_metric_headers[]`	`ConversionCustomMetricHeader` En-têtes des métriques personnalisées de conversion dans les résultats.
`conversion_custom_dimension_headers[]`	`ConversionCustomDimensionHeader` En-têtes des dimensions personnalisées de conversion dans les résultats.
`raw_event_conversion_metric_headers[]`	`RawEventConversionMetricHeader` En-têtes des métriques brutes de conversion d'événements dans les résultats.
`raw_event_conversion_dimension_headers[]`	`RawEventConversionDimensionHeader` En-têtes des dimensions brutes de conversion d'événements dans les résultats.

SearchSearchAds360StreamRequest

Message de requête pour SearchAds360Service.SearchStream.

Champs
`customer_id`	`string` Obligatoire. Identifiant du client interrogé.
`query`	`string` Obligatoire. Chaîne de requête.
`batch_size`	`int32` Nombre de lignes renvoyées dans chaque lot de réponse de flux. Lorsqu'un lot trop volumineux est demandé, le serveur peut décider de limiter davantage le nombre de lignes renvoyées.
`summary_row_setting`	`SummaryRowSetting` Détermine si une ligne récapitulative sera renvoyée. Par défaut, la ligne récapitulative n'est pas renvoyée. Si elle est demandée, la ligne récapitulative sera envoyée seule dans une réponse après le renvoi de tous les autres résultats de requête.

SearchSearchAds360StreamResponse

Message de réponse pour SearchAds360Service.SearchStream.

Champs
`results[]`	`SearchAds360Row` Liste des lignes correspondant à la requête.
`field_mask`	`FieldMask` FieldMask, qui représente les champs demandés par l'utilisateur.
`summary_row`	`SearchAds360Row` Ligne récapitulative contenant un résumé des métriques dans les résultats. Le résumé des métriques correspond à l'agrégation des métriques de tous les résultats. Ici, l'agrégation peut être la somme, la moyenne, le taux, etc.
`custom_column_headers[]`	`CustomColumnHeader` En-têtes des colonnes personnalisées dans les résultats.
`conversion_custom_metric_headers[]`	`ConversionCustomMetricHeader` En-têtes des métriques personnalisées de conversion dans les résultats.
`conversion_custom_dimension_headers[]`	`ConversionCustomDimensionHeader` En-têtes de la dimension personnalisée de conversion dans les résultats.
`raw_event_conversion_metric_headers[]`	`RawEventConversionMetricHeader` En-têtes des métriques brutes de conversion d'événements dans les résultats.
`raw_event_conversion_dimension_headers[]`	`RawEventConversionDimensionHeader` En-têtes des dimensions brutes de conversion d'événements dans les résultats.
`request_id`	`string` Identifiant unique de la requête utilisé à des fins de débogage.