Overview
Configuration is provided for establishing connections with Google Search Console service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to Google Search Console REST API using COZYROC's REST Connection Manager.
Connect using OAUTH
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From the drop-down menu Configuration select Google Search Console. Then click New in the Token File parameter to create a new token file.
Step 3: Click on the Next button in the next wizard.
Step 4: In the following wizard provide Email. Then press the 'Next' button.
Step 5: In the following wizard provide Password. Then press the 'Next' button.
Step 6: In the following wizard, check the desired scopes. Then press the 'Continue' button.
Step 7: Save the generated access token to the file. Specify token protection password. Click OK.
Step 8. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Google Search Console instance using the OAUTH Authentication type.
Connect using API Key
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From the drop-down menu Configuration select Google Search Console. Choose Authentication type API Key from the Authentication drop-down menu. Then specify the value for parameter key in the grid below.
Step 8. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Google Search Console instance using API Key Authentication type.
In this guide, we will show how to read data from the Google Search Console service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop the COZYROC "REST Source" component.
Step 3. Double-click on the "REST Source" component and select Google Search Console connection from the combo. Select from the available Google Search Console resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select the Google Search Console resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from the Google Search Console service.
In this guide, we will show how to write data to the Google Search Console service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop the COZYROC "REST Destination" component.
Step 3. Double-click on the "REST Destination" component and select Google Search Console connection from the combo. Also, select resource action and the Google Search Console resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Google Search Console resource.
Configuration
Base URL address: https://www.googleapis.com/webmasters/v3.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developers.google.com/identity/protocols/oauth2.
- API Key
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- key:
The following request parameters will be automatically processed during the authentication process:
-
key:
{{=connection.user.key}}
Documentation: https://developers.google.com/webmaster-tools/v1/how-tos/authorizing#APIKey.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sites.
The result is extracted from:{{=response.siteEntry}}.Documentation: https://developers.google.com/webmaster-tools/v1/sites/list.
- [Read single] action
-
Endpoint URL address:
/sites/{{=encodeURIComponent(parameters.siteURL)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- siteURL: Required. Specify the URL of the property to retrieve, as defined by Search Console.
Documentation: https://developers.google.com/webmaster-tools/v1/sites/get.
- [Create] action
-
Endpoint URL address:
/sites/{{=encodeURIComponent(item.siteUrl)}}.
The action uses PUT method.Documentation: https://developers.google.com/webmaster-tools/v1/sites/add.
- [Delete] action
-
Endpoint URL address:
/sites/{{=encodeURIComponent(item.siteUrl)}}.Documentation: https://developers.google.com/webmaster-tools/v1/sites/delete.
- siteUrl
A key field. Template: LongText.
- permissionLevel
Template: ShortText.
- sitemaps
A read-only field. The value is gathered from
/sites/{{=encodeURIComponent(item.siteUrl)}}/sitemapsaddress. The gathered value is processed with{{=response.sitemap}}expression. Field components:- An array.
-
Uses template:
Sitemap.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sites/{{=encodeURIComponent(parameters.siteURL)}}/sitemaps.
The result is extracted from:{{=response.sitemap}}.The action has the following user-defined parameters:
- siteURL: Required. Specify the URL of the property to retrieve, as defined by Search Console.
Documentation: https://developers.google.com/webmaster-tools/v1/sitemaps/list.
- [Read single] action
-
Endpoint URL address:
/sites/{{=encodeURIComponent(parameters.siteURL)}}/sitemaps/{{=encodeURIComponent(parameters.feedpath)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- siteURL: Required. Specify the URL of the property to retrieve, as defined by Search Console.
- feedpath: Required. Specify the URL of the actual sitemap. For example: http://www.example.com/sitemap.xml
Documentation: https://developers.google.com/webmaster-tools/v1/sitemaps/get.
- [Create] action
-
Endpoint URL address:
/sites/{{=encodeURIComponent(parameters.siteUrl)}}/sitemaps/{{=encodeURIComponent(item.path)}}.
The action uses PUT method.The action has the following user-defined parameters:
- siteURL: Required. Specify the URL of the property to retrieve, as defined by Search Console.
Documentation: https://developers.google.com/webmaster-tools/v1/sitemaps/submit.
- [Delete] action
-
Endpoint URL address:
/sites/{{=encodeURIComponent(parameters.siteUrl)}}/sitemaps/{{=encodeURIComponent(item.path)}}.The action has the following user-defined parameters:
- siteURL: Required. Specify the URL of the property to retrieve, as defined by Search Console.
Documentation: https://developers.google.com/webmaster-tools/v1/sitemaps/delete.
The resource includes the fields from the Sitemap template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
https://searchconsole.googleapis.com/v1/urlInspection/index:inspect.
The result is extracted from:{{=[response.inspectionResult]}}.
The action uses POST method.The action has the following user-defined parameters:
- inspectionUrl: Required. Fully-qualified URL to inspect. Must be under the property specified in "siteUrl".
- siteUrl: Required. The URL of the property as defined in Search Console.
- languageCode: Specify languageCode e.g. "en-US", "or "de-CH". Default value is "en-US". Optional.
The following request parameters will be automatically processed:
-
application/json:
{{=parameters}}
Documentation: https://developers.google.com/webmaster-tools/v1/urlInspection.index/inspect.
- inspectionResultLink
Template: LongText.
- indexStatusResult
Field components:
-
Uses template:
ShortText. - Contains the following components: verdict, coverageState, robotsTxtState, indexingState, lastCrawlTime, pageFetchState, googleCanonical, referringUrls, crawledAs.
-
Uses template:
- ampResult
Field components:
-
Uses template:
ShortText. - Contains the following components: issues, verdict, ampUrl, robotsTxtState, indexingState, ampIndexStatusVerdict, lastCrawlTime, pageFetchState.
-
Uses template:
- mobileUsabilityResult
Field components:
-
Uses template:
ShortText. - Contains the following components: issues, verdict.
-
Uses template:
- richResultsResult
Field components:
-
Uses template:
ShortText. - Contains the following components: detectedItems, verdict.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sites/{{=encodeURIComponent(parameters.siteUrl)}}/searchAnalytics/query.
The result is extracted from:{{=response.rows}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- siteUrl: Required. The URL of the property as defined in Search Console.
- startDate: Required. Specify the Start date of the requested date range, in YYYY-MM-DD format.
- endDate: Required. Specify the End date of the requested date range, in YYYY-MM-DD format.
- dimensions: Specify dimensions to group results by (e.g) ["DATE", "QUERY", "PAGE", "COUNTRY", "DEVICE", "SEARCH_APPEARANCE"]. Optional.
- type: Specify to filter the results based on desired type. Optional.
- dimensionFilterGroups: Specify in the expected format: [{"filters":[{"dimension": "COUNTRY","operator": "EQUALS","expression": "FRA"}]}]. Optional.
- aggregationType: Specify how data is aggregated. Optional.
- dataState: Specify the data state. Optional.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend( { startRow: parameters.iterator, rowLimit: parameters.batchSize, dimensions: parameters.get('dimensions') && JSON.parse(parameters.dimensions), dimensionFilterGroups: parameters.get('dimensionFilterGroups') && JSON.parse(parameters.dimensionFilterGroups) }, parameters )}}
Documentation: https://developers.google.com/webmaster-tools/v1/searchanalytics/query.
- clicks
Data type: DT_R8
- impressions
Data type: DT_R8
- ctr
Data type: DT_R8
- position
Data type: DT_R8
- [External]
-
The external fields list is extracted from:
{{=_.map(JSON.parse(parameters.get('dimensions', [])), function(dim, i) { return { name: dim, index: i }; })}}.- {{=external.name}}
Template: ShortText. The gathered value is processed with
{{=item.keys[field.external.index]}}expression.
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Content
Field components:
-
Uses template:
ShortText. - Contains the following components: type, submitted, indexed.
-
Uses template:
- Sitemap
Field components:
-
Uses template:
LongText. - Contains the following components: path, lastSubmitted, isPending, isSitemapsIndex, type, lastDownloaded, warnings, errors, contents.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.