{ "uuid": "44d06fa9-a282-41e3-a72e-8a28684d711f", "lastMigration": 29, "name": "Search Ads 360 API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "709f1b79-b45e-4902-aa4d-df7c75f65380", "documentation": "Retrieves a list of conversions from a DoubleClick Search engine account.", "method": "get", "endpoint": "doubleclicksearch/v2/agency/:agencyId/advertiser/:advertiserId/engine/:engineAccountId/conversion", "responses": [ { "uuid": "3fa19642-6b68-4f78-96c9-091adcdff33f", "body": "{\n \"conversion\": [\n {\n \"adGroupId\": \"\",\n \"adId\": \"\",\n \"advertiserId\": \"\",\n \"agencyId\": \"\",\n \"attributionModel\": \"\",\n \"campaignId\": \"\",\n \"channel\": \"\",\n \"clickId\": \"\",\n \"conversionId\": \"\",\n \"conversionModifiedTimestamp\": \"\",\n \"conversionTimestamp\": \"\",\n \"countMillis\": \"\",\n \"criterionId\": \"\",\n \"currencyCode\": \"\",\n \"customDimension\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"customMetric\": [\n {\n \"name\": \"\",\n \"value\": {{faker 'number.float'}}\n }\n ],\n \"deviceType\": \"\",\n \"dsConversionId\": \"\",\n \"engineAccountId\": \"\",\n \"floodlightOrderId\": \"\",\n \"inventoryAccountId\": \"\",\n \"productCountry\": \"\",\n \"productGroupId\": \"\",\n \"productId\": \"\",\n \"productLanguage\": \"\",\n \"quantityMillis\": \"\",\n \"revenueMicros\": \"\",\n \"segmentationId\": \"\",\n \"segmentationName\": \"\",\n \"segmentationType\": \"\",\n \"state\": \"\",\n \"storeId\": \"\",\n \"type\": \"\"\n }\n ],\n \"kind\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "48958f62-97cd-4c25-b30c-d2b7a08b5436", "documentation": "Downloads a csv file(encoded in UTF-8) that contains ID mappings between legacy SA360 and new SA360. The file includes all children entities of the given advertiser(e.g. engine accounts, campaigns, ad groups, etc.) that exist in both legacy SA360 and new SA360.", "method": "get", "endpoint": "doubleclicksearch/v2/agency/:agencyId/advertiser/:advertiserId/idmapping", "responses": [ { "uuid": "f7c65275-e59a-4445-a99b-809d0e855a8e", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d04f657a-7097-4f58-a532-3210a00a5ec4", "documentation": "Retrieve the list of saved columns for a specified advertiser.", "method": "get", "endpoint": "doubleclicksearch/v2/agency/:agencyId/advertiser/:advertiserId/savedcolumns", "responses": [ { "uuid": "3f34fde5-6f14-4e76-918a-6b3852d34c8b", "body": "{\n \"items\": [\n {\n \"kind\": \"\",\n \"savedColumnName\": \"\",\n \"type\": \"\"\n }\n ],\n \"kind\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "47170257-db55-4820-ab8a-c782496d4f13", "documentation": "Inserts a batch of new conversions into DoubleClick Search.", "method": "post", "endpoint": "doubleclicksearch/v2/conversion", "responses": [ { "uuid": "f270e8ce-e4e5-4220-a6e7-cc9a6c718a09", "body": "{\n \"conversion\": [\n {\n \"adGroupId\": \"\",\n \"adId\": \"\",\n \"advertiserId\": \"\",\n \"agencyId\": \"\",\n \"attributionModel\": \"\",\n \"campaignId\": \"\",\n \"channel\": \"\",\n \"clickId\": \"\",\n \"conversionId\": \"\",\n \"conversionModifiedTimestamp\": \"\",\n \"conversionTimestamp\": \"\",\n \"countMillis\": \"\",\n \"criterionId\": \"\",\n \"currencyCode\": \"\",\n \"customDimension\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"customMetric\": [\n {\n \"name\": \"\",\n \"value\": {{faker 'number.float'}}\n }\n ],\n \"deviceType\": \"\",\n \"dsConversionId\": \"\",\n \"engineAccountId\": \"\",\n \"floodlightOrderId\": \"\",\n \"inventoryAccountId\": \"\",\n \"productCountry\": \"\",\n \"productGroupId\": \"\",\n \"productId\": \"\",\n \"productLanguage\": \"\",\n \"quantityMillis\": \"\",\n \"revenueMicros\": \"\",\n \"segmentationId\": \"\",\n \"segmentationName\": \"\",\n \"segmentationType\": \"\",\n \"state\": \"\",\n \"storeId\": \"\",\n \"type\": \"\"\n }\n ],\n \"kind\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d728c650-fff0-4914-a8a1-d447958162ee", "documentation": "Updates a batch of conversions in DoubleClick Search.", "method": "put", "endpoint": "doubleclicksearch/v2/conversion", "responses": [ { "uuid": "99aee789-4d70-403a-87fe-593617e8656c", "body": "{\n \"conversion\": [\n {\n \"adGroupId\": \"\",\n \"adId\": \"\",\n \"advertiserId\": \"\",\n \"agencyId\": \"\",\n \"attributionModel\": \"\",\n \"campaignId\": \"\",\n \"channel\": \"\",\n \"clickId\": \"\",\n \"conversionId\": \"\",\n \"conversionModifiedTimestamp\": \"\",\n \"conversionTimestamp\": \"\",\n \"countMillis\": \"\",\n \"criterionId\": \"\",\n \"currencyCode\": \"\",\n \"customDimension\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"customMetric\": [\n {\n \"name\": \"\",\n \"value\": {{faker 'number.float'}}\n }\n ],\n \"deviceType\": \"\",\n \"dsConversionId\": \"\",\n \"engineAccountId\": \"\",\n \"floodlightOrderId\": \"\",\n \"inventoryAccountId\": \"\",\n \"productCountry\": \"\",\n \"productGroupId\": \"\",\n \"productId\": \"\",\n \"productLanguage\": \"\",\n \"quantityMillis\": \"\",\n \"revenueMicros\": \"\",\n \"segmentationId\": \"\",\n \"segmentationName\": \"\",\n \"segmentationType\": \"\",\n \"state\": \"\",\n \"storeId\": \"\",\n \"type\": \"\"\n }\n ],\n \"kind\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5b74350c-6e8a-48ac-9cc2-07b8c8f798bc", "documentation": "Updates the availabilities of a batch of floodlight activities in DoubleClick Search.", "method": "post", "endpoint": "doubleclicksearch/v2/conversion/updateAvailability", "responses": [ { "uuid": "b18b2b62-8e01-453d-88c1-0d0fb87b0a4c", "body": "{\n \"availabilities\": [\n {\n \"advertiserId\": \"\",\n \"agencyId\": \"\",\n \"availabilityTimestamp\": \"\",\n \"segmentationId\": \"\",\n \"segmentationName\": \"\",\n \"segmentationType\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ed4e725c-4eea-4165-a966-2d286c84c3c0", "documentation": "Inserts a report request into the reporting system.", "method": "post", "endpoint": "doubleclicksearch/v2/reports", "responses": [ { "uuid": "a8d6fc06-8b1a-4720-9fc0-d12a4378df03", "body": "{\n \"files\": [\n {\n \"byteCount\": \"\",\n \"url\": \"\"\n }\n ],\n \"id\": \"\",\n \"isReportReady\": {{faker 'datatype.boolean'}},\n \"kind\": \"\",\n \"request\": {\n \"columns\": [\n {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n }\n ],\n \"downloadFormat\": \"\",\n \"filters\": [\n {\n \"column\": {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n },\n \"operator\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ],\n \"includeDeletedEntities\": {{faker 'datatype.boolean'}},\n \"includeRemovedEntities\": {{faker 'datatype.boolean'}},\n \"maxRowsPerFile\": {{faker 'number.int' max=99999}},\n \"orderBy\": [\n {\n \"column\": {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n },\n \"sortOrder\": \"\"\n }\n ],\n \"reportScope\": {\n \"adGroupId\": \"\",\n \"adId\": \"\",\n \"advertiserId\": \"\",\n \"agencyId\": \"\",\n \"campaignId\": \"\",\n \"engineAccountId\": \"\",\n \"keywordId\": \"\"\n },\n \"reportType\": \"\",\n \"rowCount\": {{faker 'number.int' max=99999}},\n \"startRow\": {{faker 'number.int' max=99999}},\n \"statisticsCurrency\": \"\",\n \"timeRange\": {\n \"changedAttributesSinceTimestamp\": \"\",\n \"changedMetricsSinceTimestamp\": \"\",\n \"endDate\": \"\",\n \"startDate\": \"\"\n },\n \"verifySingleTimeZone\": {{faker 'datatype.boolean'}}\n },\n \"rowCount\": {{faker 'number.int' max=99999}},\n \"rows\": [\n {}\n ],\n \"statisticsCurrencyCode\": \"\",\n \"statisticsTimeZone\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0562e159-a6ba-4469-9cc0-a62d4a595a74", "documentation": "Generates and returns a report immediately.", "method": "post", "endpoint": "doubleclicksearch/v2/reports/generate", "responses": [ { "uuid": "1db05d6f-60d2-4346-818b-4a29aafdb030", "body": "{\n \"files\": [\n {\n \"byteCount\": \"\",\n \"url\": \"\"\n }\n ],\n \"id\": \"\",\n \"isReportReady\": {{faker 'datatype.boolean'}},\n \"kind\": \"\",\n \"request\": {\n \"columns\": [\n {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n }\n ],\n \"downloadFormat\": \"\",\n \"filters\": [\n {\n \"column\": {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n },\n \"operator\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ],\n \"includeDeletedEntities\": {{faker 'datatype.boolean'}},\n \"includeRemovedEntities\": {{faker 'datatype.boolean'}},\n \"maxRowsPerFile\": {{faker 'number.int' max=99999}},\n \"orderBy\": [\n {\n \"column\": {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n },\n \"sortOrder\": \"\"\n }\n ],\n \"reportScope\": {\n \"adGroupId\": \"\",\n \"adId\": \"\",\n \"advertiserId\": \"\",\n \"agencyId\": \"\",\n \"campaignId\": \"\",\n \"engineAccountId\": \"\",\n \"keywordId\": \"\"\n },\n \"reportType\": \"\",\n \"rowCount\": {{faker 'number.int' max=99999}},\n \"startRow\": {{faker 'number.int' max=99999}},\n \"statisticsCurrency\": \"\",\n \"timeRange\": {\n \"changedAttributesSinceTimestamp\": \"\",\n \"changedMetricsSinceTimestamp\": \"\",\n \"endDate\": \"\",\n \"startDate\": \"\"\n },\n \"verifySingleTimeZone\": {{faker 'datatype.boolean'}}\n },\n \"rowCount\": {{faker 'number.int' max=99999}},\n \"rows\": [\n {}\n ],\n \"statisticsCurrencyCode\": \"\",\n \"statisticsTimeZone\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0d5f52d2-8782-4913-bf57-c3d623c48609", "documentation": "Polls for the status of a report request.", "method": "get", "endpoint": "doubleclicksearch/v2/reports/:reportId", "responses": [ { "uuid": "77eb8abb-3811-4b02-b49d-a437ddc045c2", "body": "{\n \"files\": [\n {\n \"byteCount\": \"\",\n \"url\": \"\"\n }\n ],\n \"id\": \"\",\n \"isReportReady\": {{faker 'datatype.boolean'}},\n \"kind\": \"\",\n \"request\": {\n \"columns\": [\n {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n }\n ],\n \"downloadFormat\": \"\",\n \"filters\": [\n {\n \"column\": {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n },\n \"operator\": \"\",\n \"values\": [\n \"\"\n ]\n }\n ],\n \"includeDeletedEntities\": {{faker 'datatype.boolean'}},\n \"includeRemovedEntities\": {{faker 'datatype.boolean'}},\n \"maxRowsPerFile\": {{faker 'number.int' max=99999}},\n \"orderBy\": [\n {\n \"column\": {\n \"columnName\": \"\",\n \"customDimensionName\": \"\",\n \"customMetricName\": \"\",\n \"endDate\": \"\",\n \"groupByColumn\": {{faker 'datatype.boolean'}},\n \"headerText\": \"\",\n \"platformSource\": \"\",\n \"productReportPerspective\": \"\",\n \"savedColumnName\": \"\",\n \"startDate\": \"\"\n },\n \"sortOrder\": \"\"\n }\n ],\n \"reportScope\": {\n \"adGroupId\": \"\",\n \"adId\": \"\",\n \"advertiserId\": \"\",\n \"agencyId\": \"\",\n \"campaignId\": \"\",\n \"engineAccountId\": \"\",\n \"keywordId\": \"\"\n },\n \"reportType\": \"\",\n \"rowCount\": {{faker 'number.int' max=99999}},\n \"startRow\": {{faker 'number.int' max=99999}},\n \"statisticsCurrency\": \"\",\n \"timeRange\": {\n \"changedAttributesSinceTimestamp\": \"\",\n \"changedMetricsSinceTimestamp\": \"\",\n \"endDate\": \"\",\n \"startDate\": \"\"\n },\n \"verifySingleTimeZone\": {{faker 'datatype.boolean'}}\n },\n \"rowCount\": {{faker 'number.int' max=99999}},\n \"rows\": [\n {}\n ],\n \"statisticsCurrencyCode\": \"\",\n \"statisticsTimeZone\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fddb736c-ed9d-4337-8091-c560d309971a", "documentation": "Downloads a report file encoded in UTF-8.", "method": "get", "endpoint": "doubleclicksearch/v2/reports/:reportId/files/:reportFragment", "responses": [ { "uuid": "5a4dcfc9-740a-486c-8d35-67f5e72afcc1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "709f1b79-b45e-4902-aa4d-df7c75f65380" }, { "type": "route", "uuid": "48958f62-97cd-4c25-b30c-d2b7a08b5436" }, { "type": "route", "uuid": "d04f657a-7097-4f58-a532-3210a00a5ec4" }, { "type": "route", "uuid": "47170257-db55-4820-ab8a-c782496d4f13" }, { "type": "route", "uuid": "d728c650-fff0-4914-a8a1-d447958162ee" }, { "type": "route", "uuid": "5b74350c-6e8a-48ac-9cc2-07b8c8f798bc" }, { "type": "route", "uuid": "ed4e725c-4eea-4165-a966-2d286c84c3c0" }, { "type": "route", "uuid": "0562e159-a6ba-4469-9cc0-a62d4a595a74" }, { "type": "route", "uuid": "0d5f52d2-8782-4913-bf57-c3d623c48609" }, { "type": "route", "uuid": "fddb736c-ed9d-4337-8091-c560d309971a" } ] }