The previous Search Ads 360 Reporting API is decommissioned. You can now create your reports using thenew Search Ads 360 Reporting API.
Note that thegetandgetByCustomerIdmethods in the Search Ads 360 Conversion API are being deprecated in Q3 2025. To continue accessing conversion data, you must create a report using theconversion resourceusing the new Search Ads 360 Reporting API. See more detailshere.
Stay organized with collectionsSave and categorize content based on your preferences.
If you are using a client library, your application will need to instantiate aDoubleclicksearchservice object. All interaction with the Search Ads 360 API
occurs through this service object. If you aren't using a client library
you can skip this section, but you'll need to write some code that can send HTTP requests
and parse the responses.
EachDoubleclicksearchinstance needs a
reference to an object that contains your credentials and OAuth 2.0 access token.Doubleclicksearchwill pass the credentials and token to the Search Ads 360 API
in each request. The following code demonstrates how to instantiate aDoubleclicksearchservice object using OAuth 2.0 for installed applications.
If you haven't already obtained your OAuth 2.0 credentials for the Search Ads 360 API,
seeSet Up Authorization.
Java
importcom.google.api.client.auth.oauth2.Credential;importcom.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;importcom.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;importcom.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;importcom.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;importcom.google.api.client.googleapis.auth.oauth2.GoogleCredential;importcom.google.api.client.googleapis.javanet.GoogleNetHttpTransport;importcom.google.api.client.http.javanet.NetHttpTransport;importcom.google.api.client.json.JsonFactory;importcom.google.api.client.json.jackson2.JacksonFactory;importcom.google.api.client.util.store.DataStoreFactory;importcom.google.api.client.util.store.FileDataStoreFactory;importcom.google.api.services.doubleclicksearch.Doubleclicksearch;importjava.io.File;importjava.io.FileOutputStream;importjava.io.IOException;importjava.io.InputStreamReader;importjava.io.PrintStream;importjava.util.Arrays;privatestaticfinalString[]SCOPES=newString[]{"https://www.googleapis.com/auth/doubleclicksearch"};/**Fileforstoringusercredentials.*/privatestaticfinaljava.io.FileDATA_STORE_FILE=newFile(System.getProperty("user.home"),".credentials/doubleclicksearch.json");/***Globalinstanceofthe{DataStoreFactory}.Thebestpracticeistomakeitasingle*globallysharedinstanceacrossyourapplication.*/privatestaticFileDataStoreFactorydataStoreFactory;/***SetsupanewDoubleclicksearchservice.Thebuilderfortheservice*requiresaCredentialobject,whichprovidesthecredentialsneededto*interactwithSearchAds360.*/privatestaticDoubleclicksearchgetService()throwsException{JsonFactoryjsonFactory=newJacksonFactory();NetHttpTransporttransport=GoogleNetHttpTransport.newTrustedTransport();Credentialcredential=readCredentialFromCommandLine(jsonFactory,transport);returnnewDoubleclicksearch.Builder(transport,jsonFactory,credential).setApplicationName("Sample").build();}/***Generatesacredentialbyreadingclientid,clientsecretandrefresh*tokenfromthecommandline.Youcouldupdatethismethodtoreadthe*datafromadatabaseorothersecurelocation.*/privatestaticCredentialreadCredentialFromCommandLine(JsonFactoryjsonFactory,NetHttpTransporttransport){StringclientId=System.console().readLine("Client id: ");StringclientSecret=System.console().readLine("Client secret: ");StringrefreshToken=System.console().readLine("Refresh token: ");returnnewGoogleCredential.Builder().setJsonFactory(jsonFactory).setTransport(transport).setClientSecrets(clientId,clientSecret).build().setRefreshToken(refreshToken);}/***Thismethodisanalternativeto{@link#readCredentialFromCommandLine}. It reads*clientsecretsfroma{@codeclient_secrets.json}file,interactivelycreates*thenecessaryauthorizationtokensonfirstrun,andstoresthetokensinthe*{@codeFileDataStore}.Subsequentrunswillnolongerrequireinteractivity*aslongasthe{@code.credentials/doubleclicksearch.json}fileisnotremoved.*Youcandownloadthe{@code.credentials/doubleclicksearch.json}filefromthe*GoogleAPIConsole.*Notethatsettingthe{@linkGoogleAuthorizationCodeFlow}accesstype*to{@codeoffline}iswhatcauses{@codeGoogleAuthorizationCodeFlow}toobtain*andstorerefreshtokens.*/privatestaticCredentialgenerateCredentialInteractively(JsonFactoryjsonFactory,NetHttpTransporttransport)throwsException{dataStoreFactory=newFileDataStoreFactory(DATA_STORE_FILE);GoogleClientSecretsclientSecrets=GoogleClientSecrets.load(jsonFactory,newInputStreamReader(Doubleclicksearch.class.getResourceAsStream("/client_secrets.json")));GoogleAuthorizationCodeFlowflow=newGoogleAuthorizationCodeFlow.Builder(transport,jsonFactory,clientSecrets,Arrays.asList(SCOPES)).setDataStoreFactory(dataStoreFactory).setAccessType("offline").build();returnnewAuthorizationCodeInstalledApp(flow,newLocalServerReceiver()).authorize("user");}
.NET
usingSystem;usingSystem.Collections.Generic;usingSystem.IO;usingSystem.Threading;usingGoogle.Apis.Auth.OAuth2;usingGoogle.Apis.Auth.OAuth2.Flows;usingapi=Google.Apis.Doubleclicksearch.v2;///<summary>///CreatesaDoubleclicksearchAPIservicewithstaticcredentials.///</summary>///<paramname="clientId">APIprojectclientID.<param>///<paramname="clientSecret">APIprojectclientsecret.<param>///<paramname="refreshToken">Refreshtokengeneratedforinstalledapplications.<param>privatestaticapi.DoubleclicksearchServiceCreateService(StringclientId,StringclientSecret,StringrefreshToken){vartoken=newGoogle.Apis.Auth.OAuth2.Responses.TokenResponse{RefreshToken=refreshToken,};varcredentials=newUserCredential(newGoogleAuthorizationCodeFlow(newGoogleAuthorizationCodeFlow.Initializer{ClientSecrets=newClientSecrets{ClientId=clientId,ClientSecret=clientSecret,},}),"user",token);returnnewapi.DoubleclicksearchService(newGoogle.Apis.Services.BaseClientService.Initializer{HttpClientInitializer=credentials,ApplicationName="Sample DS API client",});}
Python
importargparseimporthttplib2fromapiclient.discoveryimportbuildfromoauth2clientimportGOOGLE_TOKEN_URIfromoauth2client.clientimportOAuth2Credentials,HttpAccessTokenRefreshErrordefcreate_credentials(client_id,client_secret,refresh_token):"""Create Google OAuth2 credentials.Args:client_id: Client id of a Google Cloud console project.client_secret: Client secret of a Google Cloud console project.refresh_token: A refresh token authorizing the Google Cloud console projectto access the DS data of some Google user.Returns:OAuth2Credentials"""returnOAuth2Credentials(access_token=None,client_id=client_id,client_secret=client_secret,refresh_token=refresh_token,token_expiry=None,token_uri=GOOGLE_TOKEN_URI,user_agent=None)defget_service(credentials):"""Set up a new Doubleclicksearch service.Args:credentials: An OAuth2Credentials generated with create_credentials, orflows in the oatuh2client.client package.Returns:An authorized Doubleclicksearch serivce."""# Use the authorize() function of OAuth2Credentials to apply necessary credential# headers to all requests.http=credentials.authorize(http=httplib2.Http())# Construct the service object for the interacting with the Search Ads 360 API.service=build('doubleclicksearch','v2',http=http)returnserviceif__name__=='__main__':parser=argparse.ArgumentParser(description='Sample DS API code.')parser.add_argument('--client_id',dest='c_id',action='store',help=('Specifies the DS API client_id. Looks like: ''1234567890.apps.googleusercontent.com'),required=True)parser.add_argument('--client_secret',dest='secret',action='store',help=('Specifies the DS API client_secret. Looks like: ''1ab2CDEfghigKlM3OPzyx2Q'),required=True)parser.add_argument('--refresh_token',dest='token',action='store',help=('Specifies the DS API refresh_token. Looks like: ''4/abC1ddW3WJURhF7DUj-6FHq8kkE'),required=True)args=parser.parse_args()creds=create_credentials(args.c_id,args.secret,args.token)try:service=get_service(creds)print'Successfully loaded credentials.'exceptHttpAccessTokenRefreshError:print('Error: Unable to get credentials. Please ensure that the ''credentials are correct. ''https://developers.google.com/search-ads/v2/authorizing')
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThe Search Ads 360 API interacts through the \u003ccode\u003eDoubleclicksearch\u003c/code\u003e service object, requiring instantiation for usage.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eDoubleclicksearch\u003c/code\u003e instance needs credentials and an OAuth 2.0 access token to communicate with the API.\u003c/p\u003e\n"],["\u003cp\u003eCode examples in Java, .NET, and Python demonstrate how to create and set up the \u003ccode\u003eDoubleclicksearch\u003c/code\u003e service object with the required authentication information.\u003c/p\u003e\n"],["\u003cp\u003eObtain OAuth 2.0 credentials using the provided setup guide before proceeding with API integration.\u003c/p\u003e\n"]]],["Applications using client libraries interact with the Search Ads 360 API via a `Doubleclicksearch` service object, which requires OAuth 2.0 credentials. These credentials, including client ID, client secret, and refresh token, are passed to the API with each request. Code examples in Java, .NET, and Python demonstrate creating this service object. The Java example shows reading credentials from the command line or a JSON file, while .NET and Python illustrate setting credentials with a token response.\n"],null,["# Set Up Your Application\n\nIf you are using a client library, your application will need to instantiate a\n`Doubleclicksearch` service object. All interaction with the Search Ads 360 API\noccurs through this service object. If you aren't using a client library\nyou can skip this section, but you'll need to write some code that can send HTTP requests\nand parse the responses.\n\nEach `Doubleclicksearch` instance needs a\nreference to an object that contains your credentials and OAuth 2.0 access token.\n`Doubleclicksearch` will pass the credentials and token to the Search Ads 360 API\nin each request. The following code demonstrates how to instantiate a `Doubleclicksearch`\nservice object using OAuth 2.0 for installed applications.\n\nIf you haven't already obtained your OAuth 2.0 credentials for the Search Ads 360 API,\nsee [Set Up Authorization](/search-ads/v2/authorizing). \n\n### Java\n\n```python\nimport com.google.api.client.auth.oauth2.Credential;\nimport com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;\nimport com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;\nimport com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;\nimport com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;\nimport com.google.api.client.googleapis.auth.oauth2.GoogleCredential;\nimport com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;\nimport com.google.api.client.http.javanet.NetHttpTransport;\nimport com.google.api.client.json.JsonFactory;\nimport com.google.api.client.json.jackson2.JacksonFactory;\nimport com.google.api.client.util.store.DataStoreFactory;\nimport com.google.api.client.util.store.FileDataStoreFactory;\nimport com.google.api.services.doubleclicksearch.Doubleclicksearch;\n\nimport java.io.File;\nimport java.io.FileOutputStream;\nimport java.io.IOException;\nimport java.io.InputStreamReader;\nimport java.io.PrintStream;\nimport java.util.Arrays;\n\nprivate static final String[] SCOPES =\n new String[] {\n \"https://www.googleapis.com/auth/doubleclicksearch\"\n };\n\n/** File for storing user credentials. */\nprivate static final java.io.File DATA_STORE_FILE =\n new File(System.getProperty(\"user.home\"), \".credentials/doubleclicksearch.json\");\n\n/**\n * Global instance of the {DataStoreFactory}. The best practice is to make it a single\n * globally shared instance across your application.\n */\nprivate static FileDataStoreFactory dataStoreFactory;\n\n/**\n * Sets up a new Doubleclicksearch service. The builder for the service\n * requires a Credential object, which provides the credentials needed to\n * interact with Search Ads 360.\n */\nprivate static Doubleclicksearch getService() throws Exception {\n JsonFactory jsonFactory = new JacksonFactory();\n NetHttpTransport transport = GoogleNetHttpTransport.newTrustedTransport();\n\n Credential credential = readCredentialFromCommandLine(jsonFactory, transport);\n\n return new Doubleclicksearch.Builder(transport, jsonFactory, credential)\n .setApplicationName(\"Sample\")\n .build();\n}\n\n/**\n * Generates a credential by reading client id, client secret and refresh\n * token from the command line. You could update this method to read the\n * data from a database or other secure location.\n */\nprivate static Credential readCredentialFromCommandLine(\n JsonFactory jsonFactory,\n NetHttpTransport transport) {\n String clientId = System.console().readLine(\"Client id: \");\n String clientSecret = System.console().readLine(\"Client secret: \");\n String refreshToken = System.console().readLine(\"Refresh token: \");\n return new GoogleCredential.Builder()\n .setJsonFactory(jsonFactory)\n .setTransport(transport)\n .setClientSecrets(clientId, clientSecret)\n .build()\n .setRefreshToken(refreshToken);\n}\n\n/**\n * This method is an alternative to {@link #readCredentialFromCommandLine}. It reads\n * client secrets from a {@code client_secrets.json} file, interactively creates\n * the necessary authorization tokens on first run, and stores the tokens in the\n * {@code FileDataStore}. Subsequent runs will no longer require interactivity\n * as long as the {@code .credentials/doubleclicksearch.json} file is not removed.\n * You can download the {@code .credentials/doubleclicksearch.json} file from the\n * Google API Console.\n * Note that setting the {@link GoogleAuthorizationCodeFlow} access type\n * to {@code offline} is what causes {@code GoogleAuthorizationCodeFlow} to obtain\n * and store refresh tokens.\n */\nprivate static Credential generateCredentialInteractively(\n JsonFactory jsonFactory,\n NetHttpTransport transport) throws Exception {\n dataStoreFactory = new FileDataStoreFactory(DATA_STORE_FILE);\n GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(\n jsonFactory, new InputStreamReader(\n Doubleclicksearch.class.getResourceAsStream(\"/client_secrets.json\")));\n GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(\n transport, jsonFactory, clientSecrets, Arrays.asList(SCOPES))\n .setDataStoreFactory(dataStoreFactory)\n .setAccessType(\"offline\")\n .build();\n return new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize(\"user\");\n}\n```\n\n### .NET\n\n```gdscript\nusing System;\nusing System.Collections.Generic;\nusing System.IO;\nusing System.Threading;\n\nusing Google.Apis.Auth.OAuth2;\nusing Google.Apis.Auth.OAuth2.Flows;\nusing api = Google.Apis.Doubleclicksearch.v2;\n\n/// \u003csummary\u003e\n/// Creates a Doubleclicksearch API service with static credentials.\n/// \u003c/summary\u003e\n/// \u003cparam name=\"clientId\"\u003eAPI project client ID.\u003cparam\u003e\n/// \u003cparam name=\"clientSecret\"\u003eAPI project client secret.\u003cparam\u003e\n/// \u003cparam name=\"refreshToken\"\u003eRefresh token generated for installed applications.\u003cparam\u003e\nprivate static api.DoubleclicksearchService CreateService(\n String clientId,\n String clientSecret,\n String refreshToken)\n{\n var token = new Google.Apis.Auth.OAuth2.Responses.TokenResponse\n {\n RefreshToken = refreshToken,\n };\n var credentials = new UserCredential(new GoogleAuthorizationCodeFlow(\n new GoogleAuthorizationCodeFlow.Initializer\n {\n ClientSecrets = new ClientSecrets\n {\n ClientId = clientId,\n ClientSecret = clientSecret,\n },\n }), \"user\", token);\n\n return new api.DoubleclicksearchService(\n new Google.Apis.Services.BaseClientService.Initializer\n {\n HttpClientInitializer = credentials,\n ApplicationName = \"Sample DS API client\",\n });\n}\n```\n\n### Python\n\n```python\nimport argparse\nimport httplib2\nfrom apiclient.discovery import build\nfrom oauth2client import GOOGLE_TOKEN_URI\nfrom oauth2client.client import OAuth2Credentials, HttpAccessTokenRefreshError\n\n\ndef create_credentials(client_id, client_secret, refresh_token):\n \"\"\"Create Google OAuth2 credentials.\n\n Args:\n client_id: Client id of a Google Cloud console project.\n client_secret: Client secret of a Google Cloud console project.\n refresh_token: A refresh token authorizing the Google Cloud console project\n to access the DS data of some Google user.\n\n Returns:\n OAuth2Credentials\n \"\"\"\n return OAuth2Credentials(access_token=None,\n client_id=client_id,\n client_secret=client_secret,\n refresh_token=refresh_token,\n token_expiry=None,\n token_uri=GOOGLE_TOKEN_URI,\n user_agent=None)\n\n\ndef get_service(credentials):\n \"\"\"Set up a new Doubleclicksearch service.\n\n Args:\n credentials: An OAuth2Credentials generated with create_credentials, or\n flows in the oatuh2client.client package.\n Returns:\n An authorized Doubleclicksearch serivce.\n \"\"\"\n # Use the authorize() function of OAuth2Credentials to apply necessary credential\n # headers to all requests.\n http = credentials.authorize(http = httplib2.Http())\n\n # Construct the service object for the interacting with the Search Ads 360 API.\n service = build('doubleclicksearch', 'v2', http=http)\n return service\n\n\nif __name__ == '__main__':\n parser = argparse.ArgumentParser(description='Sample DS API code.')\n parser.add_argument('--client_id', dest='c_id', action='store',\n help=('Specifies the DS API client_id. Looks like: '\n '1234567890.apps.googleusercontent.com'),\n required=True)\n parser.add_argument('--client_secret', dest='secret', action='store',\n help=('Specifies the DS API client_secret. Looks like: '\n '1ab2CDEfghigKlM3OPzyx2Q'),\n required=True)\n parser.add_argument('--refresh_token', dest='token', action='store',\n help=('Specifies the DS API refresh_token. Looks like: '\n '4/abC1ddW3WJURhF7DUj-6FHq8kkE'),\n required=True)\n args = parser.parse_args()\n\n creds = create_credentials(args.c_id, args.secret, args.token)\n try:\n service = get_service(creds)\n print 'Successfully loaded credentials.'\n except HttpAccessTokenRefreshError:\n print ('Error: Unable to get credentials. Please ensure that the '\n 'credentials are correct. '\n 'https://developers.google.com/search-ads/v2/authorizing'\n )\n```"]]
