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 AdGroupAds
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 AdGroupAds 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
ad_group_ad.ad.id,
ad_group_ad.ad.expanded_dynamic_search_ad.description1,
ad_group_ad.ad.expanded_dynamic_search_ad.description2
FROM ad_group_ad"""
request = SearchSearchAds360StreamRequest()
request.customer_id = customer_id
request.query = query
# Issues a stream request.
results = search_ads_360_service.search_stream(request=request)
for response in results:
for result in response.results:
ad_group_ad = result.ad_group_ad
print(
f"AdgroupAd found with id {ad_group_ad.ad.id}, description1:"
f"'{ad_group_ad.ad.expanded_dynamic_search_ad.description1}',"
" description2:"
f"'{ad_group_ad.ad.expanded_dynamic_search_ad.description2}'"
)
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 AdGroupAd 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.",
)
parser.add_argument(
"-l",
"--login_customer_id",
type=str,
required=False,
help="The Search Ads 360 login customer ID.",
)
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_ad_group_ads_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 AdGroupAd details using SearchStream. */
public class GetAdGroupAdStream {
private static class GetAdGroupAdStreamParams extends CodeSampleParams {
@Parameter(names = "--customerId", required = true)
private String customerId;
@Parameter(names = "--loginCustomerId")
private String loginCustomerId;
}
public static void main(String[] args) {
GetAdGroupAdStreamParams params = new GetAdGroupAdStreamParams();
if (!params.parseArguments(args)) {
// Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
// here. 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 GetAdGroupAdStream().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 AdGroupAd description.
String query =
"""
SELECT
ad_group_ad.ad.id, ad_group_ad.ad.expanded_dynamic_search_ad.description1,
ad_group_ad.ad.expanded_dynamic_search_ad.description2
FROM ad_group_ad
""";
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(
"AdGroupAd found with id %d, description1:'%s', description2:'%s'.%n",
element.getAdGroupAd().getAd().getId(),
element.getAdGroupAd().getAd().getExpandedDynamicSearchAd().getDescription1(),
element.getAdGroupAd().getAd().getExpandedDynamicSearchAd().getDescription2());
}
}
}
}
Download GetAdGroupAdsStream.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 snippet demonstrates how to retrieve AdGroupAds for a customer using a stream request in Search Ads 360 API.\u003c/p\u003e\n"],["\u003cp\u003eThe example code is available in both Python and Java, allowing developers to choose their preferred language.\u003c/p\u003e\n"],["\u003cp\u003eIt fetches and displays the ad ID, description1, and description2 for each AdGroupAd.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers need to provide the Search Ads 360 customer ID as a required parameter to run the code.\u003c/p\u003e\n"]]],["The code retrieves and displays `AdGroupAd` data from Search Ads 360. It establishes a connection to the Search Ads 360 service, defines a query to select `ad_group_ad.ad.id`, `description1`, and `description2` from `ad_group_ad`. A stream request is created and executed to fetch the data. Results are iterated over and the details, including the `id`, `description1`, and `description2` of each `AdGroupAd`, are printed. The customer and login IDs are provided via command-line arguments.\n"],null,["# Get AdGroupAds\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 AdGroupAds 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 ad_group_ad.ad.id,\n ad_group_ad.ad.expanded_dynamic_search_ad.description1,\n ad_group_ad.ad.expanded_dynamic_search_ad.description2\n FROM ad_group_ad\"\"\"\n\n request = SearchSearchAds360StreamRequest()\n request.customer_id = customer_id\n request.query = query\n\n # Issues a 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 ad_group_ad = result.ad_group_ad\n print(\n f\"AdgroupAd found with id {ad_group_ad.ad.id}, description1:\"\n f\"'{ad_group_ad.ad.expanded_dynamic_search_ad.description1}',\"\n \" description2:\"\n f\"'{ad_group_ad.ad.expanded_dynamic_search_ad.description2}'\"\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 AdGroupAd 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.\",\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.\",\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_ad_group_ads_stream.py](/static/search-ads/reporting/sample-code/get_ad_group_ads_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 AdGroupAd details using SearchStream. */\npublic class GetAdGroupAdStream {\n private static class GetAdGroupAdStreamParams 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 GetAdGroupAdStreamParams params = new GetAdGroupAdStreamParams();\n if (!params.parseArguments(args)) {\n // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId\n // here. If neither are set, customerId will be used as 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 GetAdGroupAdStream().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 AdGroupAd description.\n String query =\n \"\"\"\n SELECT\n ad_group_ad.ad.id, ad_group_ad.ad.expanded_dynamic_search_ad.description1,\n ad_group_ad.ad.expanded_dynamic_search_ad.description2\n FROM ad_group_ad\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 \"AdGroupAd found with id %d, description1:'%s', description2:'%s'.%n\",\n element.getAdGroupAd().getAd().getId(),\n element.getAdGroupAd().getAd().getExpandedDynamicSearchAd().getDescription1(),\n element.getAdGroupAd().getAd().getExpandedDynamicSearchAd().getDescription2());\n }\n }\n }\n}\n```\n\n\u003cbr /\u003e\n\n[Download GetAdGroupAdsStream.java](/static/search-ads/reporting/sample-code/GetAdGroupAdsStream.java)"]]