OBJECT

BountyCampaign

A campaign defines the requirements and parameters for a set of bounties.

GraphQL Schema definition

1 type BountyCampaign {
2 
3 #   The list of games that if isAllowAllGames is false, the bounty must use.
4 allowedGames: [Game!] 
5 
6 #   The platforms on which users can play this campaign's game (ie. PC, PS4, 
7 #   Switch).
8 availablePlatforms: [String!] 
9 
10 #   The length of this campaign's bounties (in days).
11 bountyLengthDays: Int! 
12 
13 #   Override Box Art URL only for campaign shown on Bounty Board Dashboard, 
14 #   unrelated to game.
15 boxArtURL: String 
16 
17 #   Details about the campaign that only the sponsoring brand should see.
18 brandDetails: BountyCampaignBrandDetails 
19 
20 #   Override Cover URL only for campaign shown on Bounty Board Dashboard, unrelated 
21 #   to game.
22 coverURL: String 
23 
24 #   Details for this campaign.
25 details: String! 
26 
27 #   Override Display name only for campaign shown on Bounty Board Dashboard, 
28 #   unrelated to game.
29 displayName: String 
30 
31 #   When the campaign expires.
32 endAt: Time! @deprecated( reason: "Replacing with 'endTime' as that is a more descriptive property name for the value."  )
33 
34 #   When the campaign expires.
35 endTime: Time! 
36 
37 #   The game identifier that is related to this campaign.
38 game: Game @deprecated( reason: "Replacing with 'allowedGames' as this provides a set of available games instead of a single game"  )
39 
40 #   The campaign's unique identifier.
41 id: ID! 
42 
43 #   If the campaing is a promotional campaign.
44 isPromotionEligible: Boolean 
45 
46 #   The information about keys for the campaigns.
47 keyDescriptors: [BountyCampaignKeyDescriptor!] 
48 
49 #   Why the campaign was rejected.
50 rejectionReason: String @deprecated( reason: "Use 'rejectionReason' in 'brandDetails' instead."  )
51 
52 #   If a campaign allows any game to be played.
53 shouldAllowAllGames: Boolean 
54 
55 #   The sponsor that is funding this campaign (ie. Amazon Game Studios).
56 sponsor: String! 
57 
58 #   When the campaign starts.
59 startAt: Time! @deprecated( reason: "Replacing with 'startTime' as that is a more descriptive property name for the value."  )
60 
61 #   When the campaign starts.
62 startTime: Time! 
63 
64 #   The status of the campaign.
65 status: BountyCampaignStatus @deprecated( reason: "Use 'status' in 'brandDetails' instead."  )
66 
67 #   How many seconds a bounty for this campaign must be streamed to complete the 
68 #   bounty.
69 streamLengthSeconds: Int 
70 
71 #   The click target of the campaign if it is a promotional campaign.
72 targetPromotionalVideoClicks: Int 
73 
74 #   The URL for the terms and conditions page.
75 termsAndConditionsURL: String 
76 
77 #   The title of the campaign (ie. Stream Breakaway for 1 hour).
78 title: String! 
79 
80 #   The tracking URLs for this campaign.
81 trackingPixels: [TrackingPixel!] 
82 
83 #   The type of the campaign (ie. PAY_TO_STREAM).
84 type: BountyCampaignType! 
85 
86 #   The URL of the video for this campaign.
87 videoURL: String @deprecated( reason: "Use 'videos' instead."  )
88 
89 #   The video URLS for the campaign.
90 videos: [BountyCampaignVideo!] 
91 
92 }

1	type BountyCampaign {
2
3	# The list of games that if isAllowAllGames is false, the bounty must use.
4	allowedGames: [Game!]
5
6	# The platforms on which users can play this campaign's game (ie. PC, PS4,
7	# Switch).
8	availablePlatforms: [String!]
9
10	# The length of this campaign's bounties (in days).
11	bountyLengthDays: Int!
12
13	# Override Box Art URL only for campaign shown on Bounty Board Dashboard,
14	# unrelated to game.
15	boxArtURL: String
16
17	# Details about the campaign that only the sponsoring brand should see.
18	brandDetails: BountyCampaignBrandDetails
19
20	# Override Cover URL only for campaign shown on Bounty Board Dashboard, unrelated
21	# to game.
22	coverURL: String
23
24	# Details for this campaign.
25	details: String!
26
27	# Override Display name only for campaign shown on Bounty Board Dashboard,
28	# unrelated to game.
29	displayName: String
30
31	# When the campaign expires.
32	endAt: Time! @deprecated( reason: "Replacing with 'endTime' as that is a more descriptive property name for the value." )
33
34	# When the campaign expires.
35	endTime: Time!
36
37	# The game identifier that is related to this campaign.
38	game: Game @deprecated( reason: "Replacing with 'allowedGames' as this provides a set of available games instead of a single game" )
39
40	# The campaign's unique identifier.
41	id: ID!
42
43	# If the campaing is a promotional campaign.
44	isPromotionEligible: Boolean
45
46	# The information about keys for the campaigns.
47	keyDescriptors: [BountyCampaignKeyDescriptor!]
48
49	# Why the campaign was rejected.
50	rejectionReason: String @deprecated( reason: "Use 'rejectionReason' in 'brandDetails' instead." )
51
52	# If a campaign allows any game to be played.
53	shouldAllowAllGames: Boolean
54
55	# The sponsor that is funding this campaign (ie. Amazon Game Studios).
56	sponsor: String!
57
58	# When the campaign starts.
59	startAt: Time! @deprecated( reason: "Replacing with 'startTime' as that is a more descriptive property name for the value." )
60
61	# When the campaign starts.
62	startTime: Time!
63
64	# The status of the campaign.
65	status: BountyCampaignStatus @deprecated( reason: "Use 'status' in 'brandDetails' instead." )
66
67	# How many seconds a bounty for this campaign must be streamed to complete the
68	# bounty.
69	streamLengthSeconds: Int
70
71	# The click target of the campaign if it is a promotional campaign.
72	targetPromotionalVideoClicks: Int
73
74	# The URL for the terms and conditions page.
75	termsAndConditionsURL: String
76
77	# The title of the campaign (ie. Stream Breakaway for 1 hour).
78	title: String!
79
80	# The tracking URLs for this campaign.
81	trackingPixels: [TrackingPixel!]
82
83	# The type of the campaign (ie. PAY_TO_STREAM).
84	type: BountyCampaignType!
85
86	# The URL of the video for this campaign.
87	videoURL: String @deprecated( reason: "Use 'videos' instead." )
88
89	# The video URLS for the campaign.
90	videos: [BountyCampaignVideo!]
91
92	}

BountyCampaign

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by