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.
Method: searchAds360Fields.search
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Requête HTTP
POST https://searchads360.googleapis.com/v0/searchAds360Fields:search
L'URL utilise la syntaxe de transcodage gRPC.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
{
"query": string,
"pageToken": string,
"pageSize": integer
} |
Champs |
query |
string
Obligatoire. Chaîne de requête.
|
pageToken |
string
Jeton de la page à récupérer. Si cette valeur n'est pas spécifiée, la première page de résultats est renvoyée. Utilisez la valeur obtenue à partir de nextPageToken dans la réponse précédente pour demander la page de résultats suivante.
|
pageSize |
integer
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.
|
Corps de la réponse
Message de réponse pour SearchAds360FieldService.SearchSearchAds360Fields
.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
{
"results": [
{
object (SearchAds360Field )
}
],
"nextPageToken": string,
"totalResultsCount": string
} |
Champs |
results[] |
object (SearchAds360Field )
Liste des champs correspondant à la requête.
|
nextPageToken |
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 pageToken de la requête suivante. nextPageToken n'est pas renvoyé pour la dernière page.
|
totalResultsCount |
string (int64 format)
Nombre total de résultats correspondant à la requête, en ignorant la clause LIMIT.
|
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/doubleclicksearch
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/04/02 (UTC).
[null,null,["Dernière mise à jour le 2025/04/02 (UTC)."],[[["\u003cp\u003eSearch and retrieve SearchAds360 fields that match a specific query using the provided endpoint.\u003c/p\u003e\n"],["\u003cp\u003eRequests can specify query parameters for filtering, pagination, and the number of results to return.\u003c/p\u003e\n"],["\u003cp\u003eResponses include a list of matching fields, pagination information, and the total number of results.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclicksearch\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003ePotential errors include AuthenticationError, AuthorizationError, HeaderError, InternalError, QueryError, QuotaError, and RequestError.\u003c/p\u003e\n"]]],["This document details how to search for fields using the Search Ads 360 API. A `POST` request is sent to `https://searchads360.googleapis.com/v0/searchAds360Fields:search`, including a JSON body with a `query` string, optional `pageToken`, and `pageSize`. The response includes a list of matching field `results`, a `nextPageToken` for pagination, and a `totalResultsCount`. This operation requires the `https://www.googleapis.com/auth/doubleclicksearch` OAuth scope. Several errors such as `AuthenticationError` and `QuotaError` can be thrown.\n"],null,["# Method: searchAds360Fields.search\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchSearchAds360FieldsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nReturns all fields that match the search [query](/search-ads/reporting/concepts/field-service#use_a_query_to_get_field_details).\n\nList of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()\n\n### HTTP request\n\n`POST https://searchads360.googleapis.com/v0/searchAds360Fields:search`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------|\n| ``` { \"query\": string, \"pageToken\": string, \"pageSize\": integer } ``` |\n\n| Fields ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. The query string. |\n| `pageToken` | `string` Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from `nextPageToken` in the previous response in order to request the next page of results. |\n| `pageSize` | `integer` 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. |\n\n### Response body\n\nResponse message for [SearchAds360FieldService.SearchSearchAds360Fields](/search-ads/reporting/api/reference/rest/v0/searchAds360Fields/search#google.ads.searchads360.v0.services.SearchAds360FieldService.SearchSearchAds360Fields).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"results\": [ { object (/search-ads/reporting/api/reference/rest/v0/searchAds360Fields#SearchAds360Field) } ], \"nextPageToken\": string, \"totalResultsCount\": string } ``` |\n\n| Fields ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `results[]` | `object (`[SearchAds360Field](/search-ads/reporting/api/reference/rest/v0/searchAds360Fields#SearchAds360Field)`)` The list of fields that matched the query. |\n| `nextPageToken` | `string` Pagination token used to retrieve the next page of results. Pass the content of this string as the `pageToken` attribute of the next request. `nextPageToken` is not returned for the last page. |\n| `totalResultsCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Total number of results that match the query ignoring the LIMIT clause. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclicksearch`"]]