SearchAdAnalytics
Frends Task for fetching AdAnalytics from LinkedInAds.
Task version: 1.1.0
Required Frends version: 5.1+
Required .NET version: 471, 6.0, standard2.0
Compatible Agents: Legacy, Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.LinkedIn/tree/main/Frends.LinkedIn.SearchAdAnalytics
Task Parameters
Finder : Finder
Specifies the Finder used in the request.
Statistics allows up to three pivots in the request.
Analytics finder is used when specifying a single pivot.
Possible values:
Statistics: Specifies the Finder used in the request.
Statistics allows up to three pivots in the request.
Analytics finder is used when specifying a single pivot.
Analytics: Specifies the Finder used in the request.
Statistics allows up to three pivots in the request.
Analytics finder is used when specifying a single pivot.
Default: 1
Example: Finder.Statistics
Pivot : Pivot
Pivot of results, by which each report data point is grouped. Optional.
Possible values:
NONE: Pivot of results, by which each report data point is grouped. Optional.COMPANY: Pivot of results, by which each report data point is grouped. Optional.ACCOUNT: Pivot of results, by which each report data point is grouped. Optional.SHARE: Pivot of results, by which each report data point is grouped. Optional.CAMPAIGN: Pivot of results, by which each report data point is grouped. Optional.CREATIVE: Pivot of results, by which each report data point is grouped. Optional.CAMPAIGN_GROUP: Pivot of results, by which each report data point is grouped. Optional.CONVERSION: Pivot of results, by which each report data point is grouped. Optional.CONVERSATION_NODE: Pivot of results, by which each report data point is grouped. Optional.CONVERSATION_NODE_OPTION_INDEX: Pivot of results, by which each report data point is grouped. Optional.SERVING_LOCATION: Pivot of results, by which each report data point is grouped. Optional.CARD_INDEX: Pivot of results, by which each report data point is grouped. Optional.MEMBER_COMPANY_SIZE: Pivot of results, by which each report data point is grouped. Optional.MEMBER_INDUSTRY: Pivot of results, by which each report data point is grouped. Optional.MEMBER_SENIORITY: Pivot of results, by which each report data point is grouped. Optional.MEMBER_JOB_TITLE: Pivot of results, by which each report data point is grouped. Optional.MEMBER_JOB_FUNCTION: Pivot of results, by which each report data point is grouped. Optional.MEMBER_COUNTRY_V2: Pivot of results, by which each report data point is grouped. Optional.MEMBER_REGION_V2: Pivot of results, by which each report data point is grouped. Optional.MEMBER_COMPANY: Pivot of results, by which each report data point is grouped. Optional.PLACEMENT_NAME: Pivot of results, by which each report data point is grouped. Optional.IMPRESSION_DEVICE_TYPE: Pivot of results, by which each report data point is grouped. Optional.
Default: -
Example: Pivot.COMPANY
Pivots : Pivot[]
Pivot of results, by which each report data point is grouped. Optional.
Default: -
Example: [ Pivot.COMPANY, Pivot.ACCOUNT]
StartDate : String
Represents the inclusive start time range of the analytics. https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings#table-of-format-specifiers
Default: -
Example: 12-10-2023
EndDate : String
Represents the inclusive end time range of the analytics. Must be after start time if it's present. Optional. https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings#table-of-format-specifiers
Default: -
Example: 12-10-2023
TimeGranularity : TimeGranularity
Time granularity of results.
Possible values:
ALL: Time granularity of results.DAILY: Time granularity of results.MONTHLY: Time granularity of results.YEARLY: Time granularity of results.
Default: -
Example: TimeGranularity.ALL
Campaigns : String[]
Match result by campaign facets.
Default: -
Example: [ urn:li:sponsoredCampaign:1234567, urn:li:sponsoredCampaign:1234568 ]
Creatives : String[]
Match result by creative facets.
Default: -
Example: [ ]
Metrics : String[]
Default: -
Example: -
LinkedInAPIVersion : String
Version of the API used in the request.
API versions should have date format as YYYYMM or YYYYMM.RR where RR is the revision.
More information: https://learn.microsoft.com/en-us/linkedin/marketing/versioning?view=li-lms-2023-09
Default: 202309
Example: 202309
🗝Token : String
Bearer token to be used for requests. Token will be added as Authorization header.
Default: -
Example: xRqjX_9QXZlvRL6HZHJvbrubhvceV4NFccANh6RwndmAJDkPfP...
ConnectionTimeoutSeconds : Int32
Timeout in seconds to be used for the connection and operation.
Default: 30
Example: 30
FollowRedirects : Boolean
If FollowRedirects is set to false, all responses with an HTTP status code from 300 to 399 is returned to the application.
Default: True
Example: true
AllowInvalidCertificate : Boolean
Do not throw an exception on certificate error.
Default: -
Example: true
AllowInvalidResponseContentTypeCharSet : Boolean
Some Api's return faulty content-type charset header. This setting overrides the returned charset.
Default: -
Example: true
ThrowExceptionOnErrorResponse : Boolean
Throw exception if return code of request is not successfull.
Default: -
Example: true
AutomaticCookieHandling : Boolean
If set to false, cookies must be handled manually. Defaults to true.
Default: True
Example: true
Task Result
Body : Object
Body of response. Response body contains two properties: paging and elements.
Example: {"paging": {"start": 0, "count":10, "links": [], "total": 1}, "elements": [{"totalBudget": ...}]}
Headers : Dictionary<String, String>
Headers of response
Example: {[ "content-type": "application/json", ... ]}
StatusCode : Int32
Status code of the response.
Example: 200
Task Changelog
Changelog for Task Frends.LinkedIn.SearchAdAnalytics.
[1.1.0] - 2025-03-18
Changed
Update packages: Newtonsoft.Json 12.0.3 -> 13.0.3 System.ComponentModel.Annotations 4.7.0 -> 5.0.0 System.Runtime.Caching 7.0.0 -> 9.0.3 coverlet.collector 3.1.2 -> 6.0.4 Microsoft.NET.Test.Sdk 16.6.1 -> 17.13.0 nunit 3.12.0 -> 4.3.2 NUnit3TestAdapter 3.17.0 -> 5.0.0
[1.0.0] - 2023-11-02
Added
Initial implementation
Last updated
Was this helpful?

