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 CustomerClient
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 customer_client for a customer using a pagination search request.
"""
import argparse
import traceback
from google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360Request
from util_searchads360 import SearchAds360Client
def main(client, customer_id) -> None:
search_ads_360_service = client.get_service()
query = """
SELECT
customer_client.descriptive_name,
customer_client.client_customer,
customer_client.status
FROM customer_client"""
request = SearchSearchAds360Request()
request.customer_id = customer_id
request.query = query
# Issues a search request.
results = search_ads_360_service.search(request=request)
for row in results:
customer_client = row.customer_client
print(
f"CustomerClient found with name {customer_client.descriptive_name}, customer {customer_client.client_customer}, and status: {customer_client.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 customer_client 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_customer_client.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.resources.CustomerClient;
import com.google.ads.searchads360.v0.services.SearchAds360Row;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse;
import com.google.ads.searchads360.v0.services.SearchSearchAds360Request;
/** Get customer client details. */
public class GetCustomerClient {
private static class GetCustomerClientParams extends CodeSampleParams {
@Parameter(names = "--customerId", required = true)
private String customerId;
@Parameter(names = "--loginCustomerId")
private String loginCustomerId;
}
public static void main(String[] args) {
GetCustomerClientParams params = new GetCustomerClientParams();
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 GetCustomerClient().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 child accounts of the customerId specified in search
// calls below.
String query =
"""
SELECT
customer_client.descriptive_name, customer_client.client_customer, customer_client.status
FROM customer_client
""";
SearchSearchAds360Request request =
SearchSearchAds360Request.newBuilder().setCustomerId(customerId).setQuery(query).build();
// Issues a search request.
final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);
for (SearchAds360Row element : searchPagedResponse.iterateAll()) {
CustomerClient customerClient = element.getCustomerClient();
System.out.printf(
"CustomerClient found with name '%s', customer %s, and status: %s.%n",
customerClient.getDescriptiveName(),
customerClient.getClientCustomer(),
customerClient.getStatus());
}
}
}
Download GetCustomerClient.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 sample demonstrates how to retrieve customer client details using the Search Ads 360 API.\u003c/p\u003e\n"],["\u003cp\u003eIt utilizes a search query to retrieve customer client data including descriptive name, customer ID, and status.\u003c/p\u003e\n"],["\u003cp\u003eExamples are provided in both Python and Java, showcasing how to interact with the API in different programming languages.\u003c/p\u003e\n"],["\u003cp\u003eYou need to provide your Search Ads 360 customer ID as an argument when running the code.\u003c/p\u003e\n"]]],["The provided code examples demonstrate how to retrieve customer client information from Search Ads 360 using both Python and Java. They establish a connection to the Search Ads 360 service, construct a query to select the descriptive name, client customer ID, and status from `customer_client`, and use `customer_id` and `login_customer_id` to search. Finally the examples print the results, such as the customer client's name, customer ID, and status, for each returned row.\n"],null,["# Get CustomerClient\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 customer_client for a customer using a pagination search request.\n\"\"\"\n\nimport argparse\nimport traceback\nfrom google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360Request\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_client.descriptive_name,\n customer_client.client_customer,\n customer_client.status\n FROM customer_client\"\"\"\n\n request = SearchSearchAds360Request()\n request.customer_id = customer_id\n request.query = query\n\n # Issues a search request.\n results = search_ads_360_service.search(request=request)\n\n for row in results:\n customer_client = row.customer_client\n print(\n f\"CustomerClient found with name {customer_client.descriptive_name}, customer {customer_client.client_customer}, and status: {customer_client.status.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 customer_client 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_customer_client.py](/static/search-ads/reporting/sample-code/get_customer_client.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.resources.CustomerClient;\nimport com.google.ads.searchads360.v0.services.SearchAds360Row;\nimport com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;\nimport com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse;\nimport com.google.ads.searchads360.v0.services.SearchSearchAds360Request;\n\n/** Get customer client details. */\npublic class GetCustomerClient {\n private static class GetCustomerClientParams 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 GetCustomerClientParams params = new GetCustomerClientParams();\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 GetCustomerClient().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 all child accounts of the customerId specified in search\n // calls below.\n String query =\n \"\"\"\n SELECT\n customer_client.descriptive_name, customer_client.client_customer, customer_client.status\n FROM customer_client\n \"\"\";\n SearchSearchAds360Request request =\n SearchSearchAds360Request.newBuilder().setCustomerId(customerId).setQuery(query).build();\n\n // Issues a search request.\n final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);\n for (SearchAds360Row element : searchPagedResponse.iterateAll()) {\n CustomerClient customerClient = element.getCustomerClient();\n System.out.printf(\n \"CustomerClient found with name '%s', customer %s, and status: %s.%n\",\n customerClient.getDescriptiveName(),\n customerClient.getClientCustomer(),\n customerClient.getStatus());\n }\n }\n}\n```\n\n\u003cbr /\u003e\n\n[Download GetCustomerClient.java](/static/search-ads/reporting/sample-code/GetCustomerClient.java)"]]