OBJECT

DropCampaign

A campaign a developer is running to give drops away to viewers of their game To be considered live, a campaign must be enabled with the current time being after the start but before the end times To apply to a particular channel a campaign must be live and additionally the channel must be playing an applicable game and either must be one of the applicable channels or the campaign must have an empty applicable channel list (where an empty list specifically means all channels are eligible).

GraphQL Schema definition

1 type DropCampaign {
2 
3 #   The URL users who aren't linked should click on to create a link that will
4 #   allow them create an account link for the developer of the game(s)
5 #   this campaign is for.
6 accountLinkURL: String! 
7 
8 #   The only channels allowed to be eligible for the drop campaign.
9 allow: DropCampaignACL 
10 
11 #   If isAvailableToAllChannels is false, applicableChannels is the list of
12 #   what channels this campaign is targeted to.  If the flag is true but the
13 #   list is empty, that means that all whitelisted users cannot be loaded.
14 #   An applicable channel must also be playing an applicable game for the
15 #   campaign to apply to the channel.
16 applicableChannels: [User!] @deprecated( reason: "No longer supported"  )
17 
18 #   The games that this campaign is enabled on
19 #   A channel playing one of these games must be in the applicable channels
20 #   list or list must be empty for the campaign to apply to the channel.
21 applicableGames: [Game!] @deprecated( reason: "No longer supported"  )
22 
23 #   The drops this campaign can award.
24 awardableDrops: [Drop!] @deprecated( reason: "No longer supported"  )
25 
26 #   The channels blocked from being eligible for the drop campaign.
27 block: DropCampaignACL 
28 
29 #   The URL users who aren't linked should click on to create a link that will
30 #   allow them create an account link for the developer of the game(s)
31 #   this campaign is for.
32 connectionURL: String! @deprecated( reason: "Use accountLinkURL instead"  )
33 
34 #   The description contains the full details about the campaign.
35 description: String! 
36 
37 #   The URL that links to the details / marketing page for this campaign.
38 detailsURL: String! 
39 
40 #   The time this campaign ends
41 #   To be considered live, a campaign must be enabled with the current time
42 #   being after the start but before the end times.
43 endAt: Time! 
44 
45 #   Drops triggered by in-game events.
46 eventBasedDrops: [EventBasedDrop!] 
47 
48 #   The Game associated with this campaign.
49 game: Game 
50 
51 #   GUID identifying this campaign.
52 id: ID! 
53 
54 #   An image asset for this campaign no larger than 160 x 160 pixels.
55 imageURL: String! 
56 
57 #   Indicates if this campaign is available to all channels or if only some.
58 #   If false, applicableChannels should contain the channels where the campaign
59 #   is available.
60 isAvailableToAllChannels: Boolean! @deprecated( reason: "No longer supported"  )
61 
62 #   If this campaign is enabled
63 #   To be considered live, a campaign must be enabled with the current time
64 #   being after the start but before the end times.
65 isEnabled: Boolean! @deprecated( reason: "No longer supported"  )
66 
67 #   Drops that can be triggered by manual events.
68 manualTriggerBasedDrops: [ManualTriggerBasedDrop!] 
69 
70 #   The name of the campaign.
71 name: String! 
72 
73 #   This is the Organization (RBAC) that has ownership of the campaign and attached 
74 #   drops.
75 owner: Organization 
76 
77 #   User specific data for the campaign.
78 self: DropCampaignSelfEdge! 
79 
80 #   The time this campaign starts
81 #   To be considered live, a campaign must be enabled with the current time
82 #   being after the start but before the end times.
83 startAt: Time! 
84 
85 #   The current status of the campaign.
86 status: DropCampaignStatus! 
87 
88 #   Test viewers can participate in campaigns while the campaign is in the test 
89 #   status.
90 testViewers: [User!] 
91 
92 #   Drops triggered by accumulating minutes watched on a game.
93 timeBasedDrops: [TimeBasedDrop!] 
94 
95 #   The type of a campaign defines what type of drops are allowed to be added to the 
96 #   campaign.
97 type: CampaignType! 
98 
99 }

1	type DropCampaign {
2
3	# The URL users who aren't linked should click on to create a link that will
4	# allow them create an account link for the developer of the game(s)
5	# this campaign is for.
6	accountLinkURL: String!
7
8	# The only channels allowed to be eligible for the drop campaign.
9	allow: DropCampaignACL
10
11	# If isAvailableToAllChannels is false, applicableChannels is the list of
12	# what channels this campaign is targeted to. If the flag is true but the
13	# list is empty, that means that all whitelisted users cannot be loaded.
14	# An applicable channel must also be playing an applicable game for the
15	# campaign to apply to the channel.
16	applicableChannels: [User!] @deprecated( reason: "No longer supported" )
17
18	# The games that this campaign is enabled on
19	# A channel playing one of these games must be in the applicable channels
20	# list or list must be empty for the campaign to apply to the channel.
21	applicableGames: [Game!] @deprecated( reason: "No longer supported" )
22
23	# The drops this campaign can award.
24	awardableDrops: [Drop!] @deprecated( reason: "No longer supported" )
25
26	# The channels blocked from being eligible for the drop campaign.
27	block: DropCampaignACL
28
29	# The URL users who aren't linked should click on to create a link that will
30	# allow them create an account link for the developer of the game(s)
31	# this campaign is for.
32	connectionURL: String! @deprecated( reason: "Use accountLinkURL instead" )
33
34	# The description contains the full details about the campaign.
35	description: String!
36
37	# The URL that links to the details / marketing page for this campaign.
38	detailsURL: String!
39
40	# The time this campaign ends
41	# To be considered live, a campaign must be enabled with the current time
42	# being after the start but before the end times.
43	endAt: Time!
44
45	# Drops triggered by in-game events.
46	eventBasedDrops: [EventBasedDrop!]
47
48	# The Game associated with this campaign.
49	game: Game
50
51	# GUID identifying this campaign.
52	id: ID!
53
54	# An image asset for this campaign no larger than 160 x 160 pixels.
55	imageURL: String!
56
57	# Indicates if this campaign is available to all channels or if only some.
58	# If false, applicableChannels should contain the channels where the campaign
59	# is available.
60	isAvailableToAllChannels: Boolean! @deprecated( reason: "No longer supported" )
61
62	# If this campaign is enabled
63	# To be considered live, a campaign must be enabled with the current time
64	# being after the start but before the end times.
65	isEnabled: Boolean! @deprecated( reason: "No longer supported" )
66
67	# Drops that can be triggered by manual events.
68	manualTriggerBasedDrops: [ManualTriggerBasedDrop!]
69
70	# The name of the campaign.
71	name: String!
72
73	# This is the Organization (RBAC) that has ownership of the campaign and attached
74	# drops.
75	owner: Organization
76
77	# User specific data for the campaign.
78	self: DropCampaignSelfEdge!
79
80	# The time this campaign starts
81	# To be considered live, a campaign must be enabled with the current time
82	# being after the start but before the end times.
83	startAt: Time!
84
85	# The current status of the campaign.
86	status: DropCampaignStatus!
87
88	# Test viewers can participate in campaigns while the campaign is in the test
89	# status.
90	testViewers: [User!]
91
92	# Drops triggered by accumulating minutes watched on a game.
93	timeBasedDrops: [TimeBasedDrop!]
94
95	# The type of a campaign defines what type of drops are allowed to be added to the
96	# campaign.
97	type: CampaignType!
98
99	}

DropCampaign

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by