Yeni Search Ads 360 Reporting API kullanıma sunuldu. Yaklaşan geliştirmeler ve sürümlerden haberdar olmak için
searchads-api-announcements Google grubuna katılın.
Method: customers.searchAds360.searchStream
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
HTTP isteği
POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler |
customerId |
string
Zorunlu. Sorgulanan müşterinin kimliği.
|
İstek içeriği
İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:
JSON gösterimi |
{
"query": string,
"batchSize": integer,
"summaryRowSetting": enum (SummaryRowSetting )
} |
Alanlar |
query |
string
Zorunlu. Sorgu dizesi.
|
batchSize |
integer
Her bir akış yanıt grubunda döndürülen satır sayısı. Çok büyük gruplar için istekte bulunulduğunda, sunucu döndürülen satır sayısını daha da sınırlandırmaya karar verebilir.
|
summaryRowSetting |
enum (SummaryRowSetting )
Bir özet satırının döndürülüp döndürülmeyeceğini belirler. Varsayılan olarak, özet satırı döndürülmez. İstenirse diğer tüm sorgu sonuçları döndürüldükten sonra özet satırı tek başına yanıt olarak gönderilir.
|
Yanıt gövdesi
SearchAds360Service.SearchStream
için yanıt mesajı.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
Alanlar |
results[] |
object (SearchAds360Row )
Sorguyla eşleşen satırların listesi.
|
fieldMask |
string (FieldMask format)
Kullanıcının hangi alanları istediğini temsil eden FieldMask. Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo" .
|
summaryRow |
object (SearchAds360Row )
Sonuçlardaki metriklerin özetini içeren özet satırı. Metriklerin özeti, tüm sonuçlardaki metriklerin toplanması anlamına gelir. Burada toplama, toplam, ortalama, oran vb. olabilir.
|
customColumnHeaders[] |
object (CustomColumnHeader )
Sonuçlardaki özel sütunların başlıkları.
|
conversionCustomMetricHeaders[] |
object (ConversionCustomMetricHeader )
Sonuçlardaki dönüşüm özel metriklerinin başlıkları.
|
conversionCustomDimensionHeaders[] |
object (ConversionCustomDimensionHeader )
Sonuçlardaki dönüşüm özel boyutunun başlıkları.
|
rawEventConversionMetricHeaders[] |
object (RawEventConversionMetricHeader )
Sonuçlardaki ham etkinlik dönüşüm metriklerinin başlıkları.
|
rawEventConversionDimensionHeaders[] |
object (RawEventConversionDimensionHeader )
Sonuçlardaki ham etkinlik dönüşüm boyutlarının başlıklarıdır.
|
requestId |
string
Hata ayıklama amacıyla kullanılan isteğin benzersiz kimliği.
|
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamını gerektirir:
https://www.googleapis.com/auth/doubleclicksearch
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-04-02 UTC.
[null,null,["Son güncelleme tarihi: 2025-04-02 UTC."],[[["\u003cp\u003eReturns all rows matching the specified search stream query, enabling retrieval of Search Ads 360 data.\u003c/p\u003e\n"],["\u003cp\u003eRequires a POST request to the designated endpoint with query parameters including \u003ccode\u003ecustomerId\u003c/code\u003e, \u003ccode\u003equery\u003c/code\u003e, \u003ccode\u003ebatchSize\u003c/code\u003e, and \u003ccode\u003esummaryRowSetting\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of matching rows, field mask, summary row (optional), custom column headers, and request ID.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes gRPC Transcoding for URL syntax and necessitates the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclicksearch\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This outlines how to use the `searchStream` method via a POST request to `searchAds360`. The request requires a `customerId` path parameter. The request body must include a `query` string, an optional `batchSize`, and a `summaryRowSetting`. The response, matching the query, includes an array of `results`, a `fieldMask`, and a `summaryRow` with aggregated metrics. Other optional details include `customColumnHeaders` and headers related to conversion metrics and dimensions. It requires authentication with `doubleclicksearch` scope.\n"],null,["# Method: customers.searchAds360.searchStream\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchSearchAds360StreamResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nReturns all rows that match the search stream query.\n\nList of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QueryError]() [QuotaError]() [RequestError]()\n\n### HTTP request\n\n`POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------|\n| `customerId` | `string` Required. The ID of the customer being queried. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"query\": string, \"batchSize\": integer, \"summaryRowSetting\": enum (/search-ads/reporting/api/reference/rest/v0/SummaryRowSetting) } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. The query string. |\n| `batchSize` | `integer` The number of rows that are returned in each stream response batch. When too large batch is requested, the server may decide to further limit the number of returned rows. |\n| `summaryRowSetting` | `enum (`[SummaryRowSetting](/search-ads/reporting/api/reference/rest/v0/SummaryRowSetting)`)` Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned. |\n\n### Response body\n\nResponse message for [SearchAds360Service.SearchStream](/search-ads/reporting/api/reference/rest/v0/customers.searchAds360/searchStream#google.ads.searchads360.v0.services.SearchAds360Service.SearchStream).\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/SearchAds360Row) } ], \"fieldMask\": string, \"summaryRow\": { object (/search-ads/reporting/api/reference/rest/v0/SearchAds360Row) }, \"customColumnHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/CustomColumnHeader) } ], \"conversionCustomMetricHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/ConversionCustomMetricHeader) } ], \"conversionCustomDimensionHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/ConversionCustomDimensionHeader) } ], \"rawEventConversionMetricHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/RawEventConversionMetricHeader) } ], \"rawEventConversionDimensionHeaders\": [ { object (/search-ads/reporting/api/reference/rest/v0/RawEventConversionDimensionHeader) } ], \"requestId\": string } ``` |\n\n| Fields ||\n|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `results[]` | `object (`[SearchAds360Row](/search-ads/reporting/api/reference/rest/v0/SearchAds360Row)`)` The list of rows that matched the query. |\n| `fieldMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` FieldMask that represents what fields were requested by the user. This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n| `summaryRow` | `object (`[SearchAds360Row](/search-ads/reporting/api/reference/rest/v0/SearchAds360Row)`)` Summary row that contains summary of metrics in results. Summary of metrics means aggregation of metrics across all results, here aggregation could be sum, average, rate, etc. |\n| `customColumnHeaders[]` | `object (`[CustomColumnHeader](/search-ads/reporting/api/reference/rest/v0/CustomColumnHeader)`)` The headers of the custom columns in the results. |\n| `conversionCustomMetricHeaders[]` | `object (`[ConversionCustomMetricHeader](/search-ads/reporting/api/reference/rest/v0/ConversionCustomMetricHeader)`)` The headers of the conversion custom metrics in the results. |\n| `conversionCustomDimensionHeaders[]` | `object (`[ConversionCustomDimensionHeader](/search-ads/reporting/api/reference/rest/v0/ConversionCustomDimensionHeader)`)` The headers of the conversion custom dimension in the results. |\n| `rawEventConversionMetricHeaders[]` | `object (`[RawEventConversionMetricHeader](/search-ads/reporting/api/reference/rest/v0/RawEventConversionMetricHeader)`)` The headers of the raw event conversion metrics in the results. |\n| `rawEventConversionDimensionHeaders[]` | `object (`[RawEventConversionDimensionHeader](/search-ads/reporting/api/reference/rest/v0/RawEventConversionDimensionHeader)`)` The headers of the raw event conversion dimensions in the results. |\n| `requestId` | `string` The unique id of the request that is used for debugging purposes. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclicksearch`"]]