The new Search Ads 360 Reporting API is now available. Join the
searchads-api-announcements Google group to stay up to date on upcoming enhancements and releases.
Get Customers
Stay organized with collections
Save and categorize content based on your preferences.
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 detail information 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
customer.id,
customer.descriptive_name,
customer.account_type,
customer.manager,
customer.manager_id,
customer.manager_descriptive_name,
customer.sub_manager_id,
customer.sub_manager_descriptive_name,
customer.associate_manager_id,
customer.associate_manager_descriptive_name,
customer.account_level
FROM customer"""
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:
customer = result.customer
print(f"""Customer found with ID {customer.id}
descriptive_name: {customer.descriptive_name}
account_type: {customer.account_type.name}
is_manager: {customer.manager}
manager_id: {customer.manager_id}
manager_descriptive_name: {customer.manager_descriptive_name}
sub_manager_id: {customer.sub_manager_id}
sub_manager_descriptive_name: {customer.sub_manager_descriptive_name}
associate_manager_id: {customer.associate_manager_id}
associate_manager_descriptive_name: {customer.associate_manager_descriptive_name}
account_level: {customer.account_level.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 detail info 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()
Download get_customers_stream.py
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 customer details. */
public class GetCustomersStream {
private static class GetCustomersParams extends CodeSampleParams {
@Parameter(names = "--customerId", required = true)
private String customerId;
@Parameter(names = "--loginCustomerId")
private String loginCustomerId;
}
public static void main(String[] args) {
GetCustomersParams params = new GetCustomersParams();
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 GetCustomersStream().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 customer info along the manager chain.
String query =
"""
SELECT
customer.id, customer.descriptive_name, customer.account_type, customer.manager,
customer.manager_id, customer.manager_descriptive_name,
customer.sub_manager_id, customer.sub_manager_descriptive_name,
customer.associate_manager_id, customer.associate_manager_descriptive_name,
customer.account_level
FROM customer
""";
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(
"Customer found with ID %d%n"
+ "\tdescriptive_name: %s%n"
+ "\taccount_type: %s%n"
+ "\tis_manager: %s%n"
+ "\tmanager_id: %d%n"
+ "\tmanager_descriptive_name: %s%n"
+ "\tsub_manager_id: %d%n"
+ "\tsub_manager_descriptive_name: %s%n"
+ "\tassociate_manager_id: %d%n"
+ "\tassociate_manager_descriptive_name: %s%n"
+ "\taccount_level: %s%n",
element.getCustomer().getId(),
element.getCustomer().getDescriptiveName(),
element.getCustomer().getAccountType(),
element.getCustomer().getManager(),
element.getCustomer().getManagerId(),
element.getCustomer().getManagerDescriptiveName(),
element.getCustomer().getSubManagerId(),
element.getCustomer().getSubManagerDescriptiveName(),
element.getCustomer().getAssociateManagerId(),
element.getCustomer().getAssociateManagerDescriptiveName(),
element.getCustomer().getAccountLevel());
}
}
}
}
Download GetCustomersStream.java
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis code provides examples in Python and Java for retrieving detailed customer information from Search Ads 360 using a stream request.\u003c/p\u003e\n"],["\u003cp\u003eIt uses the Search Ads 360 API to query for customer details such as ID, descriptive name, account type, and manager status.\u003c/p\u003e\n"],["\u003cp\u003eThe examples demonstrate how to set up a Search Ads 360 client, construct a query, and process the stream of results to extract customer information.\u003c/p\u003e\n"],["\u003cp\u003eThe retrieved customer information is printed to the console, displaying the relevant attributes for each customer found.\u003c/p\u003e\n"]]],["The provided code examples demonstrate how to retrieve customer details using the Search Ads 360 API in both Python and Java. They initialize a Search Ads 360 client, define a query to select customer ID, name, account type, and manager status. They then create a stream request, and process the stream response to print the details for each customer found. The Java code also includes setting up login credentials.\n"],null,["# Get Customers\n\n### Python\n\n\n```python\n#!/usr/bin/env python\n# Copyright 2022 Google LLC\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# https://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\"\"\"Retrieves detail information for a customer using a stream request.\"\"\"\n\nimport argparse\nimport traceback\nfrom google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360StreamRequest\nfrom util_searchads360 import SearchAds360Client\n\n\ndef main(client, customer_id) -\u003e None:\n search_ads_360_service = client.get_service()\n\n query = \"\"\"\n SELECT\n customer.id,\n customer.descriptive_name,\n customer.account_type,\n customer.manager,\n customer.manager_id,\n customer.manager_descriptive_name,\n customer.sub_manager_id,\n customer.sub_manager_descriptive_name,\n customer.associate_manager_id,\n customer.associate_manager_descriptive_name,\n customer.account_level\n FROM customer\"\"\"\n\n request = SearchSearchAds360StreamRequest()\n request.customer_id = customer_id\n request.query = query\n\n # Issues a search stream request.\n results = search_ads_360_service.search_stream(request=request)\n\n for response in results:\n for result in response.results:\n customer = result.customer\n print(f\"\"\"Customer found with ID {customer.id}\n descriptive_name: {customer.descriptive_name}\n account_type: {customer.account_type.name}\n is_manager: {customer.manager}\n manager_id: {customer.manager_id}\n manager_descriptive_name: {customer.manager_descriptive_name}\n sub_manager_id: {customer.sub_manager_id}\n sub_manager_descriptive_name: {customer.sub_manager_descriptive_name}\n associate_manager_id: {customer.associate_manager_id}\n associate_manager_descriptive_name: {customer.associate_manager_descriptive_name}\n account_level: {customer.account_level.name}\n \"\"\")\n\n\nif __name__ == \"__main__\":\n # SearchAds360Client will read the search-ads-360.yaml configuration file in\n # the home directory if none is specified.\n search_ads_360_client = SearchAds360Client.load_from_file()\n\n parser = argparse.ArgumentParser(\n description=(\"Retrieves detail info for a customer.\"))\n # Arguments to provide to run the example.\n parser.add_argument(\n \"-c\",\n \"--customer_id\",\n type=str,\n required=True,\n help=\"The Search Ads 360 customer ID (10 digits, no dashes).\",\n )\n\n parser.add_argument(\n \"-l\",\n \"--login_customer_id\",\n type=str,\n required=False,\n help=\"The Search Ads 360 login customer ID (10 digits, no dashes).\",\n )\n\n args = parser.parse_args()\n\n search_ads_360_client.set_ids(args.customer_id, args.login_customer_id)\n\n try:\n main(search_ads_360_client, args.customer_id)\n except Exception: # pylint: disable=broad-except\n traceback.print_exc()\n```\n\n\u003cbr /\u003e\n\n[Download get_customers_stream.py](/static/search-ads/reporting/sample-code/get_customers_stream.py)\n\n### Java\n\n\n```java\n// Copyright 2022 Google LLC\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// https://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\npackage sample;\n\nimport com.beust.jcommander.Parameter;\nimport com.google.ads.searchads360.v0.lib.SearchAds360Client;\nimport com.google.ads.searchads360.v0.services.SearchAds360Row;\nimport com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;\nimport com.google.ads.searchads360.v0.services.SearchSearchAds360StreamRequest;\nimport com.google.ads.searchads360.v0.services.SearchSearchAds360StreamResponse;\nimport com.google.api.gax.rpc.ServerStream;\n\n/** Get customer details. */\npublic class GetCustomersStream {\n private static class GetCustomersParams extends CodeSampleParams {\n\n @Parameter(names = \"--customerId\", required = true)\n private String customerId;\n\n @Parameter(names = \"--loginCustomerId\")\n private String loginCustomerId;\n }\n\n public static void main(String[] args) {\n GetCustomersParams params = new GetCustomersParams();\n if (!params.parseArguments(args)) {\n // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId\n // here (10 digits, no dashes). If neither are set, customerId will be used as\n // loginCustomerId.\n // params.loginCustomerId = Long.parseLong(\"INSERT_LOGIN_CUSTOMER_ID_HERE\");\n }\n final String loginCustomerId = params.loginCustomerId;\n final String customerId = params.customerId;\n\n try {\n // Creates a SearchAds360Client with the specified loginCustomerId. If there's\n // no loginCustomerId, customerId will be used instead.\n final SearchAds360Client searchAds360Client =\n SearchAds360Client.newBuilder()\n .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)\n .fromPropertiesFile()\n .build();\n // Creates the Search Ads 360 Service client.\n SearchAds360ServiceClient client = searchAds360Client.create();\n new GetCustomersStream().runExample(client, customerId);\n } catch (Exception exception) {\n System.err.printf(\"Failed with exception: %s%n\", exception);\n exception.printStackTrace();\n System.exit(1);\n }\n }\n\n private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {\n // Creates a query that retrieves customer info along the manager chain.\n String query =\n \"\"\"\n SELECT\n customer.id, customer.descriptive_name, customer.account_type, customer.manager,\n customer.manager_id, customer.manager_descriptive_name,\n customer.sub_manager_id, customer.sub_manager_descriptive_name,\n customer.associate_manager_id, customer.associate_manager_descriptive_name,\n customer.account_level\n FROM customer\n \"\"\";\n SearchSearchAds360StreamRequest request =\n SearchSearchAds360StreamRequest.newBuilder()\n .setCustomerId(customerId)\n .setQuery(query)\n .build();\n\n // Issues a search stream request.\n ServerStream\u003cSearchSearchAds360StreamResponse\u003e stream =\n searchAds360ServiceClient.searchStreamCallable().call(request);\n\n for (SearchSearchAds360StreamResponse response : stream) {\n for (SearchAds360Row element : response.getResultsList()) {\n System.out.printf(\n \"Customer found with ID %d%n\"\n + \"\\tdescriptive_name: %s%n\"\n + \"\\taccount_type: %s%n\"\n + \"\\tis_manager: %s%n\"\n + \"\\tmanager_id: %d%n\"\n + \"\\tmanager_descriptive_name: %s%n\"\n + \"\\tsub_manager_id: %d%n\"\n + \"\\tsub_manager_descriptive_name: %s%n\"\n + \"\\tassociate_manager_id: %d%n\"\n + \"\\tassociate_manager_descriptive_name: %s%n\"\n + \"\\taccount_level: %s%n\",\n element.getCustomer().getId(),\n element.getCustomer().getDescriptiveName(),\n element.getCustomer().getAccountType(),\n element.getCustomer().getManager(),\n element.getCustomer().getManagerId(),\n element.getCustomer().getManagerDescriptiveName(),\n element.getCustomer().getSubManagerId(),\n element.getCustomer().getSubManagerDescriptiveName(),\n element.getCustomer().getAssociateManagerId(),\n element.getCustomer().getAssociateManagerDescriptiveName(),\n element.getCustomer().getAccountLevel());\n }\n }\n }\n}\n```\n\n\u003cbr /\u003e\n\n[Download GetCustomersStream.java](/static/search-ads/reporting/sample-code/GetCustomersStream.java)"]]