LinkedIn Ads Connector Objects
Name | Description |
---|---|
Accounts | The Account status finder returns all accounts in a specified status that the authenticated user has access to. |
AdFormResponses | Query the response data for leads that filled out a Lead Form. Collecting Lead Form responses requires the user to be the owner of the Lead Form. |
Analytics | The Analytics API provides account, campaign, and creative level insights on click intelligence numbers. |
AudienceCount | The Audience Count API allows advertisers to forecast the reach of targeting criteria. |
BudgetPricing | The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria. |
CampaignGroups | The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to. |
Campaigns | The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to. |
Conversions | Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business. |
Creatives | The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN. |
Degrees | Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
FieldsOfStudy | Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
Forms | Query form data for the forms that belong to a specified owner (account). |
GeoLocations | Provides the display name for a given geo Id, or a set of geo Ids. |
Industries | Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
JobFunctions | Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
Posts | Retrieve all posts for an organization. |
Seniorities | Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
Skills | Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
SocialActions | The socialActions API allows access to both personal and organization social actions. |
ThirdPartyTracking | Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag. |
Titles | Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Id of the account | |
Name | String | False | No | A label for the account | |
Currency | String | False | No | The account's ISO-4217currency code. | |
Type | String | False | No | The type of account. | |
NotifiedOnCreativeRejection | Boolean | False | No | Indicates if creative contact is notified when a creative has been rejected due to content. | |
NotifiedOnEndOfCampaign | Boolean | False | No | Indicates if campaign contact is notified when an associated campaign has been completed. | |
Status | String | False | No | Status of the account | |
NotifiedOnCampaignOptimization | Boolean | False | No | Indicates if campaign contact is notified about campaign optimization opportunities. | |
Version | String | False | No | Version of the account | |
Reference | String | False | No | The entity on whose behalf the account advertises. | |
NotifiedOnCreativeApproval | Boolean | False | No | Indicates if creative contact is notified when a creative has been reviewed and approved. | |
AuditStampsCreator | String | False | No | The person who created audit stamps for the first time | |
AuditStampsCreatedAt | Datetime | False | No | The datetime in which the audit stamp was created first | |
AuditStampsLastModifier | String | False | No | Last modifier of the Audit stamps | |
AuditStampsLastModifiedAt | Datetime | False | No | Last modified datetime of the audit stamps |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Identifier for the form response. | |
Account | String | True | Accounts.Id | No | Identifier for the owner of the form. This is the advertiser account. |
Campaign | String | True | No | URN identifying the campaign to which the form response is responding. | |
Creative | String | True | No | URN identifying the creative to which the form response is responding. | |
Form | String | True | No | URN identifying which form this response responds to. | |
SubmitedAt | Datetime | True | No | Timestamp for when the form response was submitted. | |
LeadType | String | True | No | Type of the lead. This field indicates whether the lead is collected from sponsored content or viral share. Defaults to SPONSORED. | |
TestLead | Boolean | True | No | Whether the lead is a test lead. | |
ConsentResponses | String | True | No | A JSON object containing all the consent responses. | |
Answers | String | True | No | A JSON object containing all the answers and the respective questions. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Company | String | False | No | Pivot value which groups the result by advertiser's company. | |
Account | String | False | No | Pivot value which groups the result by account. | |
Share | String | False | No | Pivot value which groups the result by sponsored share. | |
Campaign | String | False | No | Pivot value which groups the result by campaign. | |
Creative | String | False | No | Pivot value which groups the result by creative. | |
CampaignGroup | String | False | No | Pivot value which groups the result by campaign group. | |
Conversion | String | False | No | Pivot value which groups the result by conversion. | |
ServingLocation | String | False | No | Pivot value which groups the result by serving location. | |
CardIndex | String | False | No | Pivot value which groups the result by card index. | |
MemberCompanySize | String | False | No | Pivot value which groups the result by member company size. | |
MemberIndustry | String | False | No | Pivot value which groups the result by member industry. | |
MemberSeniority | String | False | No | Pivot value which groups the result by member seniority. | |
MemberJobTitle | String | False | No | Pivot value which groups the result by member job title. | |
MemberJobFunction | String | False | No | Pivot value which groups the result by member job function. | |
MemberCountry | String | False | No | Pivot value which groups the result by member country. | |
MemberRegion | String | False | No | Pivot value which groups the result by member region. | |
MemberCounty | String | False | No | Pivot value which groups the result by member county. | |
MemberCompany | String | False | No | Pivot value which groups the result by member company. | |
PlacementName | String | False | No | Pivot value which groups the result by member company. | |
ImpressionDeviceType | String | False | No | Pivot value which groups the result by member company. | |
CampaignType | String | False | No | Match result by campaign type. | |
Granularity | String | False | No | Time granularity of results. | |
FinderMethod | String | False | No | Designates the query finder. The only allowed values are analytics or statistics. | |
ReportStartTime | String | False | No | The start time of the period. | |
ReportEndTime | String | False | No | The end time of the period. | |
EventStage | String | False | No | Organize results based on the stage of the live event. | |
ActionClicks | Long | True | No | The count of clicks on the action button of the Sponsored InMail. | |
AdUnitClicks | Long | True | No | The count of clicks on the ad unit displayed alongside the Sponsored InMail. | |
CardClicks | Long | True | No | The number of clicks for each card of a carousel ad. | |
CardImpressions | Long | True | No | The number of impressions shown for each card of a carousel ad. | |
Clicks | Long | True | No | The count of chargeable clicks. | |
CommentLikes | Long | True | No | The count of likes of a comment. | |
Comments | Long | True | No | The count of comments. Sponsored | |
CompanyPageClicks | Long | True | No | The count of clicks to view the company page. | |
ConversionValueInLocalCurrency | Decimal | True | No | Value of the conversions in the account's local currency based on rules defined by the advertiser. | |
CostInLocalCurrency | Decimal | True | No | Cost in the account's local currency based on the pivot and timeGranularity. | |
CostInUsd | Decimal | True | No | Cost in USD based on the pivot and timeGranularity. | |
UsageStartTime | String | True | No | Date start covered by the report data point. | |
UsageEndTime | String | True | No | Date end covered by the report data point. | |
ExternalWebsiteConversions | Long | True | No | The count of conversions indicated by pixel loads on an external advertiser website. | |
ExternalWebsitePostClickConversions | Long | True | No | The count of post-click conversions indicated by pixel loads on an external advertiser website. | |
ExternalWebsitePostViewConversions | Long | True | No | The count of post-view conversions indicated by pixel loads on an external advertiser website. | |
Follows | Long | True | No | The count of follows. Sponsored | |
FullScreenPlays | Long | True | No | A user taps on the video, going into video view mode. | |
Impressions | Long | True | No | This is the count of 'impressions' for Direct Ads and Sponsored Updates and 'sends' for InMails. | |
LandingPageClicks | Long | True | No | The count of clicks which take the user to the creative landing page. | |
LeadGenerationMailContactInfoShares | Long | True | No | The number of times a user shared contact info through the One Click Leadgen for Sponsored InMail. | |
LeadGenerationMailInterestedClicks | Long | True | No | The count of InMail recipients showing interest. | |
Likes | Long | True | No | The count of likes. | |
OneClickLeadFormOpens | Long | True | No | The count of times a user opened the lead form for a One Click Lead Gen campaign. | |
OneClickLeads | Long | True | No | The count of leads generated through One Click Lead Gen. | |
Opens | Long | True | No | The count of opens of Sponsored InMail. | |
OtherEngagements | Long | True | No | The count of user interactions with the ad unit that do not fit into any other more specific category. | |
Shares | Long | True | No | The count of shares. | |
TextUrlClicks | Long | True | No | The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail. | |
TotalEngagements | Long | True | No | The count of all user interactions with the ad unit. | |
VideoCompletions | Long | True | No | The count of video ads that played 97-100% of the video. | |
VideoFirstQuartileCompletions | Long | True | No | The count of video ads that played through the first quartile of the video. | |
VideoMidpointCompletions | Long | True | No | The count of video ads that played through the midpoint of the video. | |
VideoStarts | Long | True | No | The count of video ads that were started by a user. | |
VideoThirdQuartileCompletions | Long | True | No | The count of video ads that played through the third quartile of the video. | |
VideoViews | Long | True | No | A video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. | |
ViralCardClicks | Long | True | No | The number of viralClicks for each card of a carousel ad. | |
ViralCardImpressions | Long | True | No | The number of viralImpressions shown for each card of a carousel ad. | |
ViralClicks | Long | True | No | The count of clicks on viral impressions. | |
ViralComments | Long | True | No | The count of comments from viral impressions for this activity. | |
ViralCompanyPageClicks | Long | True | No | The count of clicks to view the company page from viral impressions for this activity. | |
ViralExternalWebsiteConversions | Long | True | No | The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event. | |
ViralExternalWebsitePostClickConversions | Long | True | No | The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click. | |
ViralExternalWebsitePostViewConversions | Long | True | No | The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression. | |
ViralFollows | Long | True | No | The count of follows from viral impressions for this activity. | |
ViralFullScreenPlays | Long | True | No | A user taps on the video, going into video view mode. | |
ViralImpressions | Long | True | No | The count of viral impressions for this activity. | |
ViralLandingPageClicks | Long | True | No | The count of clicks on viral impressions to take the user to the creative landing page. | |
ViralLikes | Long | True | No | The count of likes from viral impressions for this activity. | |
ViralOneClickLeadFormOpens | Long | True | No | The count of times a user opened the lead form for viral impressions from a Lead Gen campaign. | |
ViralOneClickLeads | Long | True | No | The count of leads generated through One Click Lead Gen from viral impressions for this activity. | |
ViralOtherEngagements | Long | True | No | The count of user interactions with viral impressions that do not fit into any other more specific category. | |
ViralShares | Long | True | No | The count of shares from viral impressions for this activity. | |
ViralTotalEngagements | Long | True | No | The count of all user interactions with a viral ad unit. | |
ViralVideoCompletions | Long | True | No | The count of viral video ads that played 97-100% of the video. | |
ViralVideoFirstQuartileCompletions | Long | True | No | The count of viral video ads that played through the first quartile of the video. | |
ViralVideoMidpointCompletions | Long | True | No | The count of viral video ads that played through the midpoint of the video. | |
ViralVideoStarts | Long | True | No | The count of viral video ads that were started by a user. | |
ViralVideoThirdQuartileCompletions | Long | True | No | The count of viral video ads that played through the third quartile of the video. | |
ViralVideoViews | Long | True | No | A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. | |
AverageDailyReachMetricsApproximateReach | Decimal | True | No | The average reach, or unique member accounts with at least one impression (daily). | |
AverageDailyReachMetricsApproximateFrequency | Decimal | True | No | The average of impressions shown to each member account that received at least one impression (daily). | |
AverageDailyReachMetricsApproximateCost | Decimal | True | No | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (daily). | |
AveragePreviousSevenDayReachMetricsApproximateReach | Decimal | True | No | The average reach, or unique member accounts with at least one impression (last 7 days). | |
AveragePreviousSevenDayReachMetricsApproximateFrequency | Decimal | True | No | The average of impressions shown to each member account that received at least one impression (last 7 days). | |
AveragePreviousSevenDayReachMetricsApproximateCost | Decimal | True | No | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 7 days). | |
AveragePreviousThirtyDayReachMetricsApproximateReach | Decimal | True | No | The average reach, or unique member accounts with at least one impression (last 30 days). | |
AveragePreviousThirtyDayReachMetricsApproximateFrequency | Decimal | True | No | The average of impressions shown to each member account that received at least one impression (last 30 days). | |
AveragePreviousThirtyDayReachMetricsApproximateCost | Decimal | True | No | The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 30 days). | |
ApproximateMemberReach | Long | True | No | The estimated number of unique member accounts with at least one impression. This metric is only available when the number of days in the date range is less than or equal to 92 days. It will be returned only if the following pivots/columns are specified in the query: Creative, Campaign, CampaignGroup, CampaignType and/or ServingLocation. Additionally, it will not be available for the current UTC day. The expected delay for current UTC day will be 24-48 hours. If the present day is specified in ReportEndTime, the date range will only return reach for days where data exists. | |
ValidWorkEmailLeads | Long | True | No | The count of leads with a valid work email that does not use an established free or personal email domain. | |
PostClickRegistrations | Decimal | True | No | The number of times a member has registered for an event or seminar after clicking on an ad which has a LinkedIn landing page. | |
PostViewRegistrations | Decimal | True | No | The number of times a member has registered for an event or seminar after viewing an ad which has a LinkedIn event landing page. | |
DownloadClicks | Long | True | No | The number of times users have indicated the intent to download the media in an ad by clicking the download icon. | |
QualifiedLeads | Long | True | No | The count of qualified leads shared by the advertiser. Qualified lead is a lead that has been deemed more likely to become a customer compared to other leads, based on their engagement and fit. | |
CostPerQualifiedLead | Decimal | True | No | How much money was spent per qualified lead. Ratio is costInLocalCurrency / qualifiedLeads. | |
MessagingAdvertSendCount | Long | True | No | The count of sends of Sponsored Messaging ads. | |
MessagingAdvertOpenCount | Long | True | No | The count of opens of Sponsored Messaging ads. | |
AudiencePenetration | Decimal | True | No | The approximate number of unique members reached by the advertiser divided by the approximate total target audience size. The field will be null if the date range has more than 92 days. This metric only supports the 'CAMPAIGN' pivot. This metric is not returned when using 'MONTHLY' granularity. | |
AverageDwellTime | Long | True | No | Average user dwell time (in seconds). It measures the duration for which more than 50% of the ad's pixels remain visible in the viewport. | |
DocumentCompletions | Long | True | No | The number of times users reached 100% of the document’s length, including those that skipped to this point. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ActiveAudience | Integer | False | No | Active audience count for the given targeting criteria. | |
TotalAudience | Integer | False | No | Total audience count for the given targeting criteria. | |
AgeRange | String | False | Yes | Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647) | |
DegreeId | String | False | Yes | Educational degrees attained to match against those of the member. | |
FieldOfStudyId | String | False | Yes | Fields of study to match against those listed by the member. | |
Gender | String | False | Yes | Genders to match against member. Supported values are: MALE, FEMALE | |
IndustryId | String | False | Yes | Industries to be targeted. | |
JobFunctionId | String | False | Yes | Top level groupings of supertitles to be targeted. | |
LocationId | String | False | Yes | Location to be targeted. | |
ProfileLocationId | String | False | Yes | The values are similar to | |
SeniorityId | String | False | Yes | Seniorities to be targeted. | |
SkillId | String | False | Yes | Skills to match against the member's listed skills. | |
StaffCountRange | String | False | Yes | Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647) | |
TitleId | String | False | Yes | Job titles to match against the member's current title. | |
AudienceMatchingSegmentId | String | False | Yes | An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. | |
RetargetingSegmentId | String | False | Yes | An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. | |
EmployerId | String | False | Yes | Employer ID to match against member's listed companies. | |
CompanyId | String | False | Yes | Company ID to match against member's listed companies. | |
InterfaceLocaleId | String | False | Yes | Locale ID to match against member's preferred locale settings. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
SuggestedBidDefault | String | False | No | The suggested bid | |
SuggestedBidMin | String | False | No | Low end of suggested bid range | |
SuggestedBidMax | String | False | No | High end of suggested bid range | |
DailyBudgetLimitsDefault | String | False | No | Default daily budget | |
DailyBudgetLimitsMin | String | False | No | Minimum daily budget | |
DailyBudgetLimitsMax | String | False | No | Maximum daily budget | |
BidLimitsMax | String | False | No | The maximum bid allowed | |
BidLimitsMin | String | False | No | The minimum bid allowed, also known as the floor price | |
Account | String | False | No | Sponsored account URN. | |
CampaignType | String | False | No | The campaign type. | |
BidType | String | False | No | The bidding type. | |
MatchType | String | False | No | The matching type. | |
AgeRange | String | False | Yes | Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647) | |
DegreeId | String | False | Yes | Educational degrees attained to match against those of the member. | |
FieldOfStudyId | String | False | Yes | Fields of study to match against those listed by the member. | |
Gender | String | False | Yes | Genders to match against member. Supported values are: MALE, FEMALE | |
IndustryId | String | False | Yes | Industries to be targeted. | |
JobFunctionId | String | False | Yes | Top level groupings of supertitles to be targeted. | |
LocationId | String | False | Yes | Location to be targeted. | |
ProfileLocationId | String | False | Yes | The values are similar to | |
SeniorityId | String | False | Yes | Seniorities to be targeted. | |
SkillId | String | False | Yes | Skills to match against the member's listed skills. | |
StaffCountRange | String | False | Yes | Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647) | |
TitleId | String | False | Yes | Job titles to match against the member's current title. | |
AudienceMatchingSegmentId | String | False | Yes | An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. | |
RetargetingSegmentId | String | False | Yes | An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted. | |
EmployerId | String | False | Yes | Employer ID to match against member's listed companies. | |
CompanyId | String | False | Yes | Company ID to match against member's listed companies. | |
InterfaceLocaleId | String | False | Yes | Locale ID to match against member's preferred locale settings. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Numerical identifier for the campaign group | |
Account | String | False | No | URN identifying the advertising account associated with the Campaign Group. This value is immutable once set | |
Name | String | False | No | The name of the Campaign Group. Primarily used to make it easier to reference a Campaign Group and to recall its purpose | |
Status | String | False | No | Current Status of the campaign group | |
TotalBudgetAmount | Decimal | False | No | Maximum amount to spend over the life of the Campaign Group. | |
TotalBudgetCurrencyCode | String | False | No | ISO currency code. The currency code must match that of the parent account. | |
ScheduleStartTime | Datetime | False | No | Represents the inclusive (greater than or equal to) value in which to start the range. | |
ScheduleEndTime | Datetime | False | No | Scheduled date range to run associated objects. | |
Backfilled | Boolean | False | No | Flag that denotes whether the Campaign Group was created organically or was created to backfill existing campaigns. | |
AdAccountId | String | False | No | Id of the account |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Numerical identifier for the campaign | |
Account | String | False | No | URN identifying the advertising account associated with the Campaign. | |
CampaignGroup | String | False | No | Numerical identifier for the campaign group. | |
AssociatedEntity | String | False | No | An URN for a strongly associated object, with semantics varying based on the Campaign type. | |
AudienceExpansionEnabled | Boolean | False | No | Enable Audience Expansion for the campaign provides query expansion for certain targeting criteria | |
CostType | String | False | No | CPM - Cost per thousand advertising impressions. CPC - Cost per individual click on the associated link | |
CreativeSelection | String | False | No | ROUND_ROBIN - Rotate through available creatives to serve them as easily as possible. OPTIMIZED - Bias selection taking into account such things as expected performance | |
DailyBudgetAmount | String | False | No | The amount of money as a real number string | |
DailyBudgetCurrency | String | False | No | ISO currency code | |
Country | String | False | No | An uppercase two-letter country code as defined by ISO-3166. | |
Language | String | False | No | A lowercase two-letter language code as defined by ISO-639. | |
Name | String | False | No | The name of the Campaign | |
OffsiteDeliveryEnabled | Boolean | False | No | Allow this campaign access to be served on the LinkedIn Advertising Network. | |
ScheduleStartTime | Datetime | False | No | Scheduled date range to run associated creatives. | |
ScheduleEndTime | Datetime | False | No | Scheduled date range to run associated creatives. | |
Status | String | False | No | Current Status of the campaign | |
Type | String | False | No | Type of campaign | |
UnitCostAmount | String | False | No | Amount to bid per click, impression, or other event depending on the pricing model. | |
UnitCostCurrency | String | False | No | Currency of the UnitCostAmount | |
ObjectiveType | String | False | No | The Campaign Objective type. | |
AdAccountId | String | False | No | Id of the account | |
ConnectedTelevisionOnly | Boolean | False | No | Flag showing whether this campaign is a Connected Television Only campaign. Allow advertisers to specify when they’re creating a CTV campaign. Not specifying the boolean can be considered false. | |
TimeSpanDuration | Integer | False | No | Represents the length of time. | |
TimeSpanUnit | String | False | No | Represents the unit of the duration of time | |
Frequency | Integer | False | No | The number of times the campaign is shown to a member. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Numerical identifier for the Conversion. | |
Account | String | False | No | URN identifying the advertising account associated with the Conversion. | |
DomainId | String | False | No | The insightTagDomain key that this Conversion resides under. | |
Name | String | False | No | A short name for this rule, which will be shown in the UI and in reports. | |
Created | String | False | No | The timestamp when the Conversion was created. | |
LastModified | String | False | No | The timestamp when the Conversion was last modified. | |
LastCallbackAt | String | False | No | The timestamp of the last callback from the Conversion. | |
Amount | String | False | No | The amount of money as a real number string. | |
CurrencyCode | String | False | No | Identifying code for currency type. See currency codes for the valid codes. | |
Type | String | False | No | The type of the rule. | |
Enabled | String | False | No | Set to true or false to enable or disable this rule from matching on the advertiser's website. | |
ImagePixelTag | String | False | No | The HTML representation of the image pixel. | |
PostClickAttributionWindowSize | Integer | False | No | The HTML representation of the image pixel. | |
ViewThroughAttributionWindowSize | Integer | False | No | The HTML representation of the image pixel. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Numerical identifier for the creative. | |
Account | String | False | No | URN identifying the advertising account associated with the creative. | |
Campaign | String | False | No | URN identifying the campaign associated with the creative. | |
Content | String | False | No | Content sponsored in the creative. | |
CreatedAt | Datetime | False | No | Datetime when the creative was first created | |
CreatedBy | String | False | No | Entity that developed the creative. | |
IntendedStatus | String | False | No | Creative user intended status. | |
IsServing | Boolean | False | No | This indicates whether the creative is currently being served or not. | |
ServingHoldReasons | String | False | No | Array that contains all the reasons why the creative is not serving. | |
LastModifiedAt | Datetime | False | No | Datetime when the creative was last modified. | |
LastModifiedBy | String | False | No | Entity that modified the creative. | |
ReviewStatus | String | False | No | The current review status of the creative. | |
IsTest | Boolean | False | No | Flag showing whether this creative is a test creative, i.e., belongs to a test campaign. | |
AdAccountId | String | False | No | Id of the account | |
CallToActionLabel | String | False | No | Label for the CallToAction button. Present only if the campaign objective is LEAD_GENERATION. | |
CallToActionFormId | String | False | Forms.Id | No | The Id of the corresponding form which the call to action redirects to. Present only if the campaign objective is LEAD_GENERATION. |
RejectionReasons | String | False | No | A comma-seperated list of values with reasons explaining why the creative has been rejected. | |
Name | String | False | No | The name of the creative that can be set by advertiser; primarily used to make it easier to reference a Creative and to recall its purpose. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Degree id | |
URN | String | False | No | Standardized degree URN | |
Name | String | False | No | Degree name in various locales. Represented as MultiLocaleString type. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Field of study id | |
URN | String | False | No | Standardized field of study URN | |
Name | String | False | No | Field of study name in various locales. Represented as MultiLocaleString type. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Identifier for the form. | |
Account | String | True | Accounts.Id | No | Identifier for the owner of the form. This is the advertiser account. |
Created | Timestamp | True | No | Timestamp for creation of the form. | |
LastModified | Timestamp | True | No | Timestamp for last modification of the form. | |
Description | String | True | No | Description of the form, visible to both the owner and the viewer. | |
Headline | String | True | No | Headline of the form, visible to both the owner and the viewer. | |
LandingPage | String | True | No | The landing page URL after the viewer clicks on submit. | |
LegalDisclaimer | String | True | No | Advertiser's legal disclaimer to accompany this form. | |
Name | String | True | No | Name of the form, visible to the owner of the form but not visible to the viewer. | |
PrivacyPolicy | String | True | No | The URL of the privacy policy that covers any data passed to the owner of the form. | |
Country | String | True | No | A lowercase two-letter language code as defined by ISO-639-1 | |
Language | String | True | No | An uppercase two-letter country code as defined by ISO-3166. | |
ReviewStatus | String | True | No | The status of the review of the form. | |
ReviewedAt | Timestamp | True | No | Timestamp for when the form's review status was initiated/last updated. | |
Status | String | True | No | Indicates the state of review for the Lead Form. Can be one of the following: DRAFT, SUBMITTED, PAUSED, ARCHIVED, or CANCELED. | |
VersionTag | String | True | No | The number of times the form has been modified. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | Identifier for the location. | |
Name | String | False | No | The name of the location. | |
LocaleCountry | String | False | No | An uppercase two-letter country code as defined by ISO-3166. | |
LocaleLanguage | String | False | No | A lowercase two-letter language code as defined by ISO-639. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Industry id | |
URN | String | False | No | Standardized industry URN | |
Name | String | False | No | Industry name in various locales. Represented as MultiLocaleString type. | |
ChildrenIndustries | String | False | No | The URNs of the children industries associated with this node. | |
ParentIndustries | String | False | No | The URNs of the parent industry associated with this node. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Job function id | |
URN | String | False | No | Standardized Job function URN | |
Name | String | False | No | Job function name in various locales. Represented as MultiLocaleString type. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | Id of the post. | |
Author | String | False | No | Author of the post. | |
Commentary | String | False | No | The user generated commentary for the post. | |
Content | String | False | No | The posted content. | |
CreatedAt | Datetime | False | No | Datetime when the post was created. | |
IsReshareDisabledByAuthor | Boolean | False | No | Indicates whether resharing of the post has been disabled by the author. | |
LastModifiedAt | Datetime | False | No | Datetime when the post was lastly modified. | |
LifecycleState | String | False | No | Lifecycle state of the post. | |
PublishedAt | Datetime | False | No | Datetime at which the content was published. | |
Visibility | String | False | No | Visibility restrictions on content. | |
OrganizationId | String | False | No | Id of the organization who created the post. | |
ContentLandingPage | String | False | No | Web page that is opened when the member clicks on the associated content. | |
IsDirectSponsoredContent | Boolean | False | No | Whether or not this post is Direct Sponsored Content. | |
DirectSponsoredContentAdAccount | String | False | No | The Ad Account that created the Direct Sponsored Content. | |
DirectSponsoredContentAdType | String | False | No | The type of Direct Sponsored Content. | |
DirectSponsoredContentName | String | False | No | Plain text name of the Direct Sponsored Content post. | |
DirectSponsoredContentStatus | String | False | No | The status of the advertising company content. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Seniority id | |
URN | String | False | No | Standardized Seniority URN | |
Name | String | False | No | Seniority name in various locales. Represented as MultiLocaleString type. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | skill id | |
Name | String | False | No | skill name in various locales. Represented as MultiLocaleString type. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TotalFirstLevelComments | Integer | False | No | Total number of first level comments. | |
AggregatedTotalComments | Integer | False | No | Total number of aggregated comments. | |
LikedByCurrentUser | Boolean | False | No | Indicator if the post is liked by current user. | |
TotalLikes | Integer | False | No | Total number of likes. | |
Target | String | False | No | Total number of likes. | |
UGCPostId | String | False | Posts.Id | No | Id of UGC Post. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | The campaign to which this recommendation belongs. | |
Creative | String | False | No | The campaign to which this recommendation belongs. | |
Account | String | False | No | The average spend of the entity. | |
Event | String | False | No | The currency code of the average spend. | |
Platform | String | False | No | A prediction of how much additional impressions could be generated from a different bid. | |
TrackingUrl | String | False | No | The currency code of additional impressions. | |
Created | Timestamp | False | No | A prediction of how much additional impressions could be generated from a different bid. | |
LastModified | Timestamp | False | No | Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | Titles id | |
URN | String | False | No | Standardized Titles URN | |
Name | String | False | No | Titles name in various locales. Represented as MultiLocaleString type. |