6.0.0 • Published 5 years ago

@datafire/google_dfareporting v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/google_dfareporting

Client library for Campaign Manager 360 API

Installation and Usage

npm install --save @datafire/google_dfareporting
let google_dfareporting = require('@datafire/google_dfareporting').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Manage your DoubleClick Campaign Manager ad campaigns and reports.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_dfareporting.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_dfareporting.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

dfareporting.files.get

Retrieves a report file by its report ID and file ID. This method supports media download.

google_dfareporting.dfareporting.files.get({
  "reportId": "",
  "fileId": ""
}, context)

Input

  • input object
    • reportId required string: The ID of the report.
    • fileId required string: The ID of the report file.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.userProfiles.list

Retrieves list of user profiles for a user.

google_dfareporting.dfareporting.userProfiles.list({}, context)

Input

  • input object
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.userProfiles.get

Gets one user profile by ID.

google_dfareporting.dfareporting.userProfiles.get({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: The user profile ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountActiveAdSummaries.get

Gets the account's active ad summary by account ID.

google_dfareporting.dfareporting.accountActiveAdSummaries.get({
  "profileId": "",
  "summaryAccountId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • summaryAccountId required string: Account ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountPermissionGroups.list

Retrieves the list of account permission groups.

google_dfareporting.dfareporting.accountPermissionGroups.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountPermissionGroups.get

Gets one account permission group by ID.

google_dfareporting.dfareporting.accountPermissionGroups.get({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Account permission group ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountPermissions.list

Retrieves the list of account permissions.

google_dfareporting.dfareporting.accountPermissions.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountPermissions.get

Gets one account permission by ID.

google_dfareporting.dfareporting.accountPermissions.get({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Account permission ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountUserProfiles.list

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

google_dfareporting.dfareporting.accountUserProfiles.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • active boolean: Select only active user profiles.
    • ids array: Select only user profiles 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, ID or email. Wildcards () are allowed. For example, "user profile2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
    • sortField string (values: ID, NAME): Field by which to sort the list.
    • sortOrder string (values: ASCENDING, DESCENDING): Order of sorted results.
    • subaccountId string: Select only user profiles with the specified subaccount ID.
    • userRoleId string: Select only user profiles with the specified user role ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountUserProfiles.patch

Updates an existing account user profile. This method supports patch semantics.

google_dfareporting.dfareporting.accountUserProfiles.patch({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: AccountUserProfile ID.
    • body AccountUserProfile
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountUserProfiles.insert

Inserts a new account user profile.

google_dfareporting.dfareporting.accountUserProfiles.insert({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body AccountUserProfile
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountUserProfiles.update

Updates an existing account user profile.

google_dfareporting.dfareporting.accountUserProfiles.update({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body AccountUserProfile
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accountUserProfiles.get

Gets one account user profile by ID.

google_dfareporting.dfareporting.accountUserProfiles.get({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: User profile ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accounts.list

Retrieves the list of accounts, possibly filtered. This method supports paging.

google_dfareporting.dfareporting.accounts.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • active boolean: Select only active accounts. Don't set this field to select both active and non-active accounts.
    • ids array: Select only accounts 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, "account2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
    • sortField string (values: ID, NAME): Field by which to sort the list.
    • sortOrder string (values: ASCENDING, DESCENDING): Order of sorted results.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accounts.patch

Updates an existing account. This method supports patch semantics.

google_dfareporting.dfareporting.accounts.patch({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Account ID.
    • body Account
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accounts.update

Updates an existing account.

google_dfareporting.dfareporting.accounts.update({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body Account
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.accounts.get

Gets one account by ID.

google_dfareporting.dfareporting.accounts.get({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Account ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.ads.list

Retrieves a list of ads, possibly filtered. This method supports paging.

google_dfareporting.dfareporting.ads.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • active boolean: Select only active ads.
    • advertiserId string: Select only ads with this advertiser ID.
    • archived boolean: Select only archived ads.
    • audienceSegmentIds array: Select only ads with these audience segment IDs.
    • campaignIds array: Select only ads with these campaign IDs.
    • compatibility string (values: DISPLAY, DISPLAY_INTERSTITIAL, APP, APP_INTERSTITIAL, IN_STREAM_VIDEO, IN_STREAM_AUDIO): Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
    • creativeIds array: Select only ads with these creative IDs assigned.
    • creativeOptimizationConfigurationIds array: Select only ads with these creative optimization configuration IDs.
    • dynamicClickTracker boolean: Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
    • ids array: Select only ads with these IDs.
    • landingPageIds array: Select only ads with these landing page IDs.
    • maxResults integer: Maximum number of results to return.
    • overriddenEventTagId string: Select only ads with this event tag override ID.
    • pageToken string: Value of the nextPageToken from the previous result page.
    • placementIds array: Select only ads with these placement IDs assigned.
    • remarketingListIds array: Select only ads whose list targeting expression use these remarketing list IDs.
    • searchString string: Allows searching for objects by name or ID. Wildcards () are allowed. For example, "ad2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
    • sizeIds array: Select only ads with these size IDs.
    • sortField string (values: ID, NAME): Field by which to sort the list.
    • sortOrder string (values: ASCENDING, DESCENDING): Order of sorted results.
    • sslCompliant boolean: Select only ads that are SSL-compliant.
    • sslRequired boolean: Select only ads that require SSL.
    • type array: Select only ads with these types.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.ads.patch

Updates an existing ad. This method supports patch semantics.

google_dfareporting.dfareporting.ads.patch({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Ad ID.
    • body Ad
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.ads.insert

Inserts a new ad.

google_dfareporting.dfareporting.ads.insert({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body Ad
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.ads.update

Updates an existing ad.

google_dfareporting.dfareporting.ads.update({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body Ad
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.ads.get

Gets one ad by ID.

google_dfareporting.dfareporting.ads.get({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Ad ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserGroups.list

Retrieves a list of advertiser groups, possibly filtered. This method supports paging.

google_dfareporting.dfareporting.advertiserGroups.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • ids array: Select only advertiser groups 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, "advertiser2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
    • sortField string (values: ID, NAME): Field by which to sort the list.
    • sortOrder string (values: ASCENDING, DESCENDING): Order of sorted results.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserGroups.patch

Updates an existing advertiser group. This method supports patch semantics.

google_dfareporting.dfareporting.advertiserGroups.patch({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: AdvertiserGroup ID.
    • body AdvertiserGroup
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserGroups.insert

Inserts a new advertiser group.

google_dfareporting.dfareporting.advertiserGroups.insert({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body AdvertiserGroup
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserGroups.update

Updates an existing advertiser group.

google_dfareporting.dfareporting.advertiserGroups.update({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body AdvertiserGroup
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserGroups.delete

Deletes an existing advertiser group.

google_dfareporting.dfareporting.advertiserGroups.delete({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Advertiser group ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

Output schema unknown

dfareporting.advertiserGroups.get

Gets one advertiser group by ID.

google_dfareporting.dfareporting.advertiserGroups.get({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Advertiser group ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserLandingPages.list

Retrieves a list of landing pages.

google_dfareporting.dfareporting.advertiserLandingPages.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • advertiserIds array: Select only landing pages that belong to these advertisers.
    • archived boolean: Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
    • campaignIds array: Select only landing pages that are associated with these campaigns.
    • ids array: Select only landing pages 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 landing pages by name or ID. Wildcards () are allowed. For example, "landingpage2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".
    • sortField string (values: ID, NAME): Field by which to sort the list.
    • sortOrder string (values: ASCENDING, DESCENDING): Order of sorted results.
    • subaccountId string: Select only landing pages that belong to this subaccount.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserLandingPages.patch

Updates an existing advertiser landing page. This method supports patch semantics.

google_dfareporting.dfareporting.advertiserLandingPages.patch({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: LandingPage ID.
    • body LandingPage
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserLandingPages.insert

Inserts a new landing page.

google_dfareporting.dfareporting.advertiserLandingPages.insert({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body LandingPage
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserLandingPages.update

Updates an existing landing page.

google_dfareporting.dfareporting.advertiserLandingPages.update({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body LandingPage
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertiserLandingPages.get

Gets one landing page by ID.

google_dfareporting.dfareporting.advertiserLandingPages.get({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Landing page ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertisers.list

Retrieves a list of advertisers, possibly filtered. This method supports paging.

google_dfareporting.dfareporting.advertisers.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • advertiserGroupIds array: Select only advertisers with these advertiser group IDs.
    • floodlightConfigurationIds array: Select only advertisers with these floodlight configuration IDs.
    • ids array: Select only advertisers with these IDs.
    • includeAdvertisersWithoutGroupsOnly boolean: Select only advertisers which do not belong to any advertiser group.
    • maxResults integer: Maximum number of results to return.
    • onlyParent boolean: Select only advertisers which use another advertiser's floodlight configuration.
    • 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, "advertiser2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" .
    • sortField string (values: ID, NAME): Field by which to sort the list.
    • sortOrder string (values: ASCENDING, DESCENDING): Order of sorted results.
    • status string (values: APPROVED, ON_HOLD): Select only advertisers with the specified status.
    • subaccountId string: Select only advertisers with these subaccount IDs.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertisers.patch

Updates an existing advertiser. This method supports patch semantics.

google_dfareporting.dfareporting.advertisers.patch({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Advertiser ID.
    • body Advertiser
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertisers.insert

Inserts a new advertiser.

google_dfareporting.dfareporting.advertisers.insert({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body Advertiser
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertisers.update

Updates an existing advertiser.

google_dfareporting.dfareporting.advertisers.update({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • body Advertiser
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.advertisers.get

Gets one advertiser by ID.

google_dfareporting.dfareporting.advertisers.get({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Advertiser ID.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.browsers.list

Retrieves a list of browsers.

google_dfareporting.dfareporting.browsers.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.campaigns.list

Retrieves a list of campaigns, possibly filtered. This method supports paging.

google_dfareporting.dfareporting.campaigns.list({
  "profileId": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • advertiserGroupIds array: Select only campaigns whose advertisers belong to these advertiser groups.
    • advertiserIds array: Select only campaigns that belong to these advertisers.
    • archived boolean: Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
    • atLeastOneOptimizationActivity boolean: Select only campaigns that have at least one optimization activity.
    • excludedIds array: Exclude campaigns with these IDs.
    • ids array: Select only campaigns with these IDs.
    • maxResults integer: Maximum number of results to return.
    • overriddenEventTagId string: Select only campaigns that have overridden this event tag ID.
    • pageToken string: Value of the nextPageToken from the previous result page.
    • searchString string: Allows searching for campaigns by name or ID. Wildcards () are allowed. For example, "campaign2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
    • sortField string (values: ID, NAME): Field by which to sort the list.
    • sortOrder string (values: ASCENDING, DESCENDING): Order of sorted results.
    • subaccountId string: Select only campaigns that belong to this subaccount.
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
    • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

dfareporting.campaigns.patch

Updates an existing campaign. This method supports patch semantics.

google_dfareporting.dfareporting.campaigns.patch({
  "profileId": "",
  "id": ""
}, context)

Input

  • input object
    • profileId required string: User profile ID associated with this request.
    • id required string: Campaign ID.
    • body Campaign
    • $.xgafv string (values: 1, 2): V1 error format.
    • access_token string: OAuth access token.
    • alt string (values: json, media, proto): Data format for response.
    • callback string: JSONP
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol string: Upload protocol for media (e.g.
datafire
@infinitebrahmanuniverse/nolb-_datafire_g@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_g
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago