Search Ads 360 Reporting API ile varlıkları almak ve verileri raporlamak için iki yöntem vardır.
Bu rehber öncelikli olarak SearchAds360Service ürününden veri akışına odaklanır. İki veri alma yöntemi arasındaki
üst düzey farkları burada bulabilirsiniz:
| SearchAds360Service.SearchStream | SearchAds360Service.Search | |
|---|---|---|
| Üretim kodu için uygun | Yes | Yes |
| Hizmet | SearchAds360Service |
SearchAds360Service |
| Senaryo | Nesneleri ve raporları alma | Nesneleri ve raporları alma |
| Yanıt | SearchAds360Row nesne akışı |
SearchAds360Row nesnenin sayfaları |
| Yanıtın alanları | Yalnızca sorguda belirtilenler | Yalnızca sorguda belirtilenler |
| Günlük sınırlar | API sınırları ve kotaları başlıklı makaleyi inceleyin. | API sınırları ve kotaları başlıklı makaleyi inceleyin. |
SearchStream ve Arama
Search, raporun tamamını indirmek için birden çok sayfaya ayrılmış istek gönderebilir. Ancak SearchStream, tek bir istek gönderir ve rapor boyutundan bağımsız olarak Search Ads 360 Reporting API ile kalıcı bir bağlantı başlatır.
SearchStream için veri paketleri, sonucun tamamı bir veri arabelleğinde önbelleğe alınırken veri paketleri hemen indirilmeye başlar. Kodunuz, tüm akışın tamamlanmasını beklemek zorunda kalmadan arabelleğe alınan verileri okumaya başlayabilir.
Uygulamanıza bağlı olarak bir Search yanıtının her bir sayfasını istemek için gereken gidiş dönüş ağ süresini ortadan kaldırarak SearchStream, özellikle büyük raporlarda sayfalamaya kıyasla daha iyi performans sağlayabilir.
Örnek
Örneğin, 100,000 satırdan oluşan bir raporu ele alalım. Aşağıdaki tabloda, iki yöntem arasındaki muhasebe farklılıkları açıklanmaktadır.
| SearchStream | Arama | |
|---|---|---|
| Sayfa boyutu | Geçerli Değil | Sayfa başına 10.000 satır |
| API isteği sayısı | 1 istek | 10 istek |
| API yanıtlarının sayısı | 1 kesintisiz akış | 10 yanıt |
Performans faktörleri
Genel olarak, Search yerine aşağıdaki nedenlerden dolayı SearchStream kullanmanızı öneririz.
Tek sayfalık raporlar (10.000 satırın altında): İki yöntem arasında önemli bir performans farkı yoktur.
Birden fazla sayfa raporu için:
SearchStream, birden fazla gidiş dönüşün önüne geçildiği ve disk önbelleğinden okuma/yazma işlemleri daha az bir faktör olduğundan genellikle daha hızlıdır.
Hız sınırları
Her iki yöntemin günlük sınırları, standart API sınırları ve kotalarına uyar. Tek bir sorgu veya rapor, sonucun sayfalanmasına veya akışa aktarılmasına bakılmaksızın tek bir işlem olarak sayılır.
Akış örneği
Java
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package sample;
import com.beust.jcommander.Parameter;
import com.google.ads.searchads360.v0.lib.SearchAds360Client;
import com.google.ads.searchads360.v0.services.SearchAds360Row;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
import com.google.ads.searchads360.v0.services.SearchSearchAds360StreamRequest;
import com.google.ads.searchads360.v0.services.SearchSearchAds360StreamResponse;
import com.google.api.gax.rpc.ServerStream;
/** Get campaign details using SearchStream. */
public class GetCampaignsStream {
private static class GetCampaignsStreamParams extends CodeSampleParams {
@Parameter(names = "--customerId", required = true)
private String customerId;
@Parameter(names = "--loginCustomerId")
private String loginCustomerId;
}
public static void main(String[] args) {
GetCampaignsStreamParams params = new GetCampaignsStreamParams();
if (!params.parseArguments(args)) {
// Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
// here (10 digits, no dashes). If neither are set, customerId will be used as
// loginCustomerId.
// params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
}
final String loginCustomerId = params.loginCustomerId;
final String customerId = params.customerId;
try {
// Creates a SearchAds360Client with the specified loginCustomerId. If there's
// no loginCustomerId, customerId will be used instead.
final SearchAds360Client searchAds360Client =
SearchAds360Client.newBuilder()
.setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)
.fromPropertiesFile()
.build();
// Creates the Search Ads 360 Service client.
SearchAds360ServiceClient client = searchAds360Client.create();
new GetCampaignsStream().runExample(client, customerId);
} catch (Exception exception) {
System.err.printf("Failed with exception: %s%n", exception);
exception.printStackTrace();
System.exit(1);
}
}
private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {
// Creates a query that retrieves all campaigns under the customerId.
String query = "SELECT campaign.name, campaign.id, campaign.status FROM campaign";
SearchSearchAds360StreamRequest request =
SearchSearchAds360StreamRequest.newBuilder()
.setCustomerId(customerId)
.setQuery(query)
.build();
// Issues a search stream request.
ServerStream<SearchSearchAds360StreamResponse> stream =
searchAds360ServiceClient.searchStreamCallable().call(request);
for (SearchSearchAds360StreamResponse response : stream) {
for (SearchAds360Row element : response.getResultsList()) {
System.out.printf(
"Campaign found with name '%s', ID %d, and status: %s.%n",
element.getCampaign().getName(),
element.getCampaign().getId(),
element.getCampaign().getStatus());
}
}
}
}
Python
#!/usr/bin/env python
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Retrieves campaigns for a customer using a stream request."""
import argparse
import traceback
from google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360StreamRequest
from util_searchads360 import SearchAds360Client
def main(client, customer_id) -> None:
search_ads_360_service = client.get_service()
query = """
SELECT
campaign.name,
campaign.id,
campaign.status
FROM campaign"""
request = SearchSearchAds360StreamRequest()
request.customer_id = customer_id
request.query = query
# Issues a search stream request.
results = search_ads_360_service.search_stream(request=request)
for response in results:
for result in response.results:
campaign = result.campaign
print(
f'campaign "{campaign.name}" has id {campaign.id} and status {campaign.status.name}'
)
if __name__ == "__main__":
# SearchAds360Client will read the search-ads-360.yaml configuration file in
# the home directory if none is specified.
search_ads_360_client = SearchAds360Client.load_from_file()
parser = argparse.ArgumentParser(
description=("Retrieves campaigns for a customer."))
# Arguments to provide to run the example.
parser.add_argument(
"-c",
"--customer_id",
type=str,
required=True,
help="The Search Ads 360 customer ID (10 digits, no dashes).",
)
parser.add_argument(
"-l",
"--login_customer_id",
type=str,
required=False,
help="The Search Ads 360 login customer ID (10 digits, no dashes).",
)
args = parser.parse_args()
search_ads_360_client.set_ids(args.customer_id, args.login_customer_id)
try:
main(search_ads_360_client, args.customer_id)
except Exception: # pylint: disable=broad-except
traceback.print_exc()