List
|
|||||
|
|
||||
Retrieves list of available mobile apps
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 6 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
directories |
ENUMERATION |
Select only apps from these directories |
ids |
STRING |
Select only apps with these IDs |
maxResults |
INTEGER |
Maximum number of results to return |
pageToken |
STRING |
Value of the nextPageToken from the previous result page |
searchString |
STRING |
Allows searching for objects by name or ID. Wildcards () are allowed. For example, "app2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app" |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
directories ENUMERATION Select only apps from these directories |
|
ids STRING Select only apps with these IDs |
|
maxResults INTEGER Maximum number of results to return |
|
pageToken STRING Value of the nextPageToken from the previous result page |
|
searchString STRING Allows searching for objects by name or ID. Wildcards () are allowed. For example, "app2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app" |
Output
This building block provides 8 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse" |
mobileApps[] |
OBJECT |
Contains information about a mobile app. Used as a landing page deep link |
mobileApps[].directory |
ENUMERATION |
Mobile app directory |
mobileApps[].id |
STRING |
ID of this mobile app |
mobileApps[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp" |
mobileApps[].publisherName |
STRING |
Publisher name |
mobileApps[].title |
STRING |
Title of this mobile app |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileAppsListResponse" |
|
mobileApps[] OBJECT Contains information about a mobile app. Used as a landing page deep link |
|
mobileApps[].directory ENUMERATION Mobile app directory |
|
mobileApps[].id STRING ID of this mobile app |
|
mobileApps[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#mobileApp" |
|
mobileApps[].publisherName STRING Publisher name |
|
mobileApps[].title STRING Title of this mobile app |
|
nextPageToken STRING Pagination token to be used for the next list operation |