Há dois métodos para recuperar entidades e gerar relatórios de dados com a API Search Ads 360 Reporting.
Este guia se concentra principalmente nos dados de streaming do
SearchAds360Service. Confira as diferenças
entre os dois métodos de recuperação de dados:
| SearchAds360Service.SearchStream | SearchAds360Service.Search | |
|---|---|---|
| Adequado para código de produção | Sim | Sim |
| Serviço | SearchAds360Service |
SearchAds360Service |
| Cenário | Como buscar objetos e relatórios | Como buscar objetos e relatórios |
| Resposta | Fluxo de objetos SearchAds360Row |
Páginas de objetos SearchAds360Row |
| Campos da resposta | Somente os especificados na consulta | Somente os especificados na consulta |
| Limites diários | Consulte Limites e cotas da API. | Consulte Limites e cotas da API. |
SearchStream x Pesquisa
Embora o Search possa enviar várias solicitações paginadas para fazer o download do relatório inteiro, o SearchStream envia uma única solicitação e inicia uma conexão persistente com a API Search Ads 360 Reporting, independentemente do tamanho do relatório.
No caso de SearchStream, os pacotes de dados começam a ser transferidos imediatamente com o resultado
inteiro armazenado em cache em um buffer de dados. O código pode começar a ler os dados armazenados em buffer
sem precisar esperar o término de todo o stream.
Ao eliminar o tempo de ida e volta da rede necessário para solicitar cada página
individual de uma resposta Search, dependendo do app, SearchStream pode oferecer
melhor desempenho em relação à paginação, especialmente para relatórios maiores.
Exemplo
Por exemplo, considere um relatório que consiste em 100,000 linhas. A tabela a seguir
descreve as diferenças de contabilidade entre os dois métodos.
| SearchStream | Pesquisar | |
|---|---|---|
| Tamanho da página | Não aplicável | 10.000 linhas por página |
| Número de solicitações de API | 1 solicitação | 10 solicitações |
| Número de respostas da API | 1 stream contínuo | 10 respostas |
Fatores de desempenho
Em geral, recomendamos SearchStream em vez de Search pelos seguintes motivos.
Para relatórios de uma página (menos de 10.000 linhas): não há diferenças significativas de desempenho entre os dois métodos.
Para relatórios de várias páginas:
SearchStreamgeralmente é mais rápido, já que várias viagens de ida e volta são evitadas, e a leitura/gravação do cache do disco é menos um fator.
Limites de taxas
Os limites diários para os dois métodos aderem aos limites e cotas padrão da API. Uma única consulta ou relatório é contada como uma operação, independentemente do resultado ser paginado ou transmitido.
Exemplo de streaming
// 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());
}
}
}
}
#!/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()