- get(id)
Gets one account by ID.
-
- list()
Retrieves the authenticated user's list of accounts.
- -Updates an existing account. This method supports patch semantics.
- -Updates an existing account.
-get(id)
- Gets one account by ID.
-
-Args:
- id: integer, The account id (required)
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-list()
- Retrieves the authenticated user's list of accounts.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.
- "items": [ # A list of accounts.
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- },
- ],
- "kind": "adexchangebuyer#accountsList", # Resource type.
- }
-patch(id, body)
- Updates an existing account. This method supports patch semantics.
-
-Args:
- id: integer, The account id (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-update(id, body)
- Updates an existing account.
-
-Args:
- id: integer, The account id (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
-
-Returns:
- An object of the form:
-
- { # Configuration data for an Ad Exchange buyer account.
- "kind": "adexchangebuyer#account", # Resource type.
- "maximumTotalQps": 42, # The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.
- "bidderLocation": [ # Your bidder locations that have distinct URLs.
- {
- "url": "A String", # The URL to which the Ad Exchange will send bid requests.
- "maximumQps": 42, # The maximum queries per second the Ad Exchange will send.
- },
- ],
- "cookieMatchingNid": "A String", # The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.
- "id": 42, # Account id.
- "cookieMatchingUrl": "A String", # The base URL used in cookie match requests.
- }
-
- get(accountId, buyerCreativeId, adgroupId)
Gets the status for a single creative.
- -Submit a new creative.
-
- list(pageToken=None, maxResults=None)
Retrieves a list of the authenticated user's active creatives.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-get(accountId, buyerCreativeId, adgroupId)
- Gets the status for a single creative.
-
-Args:
- accountId: integer, The id for the account that will serve this creative. (required)
- buyerCreativeId: string, The buyer-specific id for this creative. (required)
- adgroupId: string, The adgroup this creative belongs to. (required)
-
-Returns:
- An object of the form:
-
- { # A creative and its classification data.
- "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
- "width": 42, # Ad width.
- "attribute": [ # All attributes for the ads that may be shown from this snippet.
- 42,
- ],
- "kind": "adexchangebuyer#creative", # Resource type.
- "height": 42, # Ad height.
- "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
- "A String",
- ],
- "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
- "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
- "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
- "clickThroughUrl": [ # The set of destination urls for the snippet.
- "A String",
- ],
- "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
- 42,
- ],
- "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
- "A String",
- ],
- "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "accountId": 42, # Account id.
- }
-insert(body)
- Submit a new creative.
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # A creative and its classification data.
- "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
- "width": 42, # Ad width.
- "attribute": [ # All attributes for the ads that may be shown from this snippet.
- 42,
- ],
- "kind": "adexchangebuyer#creative", # Resource type.
- "height": 42, # Ad height.
- "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
- "A String",
- ],
- "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
- "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
- "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
- "clickThroughUrl": [ # The set of destination urls for the snippet.
- "A String",
- ],
- "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
- 42,
- ],
- "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
- "A String",
- ],
- "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "accountId": 42, # Account id.
- }
-
-
-Returns:
- An object of the form:
-
- { # A creative and its classification data.
- "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
- "width": 42, # Ad width.
- "attribute": [ # All attributes for the ads that may be shown from this snippet.
- 42,
- ],
- "kind": "adexchangebuyer#creative", # Resource type.
- "height": 42, # Ad height.
- "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
- "A String",
- ],
- "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
- "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
- "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
- "clickThroughUrl": [ # The set of destination urls for the snippet.
- "A String",
- ],
- "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
- 42,
- ],
- "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
- "A String",
- ],
- "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "accountId": 42, # Account id.
- }
-list(pageToken=None, maxResults=None)
- Retrieves a list of the authenticated user's active creatives.
-
-Args:
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
- maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
-
-Returns:
- An object of the form:
-
- { # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
- "nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # A list of creatives.
- { # A creative and its classification data.
- "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "advertiserName": "A String", # The name of the company being advertised in the creative.
- "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
- "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
- "width": 42, # Ad width.
- "attribute": [ # All attributes for the ads that may be shown from this snippet.
- 42,
- ],
- "kind": "adexchangebuyer#creative", # Resource type.
- "height": 42, # Ad height.
- "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
- "A String",
- ],
- "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
- "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
- "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
- "clickThroughUrl": [ # The set of destination urls for the snippet.
- "A String",
- ],
- "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
- 42,
- ],
- "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
- "A String",
- ],
- "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
- 42,
- ],
- "accountId": 42, # Account id.
- },
- ],
- "kind": "adexchangebuyer#creativesList", # Resource type.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- get(id)
Gets one direct deal by ID.
-
- list()
Retrieves the authenticated user's list of direct deals.
-get(id)
- Gets one direct deal by ID.
-
-Args:
- id: string, The direct deal id (required)
-
-Returns:
- An object of the form:
-
- { # The configuration data for an Ad Exchange direct deal.
- "advertiser": "A String", # The name of the advertiser this deal is for.
- "kind": "adexchangebuyer#directDeal", # Resource type.
- "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
- "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.
- "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
- "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
- "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
- "id": "A String", # Deal id.
- "accountId": 42, # The account id of the buyer this deal is for.
- }
-list()
- Retrieves the authenticated user's list of direct deals.
-
-Args:
-
-Returns:
- An object of the form:
-
- { # A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.
- "kind": "adexchangebuyer#directDealsList", # Resource type.
- "directDeals": [ # A list of direct deals relevant for your account.
- { # The configuration data for an Ad Exchange direct deal.
- "advertiser": "A String", # The name of the advertiser this deal is for.
- "kind": "adexchangebuyer#directDeal", # Resource type.
- "currencyCode": "A String", # The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
- "fixedCpm": "A String", # The fixed price for this direct deal. In cpm micros of currency according to currency_code.
- "startTime": "A String", # Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.
- "endTime": "A String", # End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.
- "sellerNetwork": "A String", # The name of the publisher offering this direct deal.
- "id": "A String", # Deal id.
- "accountId": 42, # The account id of the buyer this deal is for.
- },
- ],
- }
-
- list(accountId, pageToken=None, maxResults=None)
List all ad clients in the specified account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(accountId, pageToken=None, maxResults=None)
- List all ad clients in the specified account.
-
-Args:
- accountId: string, Account for which to list ad clients. (required)
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)
List all custom channels which the specified ad unit belongs to.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(accountId, adClientId, adUnitId, pageToken=None, maxResults=None)
- List all custom channels which the specified ad unit belongs to.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the ad unit. (required)
- adUnitId: string, Ad unit for which to list custom channels. (required)
- pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- customchannels()
-
Returns the customchannels Resource.
- -
- get(accountId, adClientId, adUnitId)
Gets the specified ad unit in the specified ad client for the specified account.
-
- list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
List all ad units in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-get(accountId, adClientId, adUnitId)
- Gets the specified ad unit in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to get the ad unit. (required)
- adUnitId: string, Ad unit to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- }
-list(accountId, adClientId, pageToken=None, includeInactive=None, maxResults=None)
- List all ad units in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list ad units. (required)
- pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- includeInactive: boolean, Whether to include inactive ad units. Default: true.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
List all ad units in the specified custom channel.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(accountId, adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
- List all ad units in the specified custom channel.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel for which to list ad units. (required)
- pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- includeInactive: boolean, Whether to include inactive ad units. Default: true.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- adunits()
-
Returns the adunits Resource.
- -
- get(accountId, adClientId, customChannelId)
Get the specified custom channel from the specified ad client for the specified account.
-
- list(accountId, adClientId, pageToken=None, maxResults=None)
List all custom channels in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-get(accountId, adClientId, customChannelId)
- Get the specified custom channel from the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-list(accountId, adClientId, pageToken=None, maxResults=None)
- List all custom channels in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list custom channels. (required)
- pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- adclients()
-
Returns the adclients Resource.
- -
- adunits()
-
Returns the adunits Resource.
- -
- customchannels()
-
Returns the customchannels Resource.
- -
- reports()
-
Returns the reports Resource.
- -
- urlchannels()
-
Returns the urlchannels Resource.
- - -Get information about the selected AdSense account.
-
- list(pageToken=None, maxResults=None)
List all accounts available to this AdSense account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-get(accountId, tree=None)
- Get information about the selected AdSense account.
-
-Args:
- accountId: string, Account to get information about. (required)
- tree: boolean, Whether the tree of sub accounts should be returned.
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
- "id": "A String", # Unique identifier of this account.
- "subAccounts": [ # Sub accounts of the this account.
- # Object with schema name: Account
- ],
- "name": "A String", # Name of this account.
- }
-list(pageToken=None, maxResults=None)
- List all accounts available to this AdSense account.
-
-Args:
- pageToken: string, A continuation token, used to page through accounts. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of accounts to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The accounts returned in this list response.
- {
- "kind": "adsense#account", # Kind of resource this is, in this case adsense#account.
- "id": "A String", # Unique identifier of this account.
- "subAccounts": [ # Sub accounts of the this account.
- # Object with schema name: Account
- ],
- "name": "A String", # Name of this account.
- },
- ],
- "kind": "adsense#accounts", # Kind of list this is, in this case adsense#accounts.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
- -Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
-generate(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)
- Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
-
-Args:
- accountId: string, Account upon which to report. (required)
- startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
- endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
- locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
- metric: string, Numeric columns to include in the report. (repeated)
- currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
- startIndex: integer, Index of the first row of report data to return.
- sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-generate_media(accountId, startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, sort=None, maxResults=None, filter=None, dimension=None)
- Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. - -Args: - accountId: string, Account upon which to report. (required) - startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) - endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) - locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - metric: string, Numeric columns to include in the report. (repeated) - currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. - startIndex: integer, Index of the first row of report data to return. - sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated) - maxResults: integer, The maximum number of rows of report data to return. - filter: string, Filters to be run on the report. (repeated) - dimension: string, Dimensions to base the report on. (repeated) - -Returns: - The media object as a string. - --
- list(accountId, adClientId, pageToken=None, maxResults=None)
List all URL channels in the specified ad client for the specified account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(accountId, adClientId, pageToken=None, maxResults=None)
- List all URL channels in the specified ad client for the specified account.
-
-Args:
- accountId: string, Account to which the ad client belongs. (required)
- adClientId: string, Ad client for which to list URL channels. (required)
- pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The URL channels returned in this list response.
- {
- "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- },
- ],
- "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- list(pageToken=None, maxResults=None)
List all ad clients in this AdSense account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(pageToken=None, maxResults=None)
- List all ad clients in this AdSense account.
-
-Args:
- pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of ad clients to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad clients returned in this list response.
- {
- "productCode": "A String", # This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
- "kind": "adsense#adClient", # Kind of resource this is, in this case adsense#adClient.
- "id": "A String", # Unique identifier of this ad client.
- "supportsReporting": True or False, # Whether this ad client supports being reported on.
- },
- ],
- "kind": "adsense#adClients", # Kind of list this is, in this case adsense#adClients.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- list(adClientId, adUnitId, pageToken=None, maxResults=None)
List all custom channels which the specified ad unit belongs to.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(adClientId, adUnitId, pageToken=None, maxResults=None)
- List all custom channels which the specified ad unit belongs to.
-
-Args:
- adClientId: string, Ad client which contains the ad unit. (required)
- adUnitId: string, Ad unit for which to list custom channels. (required)
- pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- customchannels()
-
Returns the customchannels Resource.
- - -Gets the specified ad unit in the specified ad client.
-
- list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
List all ad units in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-get(adClientId, adUnitId)
- Gets the specified ad unit in the specified ad client.
-
-Args:
- adClientId: string, Ad client for which to get the ad unit. (required)
- adUnitId: string, Ad unit to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- }
-list(adClientId, pageToken=None, includeInactive=None, maxResults=None)
- List all ad units in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list ad units. (required)
- pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- includeInactive: boolean, Whether to include inactive ad units. Default: true.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
List all ad units in the specified custom channel.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(adClientId, customChannelId, pageToken=None, includeInactive=None, maxResults=None)
- List all ad units in the specified custom channel.
-
-Args:
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel for which to list ad units. (required)
- pageToken: string, A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- includeInactive: boolean, Whether to include inactive ad units. Default: true.
- maxResults: integer, The maximum number of ad units to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The ad units returned in this list response.
- {
- "status": "A String", # Status of this ad unit. Possible values are:
- # NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
- #
- # ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
- #
- # INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
- "kind": "adsense#adUnit", # Kind of resource this is, in this case adsense#adUnit.
- "code": "A String", # Identity code of this ad unit, not necessarily unique across ad clients.
- "id": "A String", # Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this ad unit.
- },
- ],
- "kind": "adsense#adUnits", # Kind of list this is, in this case adsense#adUnits.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- adunits()
-
Returns the adunits Resource.
- -
- get(adClientId, customChannelId)
Get the specified custom channel from the specified ad client.
-
- list(adClientId, pageToken=None, maxResults=None)
List all custom channels in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-get(adClientId, customChannelId)
- Get the specified custom channel from the specified ad client.
-
-Args:
- adClientId: string, Ad client which contains the custom channel. (required)
- customChannelId: string, Custom channel to retrieve. (required)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- }
-list(adClientId, pageToken=None, maxResults=None)
- List all custom channels in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list custom channels. (required)
- pageToken: string, A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of custom channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The custom channels returned in this list response.
- {
- "kind": "adsense#customChannel", # Kind of resource this is, in this case adsense#customChannel.
- "code": "A String", # Code of this custom channel, not necessarily unique across ad clients.
- "targetingInfo": { # The targeting information of this custom channel, if activated.
- "location": "A String", # The locations in which ads appear. (Only valid for content and mobile content ads). Acceptable values for content ads are: TOP_LEFT, TOP_CENTER, TOP_RIGHT, MIDDLE_LEFT, MIDDLE_CENTER, MIDDLE_RIGHT, BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, MULTIPLE_LOCATIONS. Acceptable values for mobile content ads are: TOP, MIDDLE, BOTTOM, MULTIPLE_LOCATIONS.
- "adsAppearOn": "A String", # The name used to describe this channel externally.
- "siteLanguage": "A String", # The language of the sites ads will be displayed on.
- "description": "A String", # The external description of the channel.
- },
- "id": "A String", # Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "name": "A String", # Name of this custom channel.
- },
- ],
- "kind": "adsense#customChannels", # Kind of list this is, in this case adsense#customChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- accounts()
-
Returns the accounts Resource.
- -
- adclients()
-
Returns the adclients Resource.
- -
- adunits()
-
Returns the adunits Resource.
- -
- customchannels()
-
Returns the customchannels Resource.
- -
- reports()
-
Returns the reports Resource.
- -
- urlchannels()
-
Returns the urlchannels Resource.
- - \ No newline at end of file diff --git a/docs/dyn/adsense_v1_1.reports.html b/docs/dyn/adsense_v1_1.reports.html deleted file mode 100644 index 813f116..0000000 --- a/docs/dyn/adsense_v1_1.reports.html +++ /dev/null @@ -1,154 +0,0 @@ - - - -Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
- -Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
-generate(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)
- Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
-
-Args:
- startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
- endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required)
- locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
- metric: string, Numeric columns to include in the report. (repeated)
- currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.
- startIndex: integer, Index of the first row of report data to return.
- accountId: string, Accounts upon which to report. (repeated)
- sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated)
- maxResults: integer, The maximum number of rows of report data to return.
- filter: string, Filters to be run on the report. (repeated)
- dimension: string, Dimensions to base the report on. (repeated)
-
-Returns:
- An object of the form:
-
- {
- "kind": "adsense#report", # Kind this is, in this case adsense#report.
- "rows": [ # The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
- [
- "A String",
- ],
- ],
- "warnings": [ # Any warnings associated with generation of the report.
- "A String",
- ],
- "totals": [ # The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- "headers": [ # The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
- {
- "currency": "A String", # The currency of this column. Only present if the header type is METRIC_CURRENCY.
- "type": "A String", # The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
- "name": "A String", # The name of the header.
- },
- ],
- "totalMatchedRows": "A String", # The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
- "averages": [ # The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
- "A String",
- ],
- }
-generate_media(startDate, endDate, locale=None, metric=None, currency=None, startIndex=None, accountId=None, sort=None, maxResults=None, filter=None, dimension=None)
- Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. - -Args: - startDate: string, Start of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) - endDate: string, End of the date range to report on in "YYYY-MM-DD" format, inclusive. (required) - locale: string, Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified. - metric: string, Numeric columns to include in the report. (repeated) - currency: string, Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set. - startIndex: integer, Index of the first row of report data to return. - accountId: string, Accounts upon which to report. (repeated) - sort: string, The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending. (repeated) - maxResults: integer, The maximum number of rows of report data to return. - filter: string, Filters to be run on the report. (repeated) - dimension: string, Dimensions to base the report on. (repeated) - -Returns: - The media object as a string. - --
- list(adClientId, pageToken=None, maxResults=None)
List all URL channels in the specified ad client for this AdSense account.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(adClientId, pageToken=None, maxResults=None)
- List all URL channels in the specified ad client for this AdSense account.
-
-Args:
- adClientId: string, Ad client for which to list URL channels. (required)
- pageToken: string, A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
- maxResults: integer, The maximum number of URL channels to include in the response, used for paging.
-
-Returns:
- An object of the form:
-
- {
- "nextPageToken": "A String", # Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
- "items": [ # The URL channels returned in this list response.
- {
- "kind": "adsense#urlChannel", # Kind of resource this is, in this case adsense#urlChannel.
- "id": "A String", # Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
- "urlPattern": "A String", # URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
- },
- ],
- "kind": "adsense#urlChannels", # Kind of list this is, in this case adsense#urlChannels.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- query(profileId, body, pageToken=None, maxResults=None)
Retrieves list of report dimension values for a list of filters.
-
- query_next(previous_request, previous_response)
Retrieves the next page of results.
-query(profileId, body, pageToken=None, maxResults=None)
- Retrieves list of report dimension values for a list of filters.
-
-Args:
- profileId: string, The DFA user profile id. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a DimensionValuesRequest.
- "dimensionName": "A String", # The name of the dimension values should be requested for.
- "startDate": "A String", # The start date of the date range for which to retrieve dimension values. A string of the format: "yyyy-MM-dd".
- "kind": "dfareporting#dimensionValueRequest", # Kind of request this is, in this case dfareporting#dimensionValueRequest.
- "endDate": "A String", # The end date of the date range for which to retrieve dimension values. A string of the format: "yyyy-MM-dd".
- "filters": [ # List of filters to filter values by. The filters are ANDed.
- { # Represents a dimension filter.
- "dimensionName": "A String", # The name of the dimension to filter.
- "kind": "dfareporting#dimensionFilter", # Kind of resource this is, in this case dfareporting#dimensionFilter.
- "value": "A String", # The value of the dimension to filter for.
- },
- ],
- }
-
- pageToken: string, The value of the nextToken from the previous result page.
- maxResults: integer, Maximum number of results to return.
-
-Returns:
- An object of the form:
-
- { # Represents the list of DimensionValue resources.
- "nextPageToken": "A String", # Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The dimension values returned in this response.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "kind": "dfareporting#dimensionValueList", # Kind of list this is, in this case dfareporting#dimensionValueList.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-query_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
- list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
Lists files for a user profile.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
- Lists files for a user profile.
-
-Args:
- profileId: string, The DFA profile id. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field to sort the list by.
- Allowed values
- ID - Sort by file id.
- LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is 'DESCENDING'.
- Allowed values
- ASCENDING - Ascending order.
- DESCENDING - Descending order.
-
-Returns:
- An object of the form:
-
- { # Represents the list of File resources.
- "nextPageToken": "A String", # Continuation token used to page through files. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The files returned in this response.
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # Kind of resource this is, in this case dfareporting#file.
- "dateRange": { # The date range for which the file has report data.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # ETag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "csv": { # Urls for generated CSV data.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- },
- ],
- "kind": "dfareporting#fileList", # Kind of list this is, in this case dfareporting#fileList.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
Returns the dimensionValues Resource.
- -
- files()
-
Returns the files Resource.
- -
- reports()
-
Returns the reports Resource.
- -
- userProfiles()
-
Returns the userProfiles Resource.
- - \ No newline at end of file diff --git a/docs/dyn/dfareporting_v1.reports.html b/docs/dyn/dfareporting_v1.reports.html deleted file mode 100644 index fcf10d2..0000000 --- a/docs/dyn/dfareporting_v1.reports.html +++ /dev/null @@ -1,1069 +0,0 @@ - - - -
- files()
-
Returns the files Resource.
- - -Deletes a report by its id.
- -Retrieves a report by its id.
- -Creates a report.
-
- list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
Retrieves list of reports.
-
- list_next(previous_request, previous_response)
Retrieves the next page of results.
-
- patch(profileId, reportId, body)
Updates a report. This method supports patch semantics.
-
- run(profileId, reportId, synchronous=None)
Runs a report.
-
- update(profileId, reportId, body)
Updates a report.
-delete(profileId, reportId)
- Deletes a report by its id. - -Args: - profileId: string, The DFA user profile id. (required) - reportId: string, The id of the report. (required) --
get(profileId, reportId)
- Retrieves a report by its id.
-
-Args:
- profileId: string, The DFA user profile id. (required)
- reportId: string, The id of the report. (required)
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval the report is repeated for, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
- "A String",
- ],
- },
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "fileName": "A String", # The file name used when generating report files for this report.
- "etag": "A String", # ETag of this response for caching purposes.
- "criteria": { # The report criteria.
- "activities": { # Activity group.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "dimensionFilters": [ # The list of filters dimensions are filtered on.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Custom Rich Media Events group.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "type": "A String", # The type of the report, currently only "STANDARD" is supported.
- "id": "A String", # The unique ID identifying this report resource.
- "accountId": "A String", # The account id this report belongs to.
- }
-insert(profileId, body)
- Creates a report.
-
-Args:
- profileId: string, The DFA user profile id. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval the report is repeated for, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
- "A String",
- ],
- },
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "fileName": "A String", # The file name used when generating report files for this report.
- "etag": "A String", # ETag of this response for caching purposes.
- "criteria": { # The report criteria.
- "activities": { # Activity group.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "dimensionFilters": [ # The list of filters dimensions are filtered on.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Custom Rich Media Events group.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "type": "A String", # The type of the report, currently only "STANDARD" is supported.
- "id": "A String", # The unique ID identifying this report resource.
- "accountId": "A String", # The account id this report belongs to.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval the report is repeated for, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
- "A String",
- ],
- },
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "fileName": "A String", # The file name used when generating report files for this report.
- "etag": "A String", # ETag of this response for caching purposes.
- "criteria": { # The report criteria.
- "activities": { # Activity group.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "dimensionFilters": [ # The list of filters dimensions are filtered on.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Custom Rich Media Events group.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "type": "A String", # The type of the report, currently only "STANDARD" is supported.
- "id": "A String", # The unique ID identifying this report resource.
- "accountId": "A String", # The account id this report belongs to.
- }
-list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
- Retrieves list of reports.
-
-Args:
- profileId: string, The DFA user profile id. (required)
- pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field to sort the list by.
- Allowed values
- ID - Sort by report id.
- LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
- NAME - Sort by display name of reports.
- maxResults: integer, Maximum number of results to return.
- sortOrder: string, Order of sorted results, default is 'DESCENDING'.
- Allowed values
- ASCENDING - Ascending order.
- DESCENDING - Descending order.
-
-Returns:
- An object of the form:
-
- { # Represents the list of reports.
- "nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
- "items": [ # The reports returned in this response.
- { # Represents a Report resource.
- "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval the report is repeated for, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
- "A String",
- ],
- },
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "fileName": "A String", # The file name used when generating report files for this report.
- "etag": "A String", # ETag of this response for caching purposes.
- "criteria": { # The report criteria.
- "activities": { # Activity group.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "dimensionFilters": [ # The list of filters dimensions are filtered on.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Custom Rich Media Events group.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "type": "A String", # The type of the report, currently only "STANDARD" is supported.
- "id": "A String", # The unique ID identifying this report resource.
- "accountId": "A String", # The account id this report belongs to.
- },
- ],
- "kind": "dfareporting#reportList", # Kind of list this is, in this case dfareporting#reportList.
- "etag": "A String", # ETag of this response for caching purposes.
- }
-list_next(previous_request, previous_response)
- Retrieves the next page of results. - -Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - -Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
patch(profileId, reportId, body)
- Updates a report. This method supports patch semantics.
-
-Args:
- profileId: string, The DFA user profile id. (required)
- reportId: string, The id of the report. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval the report is repeated for, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
- "A String",
- ],
- },
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "fileName": "A String", # The file name used when generating report files for this report.
- "etag": "A String", # ETag of this response for caching purposes.
- "criteria": { # The report criteria.
- "activities": { # Activity group.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "dimensionFilters": [ # The list of filters dimensions are filtered on.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Custom Rich Media Events group.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "type": "A String", # The type of the report, currently only "STANDARD" is supported.
- "id": "A String", # The unique ID identifying this report resource.
- "accountId": "A String", # The account id this report belongs to.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval the report is repeated for, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
- "A String",
- ],
- },
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "fileName": "A String", # The file name used when generating report files for this report.
- "etag": "A String", # ETag of this response for caching purposes.
- "criteria": { # The report criteria.
- "activities": { # Activity group.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "dimensionFilters": [ # The list of filters dimensions are filtered on.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Custom Rich Media Events group.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "type": "A String", # The type of the report, currently only "STANDARD" is supported.
- "id": "A String", # The unique ID identifying this report resource.
- "accountId": "A String", # The account id this report belongs to.
- }
-run(profileId, reportId, synchronous=None)
- Runs a report.
-
-Args:
- profileId: string, The DFA profile id. (required)
- reportId: string, The id of the report. (required)
- synchronous: boolean, If set and true, tries to run the report synchronously.
-
-Returns:
- An object of the form:
-
- { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
- "status": "A String", # The status of the report file, one of:
- # - "PROCESSING"
- # - "REPORT_AVAILABLE"
- # - "FAILED"
- # - "CANCELLED"
- "kind": "dfareporting#file", # Kind of resource this is, in this case dfareporting#file.
- "dateRange": { # The date range for which the file has report data.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "fileName": "A String", # The file name of the file.
- "etag": "A String", # ETag of this response for caching purposes.
- "reportId": "A String", # The ID of the report this file was generated from.
- "urls": { # The urls where the completed report file can be downloaded.
- "csv": { # Urls for generated CSV data.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
- },
- "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
- "id": "A String", # The unique ID of this report file.
- }
-update(profileId, reportId, body)
- Updates a report.
-
-Args:
- profileId: string, The DFA user profile id. (required)
- reportId: string, The id of the report. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Represents a Report resource.
- "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval the report is repeated for, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
- "A String",
- ],
- },
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "fileName": "A String", # The file name used when generating report files for this report.
- "etag": "A String", # ETag of this response for caching purposes.
- "criteria": { # The report criteria.
- "activities": { # Activity group.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "dimensionFilters": [ # The list of filters dimensions are filtered on.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Custom Rich Media Events group.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "type": "A String", # The type of the report, currently only "STANDARD" is supported.
- "id": "A String", # The unique ID identifying this report resource.
- "accountId": "A String", # The account id this report belongs to.
- }
-
-
-Returns:
- An object of the form:
-
- { # Represents a Report resource.
- "kind": "dfareporting#report", # Kind of resource this is, in this case dfareporting#report.
- "subAccountId": "A String", # The subbaccount id this report belongs to if applicable.
- "name": "A String", # The name of the report.
- "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
- "startDate": "A String", # Start date of date range for which scheduled reports should be run.
- "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
- # - DAY_OF_MONTH
- # - WEEK_OF_MONTH
- # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
- "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
- "expirationDate": "A String", # The expiration date when the scheduled report stops running.
- "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
- "repeats": "A String", # The interval the report is repeated for, one of:
- # - "DAILY", also requires field "every" to be set.
- # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
- # - "TWICE_A_MONTH"
- # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
- # - "QUARTERLY"
- # - "YEARLY"
- "repeatsOnWeekDays": [ # List of week days "WEEKLY" scheduled reports should run on.
- "A String",
- ],
- },
- "ownerProfileId": "A String", # The user profile id of the owner of this report.
- "fileName": "A String", # The file name used when generating report files for this report.
- "etag": "A String", # ETag of this response for caching purposes.
- "criteria": { # The report criteria.
- "activities": { # Activity group.
- "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "metricNames": [ # List of names of floodlight activity metrics.
- "A String",
- ],
- },
- "dimensions": [ # The list of dimensions the report should include.
- { # Represents a sorted dimension.
- "kind": "dfareporting#sortedDimension", # Kind of resource this is, in this case dfareporting#sortedDimension.
- "name": "A String", # The name of the dimension.
- "sortOrder": "A String", # An optional sort order for the dimension column, one of:
- # - "ASCENDING"
- # - "DESCENDING"
- },
- ],
- "metricNames": [ # The list of names of metrics the report should include.
- "A String",
- ],
- "dateRange": { # The date range this report should be run for.
- "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
- # - "TODAY"
- # - "YESTERDAY"
- # - "WEEK_TO_DATE"
- # - "MONTH_TO_DATE"
- # - "QUARTER_TO_DATE"
- # - "YEAR_TO_DATE"
- # - "PREVIOUS_WEEK"
- # - "PREVIOUS_MONTH"
- # - "PREVIOUS_QUARTER"
- # - "PREVIOUS_YEAR"
- # - "LAST_7_DAYS"
- # - "LAST_30_DAYS"
- # - "LAST_90_DAYS"
- # - "LAST_365_DAYS"
- # - "LAST_24_MONTHS"
- "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
- },
- "dimensionFilters": [ # The list of filters dimensions are filtered on.
- # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- "customRichMediaEvents": { # Custom Rich Media Events group.
- "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
- { # Represents a DimensionValue resource.
- "dimensionName": "A String", # Name of the dimension.
- "kind": "dfareporting#dimensionValue", # Kind of resource this is, in this case dfareporting#dimensionValue.
- "etag": "A String", # ETag of this response for caching purposes.
- "id": "A String", # The ID associated with the value if available.
- "value": "A String", # The value of the dimension.
- },
- ],
- },
- },
- "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
- "type": "A String", # The type of the report, currently only "STANDARD" is supported.
- "id": "A String", # The unique ID identifying this report resource.
- "accountId": "A String", # The account id this report belongs to.
- }
-
get(profileId, reportId, fileId)
Retrieves a report file.
Args:
- profileId: string, The DFA profile id. (required)
- reportId: string, The id of the report. (required)
- fileId: string, The id of the report file. (required)
+ profileId: string, The DFA profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ fileId: string, The ID of the report file. (required)
Returns:
An object of the form:
@@ -102,19 +102,35 @@ Returns:
# - "REPORT_AVAILABLE"
# - "FAILED"
# - "CANCELLED"
- "kind": "dfareporting#file", # Kind of resource this is, in this case dfareporting#file.
- "dateRange": { # The date range for which the file has report data.
+ "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
+ "format": "A String", # The output format of the report. Only available once the file is available.
+ "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
},
"fileName": "A String", # The file name of the file.
- "etag": "A String", # ETag of this response for caching purposes.
+ "etag": "A String", # The eTag of this response for caching purposes.
"reportId": "A String", # The ID of the report this file was generated from.
"urls": { # The urls where the completed report file can be downloaded.
- "csv": { # Urls for generated CSV data.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
+ "browserUrl": "A String", # The url for downloading the report data through a browser.
+ "apiUrl": "A String", # The url for downloading the report data through the API.
},
"lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
"id": "A String", # The unique ID of this report file.
@@ -126,12 +142,12 @@ Returns:
Lists files for a report.
Args:
- profileId: string, The DFA profile id. (required)
- reportId: string, The id of the parent report. (required)
+ profileId: string, The DFA profile ID. (required)
+ reportId: string, The ID of the parent report. (required)
pageToken: string, The value of the nextToken from the previous result page.
- sortField: string, The field to sort the list by.
+ sortField: string, The field by which to sort the list.
Allowed values
- ID - Sort by file id.
+ ID - Sort by file ID.
LAST_MODIFIED_TIME - Sort by 'lastmodifiedAt' field.
maxResults: integer, Maximum number of results to return.
sortOrder: string, Order of sorted results, default is 'DESCENDING'.
@@ -151,26 +167,42 @@ Returns:
# - "REPORT_AVAILABLE"
# - "FAILED"
# - "CANCELLED"
- "kind": "dfareporting#file", # Kind of resource this is, in this case dfareporting#file.
- "dateRange": { # The date range for which the file has report data.
+ "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
+ "format": "A String", # The output format of the report. Only available once the file is available.
+ "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
"startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
"endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
},
"fileName": "A String", # The file name of the file.
- "etag": "A String", # ETag of this response for caching purposes.
+ "etag": "A String", # The eTag of this response for caching purposes.
"reportId": "A String", # The ID of the report this file was generated from.
"urls": { # The urls where the completed report file can be downloaded.
- "csv": { # Urls for generated CSV data.
- "browserUrl": "A String", # The url for downloading the report data through a browser.
- "apiUrl": "A String", # The url for downloading the report data through the API.
- },
+ "browserUrl": "A String", # The url for downloading the report data through a browser.
+ "apiUrl": "A String", # The url for downloading the report data through the API.
},
"lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
"id": "A String", # The unique ID of this report file.
},
],
- "kind": "dfareporting#fileList", # Kind of list this is, in this case dfareporting#fileList.
- "etag": "A String", # ETag of this response for caching purposes.
+ "kind": "dfareporting#fileList", # The kind of list this is, in this case dfareporting#fileList.
+ "etag": "A String", # The eTag of this response for caching purposes.
}
diff --git a/docs/dyn/dfareporting_v1_1.reports.html b/docs/dyn/dfareporting_v1_1.reports.html
index e69de29..fa979c1 100644
--- a/docs/dyn/dfareporting_v1_1.reports.html
+++ b/docs/dyn/dfareporting_v1_1.reports.html
@@ -0,0 +1,3765 @@
+
+
+
+DFA Reporting API . reports
+Instance Methods
+
+ files()
+
+Returns the files Resource.
+
+
+Deletes a report by its ID.
+
+Retrieves a report by its ID.
+
+Creates a report.
+
+ list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
+Retrieves list of reports.
+
+ list_next(previous_request, previous_response)
+Retrieves the next page of results.
+
+ patch(profileId, reportId, body)
+Updates a report. This method supports patch semantics.
+
+ run(profileId, reportId, synchronous=None)
+Runs a report.
+
+ update(profileId, reportId, body)
+Updates a report.
+Method Details
+
+ delete(profileId, reportId)
+ Deletes a report by its ID.
+
+Args:
+ profileId: string, The DFA user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+
+
+
+
+ get(profileId, reportId)
+ Retrieves a report by its ID.
+
+Args:
+ profileId: string, The DFA user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+
+Returns:
+ An object of the form:
+
+ { # Represents a Report resource.
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ },
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+ "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
+ "name": "A String", # The name of the report.
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
+ # - DAY_OF_MONTH
+ # - WEEK_OF_MONTH
+ # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "repeats": "A String", # The interval for which the report is repeated, one of:
+ # - "DAILY", also requires field "every" to be set.
+ # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
+ # - "TWICE_A_MONTH"
+ # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
+ # - "QUARTERLY"
+ # - "YEARLY"
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ },
+ "format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "reportProperties": { # The properties of the report.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ },
+ },
+ "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "delivery": { # The report's email delivery settings.
+ "message": "A String", # The message to be sent with each email.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+ "deliveryType": "A String", # The delivery type for the recipient, one of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "email": "A String", # The email address of the recipient.
+ },
+ ],
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique ID identifying this report resource.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "fileName": "A String", # The file name used when generating report files for this report.
+ "type": "A String", # The type of the report, one of:
+ # - STANDARD
+ # - REACH
+ # - ACTIVE_GRP
+ # - PATH_TO_CONVERSION
+ # - FLOODLIGHT
+ # - CROSS_DIMENSION_REACH
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ "dimension": "A String", # The dimension option, one of:
+ # - "ADVERTISER"
+ # - "CAMPAIGN"
+ # - "SITE_BY_ADVERTISER"
+ # - "SITE_BY_CAMPAIGN"
+ },
+ "accountId": "A String", # The account ID to which this report belongs.
+ }
+
+
+
+ insert(profileId, body)
+ Creates a report.
+
+Args:
+ profileId: string, The DFA user profile ID. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Report resource.
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ },
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+ "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
+ "name": "A String", # The name of the report.
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
+ # - DAY_OF_MONTH
+ # - WEEK_OF_MONTH
+ # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "repeats": "A String", # The interval for which the report is repeated, one of:
+ # - "DAILY", also requires field "every" to be set.
+ # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
+ # - "TWICE_A_MONTH"
+ # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
+ # - "QUARTERLY"
+ # - "YEARLY"
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ },
+ "format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "reportProperties": { # The properties of the report.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ },
+ },
+ "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "delivery": { # The report's email delivery settings.
+ "message": "A String", # The message to be sent with each email.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+ "deliveryType": "A String", # The delivery type for the recipient, one of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "email": "A String", # The email address of the recipient.
+ },
+ ],
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique ID identifying this report resource.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "fileName": "A String", # The file name used when generating report files for this report.
+ "type": "A String", # The type of the report, one of:
+ # - STANDARD
+ # - REACH
+ # - ACTIVE_GRP
+ # - PATH_TO_CONVERSION
+ # - FLOODLIGHT
+ # - CROSS_DIMENSION_REACH
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ "dimension": "A String", # The dimension option, one of:
+ # - "ADVERTISER"
+ # - "CAMPAIGN"
+ # - "SITE_BY_ADVERTISER"
+ # - "SITE_BY_CAMPAIGN"
+ },
+ "accountId": "A String", # The account ID to which this report belongs.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Represents a Report resource.
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ },
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+ "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
+ "name": "A String", # The name of the report.
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
+ # - DAY_OF_MONTH
+ # - WEEK_OF_MONTH
+ # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "repeats": "A String", # The interval for which the report is repeated, one of:
+ # - "DAILY", also requires field "every" to be set.
+ # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
+ # - "TWICE_A_MONTH"
+ # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
+ # - "QUARTERLY"
+ # - "YEARLY"
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ },
+ "format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "reportProperties": { # The properties of the report.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ },
+ },
+ "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "delivery": { # The report's email delivery settings.
+ "message": "A String", # The message to be sent with each email.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+ "deliveryType": "A String", # The delivery type for the recipient, one of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "email": "A String", # The email address of the recipient.
+ },
+ ],
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique ID identifying this report resource.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "fileName": "A String", # The file name used when generating report files for this report.
+ "type": "A String", # The type of the report, one of:
+ # - STANDARD
+ # - REACH
+ # - ACTIVE_GRP
+ # - PATH_TO_CONVERSION
+ # - FLOODLIGHT
+ # - CROSS_DIMENSION_REACH
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ "dimension": "A String", # The dimension option, one of:
+ # - "ADVERTISER"
+ # - "CAMPAIGN"
+ # - "SITE_BY_ADVERTISER"
+ # - "SITE_BY_CAMPAIGN"
+ },
+ "accountId": "A String", # The account ID to which this report belongs.
+ }
+
+
+
+ list(profileId, pageToken=None, sortField=None, maxResults=None, sortOrder=None)
+ Retrieves list of reports.
+
+Args:
+ profileId: string, The DFA user profile ID. (required)
+ pageToken: string, The value of the nextToken from the previous result page.
+ sortField: string, The field by which to sort the list.
+ Allowed values
+ ID - Sort by report ID.
+ LAST_MODIFIED_TIME - Sort by 'lastModifiedTime' field.
+ NAME - Sort by name of reports.
+ maxResults: integer, Maximum number of results to return.
+ sortOrder: string, Order of sorted results, default is 'DESCENDING'.
+ Allowed values
+ ASCENDING - Ascending order.
+ DESCENDING - Descending order.
+
+Returns:
+ An object of the form:
+
+ { # Represents the list of reports.
+ "nextPageToken": "A String", # Continuation token used to page through reports. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
+ "items": [ # The reports returned in this response.
+ { # Represents a Report resource.
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ },
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+ "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
+ "name": "A String", # The name of the report.
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
+ # - DAY_OF_MONTH
+ # - WEEK_OF_MONTH
+ # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "repeats": "A String", # The interval for which the report is repeated, one of:
+ # - "DAILY", also requires field "every" to be set.
+ # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
+ # - "TWICE_A_MONTH"
+ # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
+ # - "QUARTERLY"
+ # - "YEARLY"
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ },
+ "format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "reportProperties": { # The properties of the report.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ },
+ },
+ "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "delivery": { # The report's email delivery settings.
+ "message": "A String", # The message to be sent with each email.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+ "deliveryType": "A String", # The delivery type for the recipient, one of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "email": "A String", # The email address of the recipient.
+ },
+ ],
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique ID identifying this report resource.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "fileName": "A String", # The file name used when generating report files for this report.
+ "type": "A String", # The type of the report, one of:
+ # - STANDARD
+ # - REACH
+ # - ACTIVE_GRP
+ # - PATH_TO_CONVERSION
+ # - FLOODLIGHT
+ # - CROSS_DIMENSION_REACH
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ "dimension": "A String", # The dimension option, one of:
+ # - "ADVERTISER"
+ # - "CAMPAIGN"
+ # - "SITE_BY_ADVERTISER"
+ # - "SITE_BY_CAMPAIGN"
+ },
+ "accountId": "A String", # The account ID to which this report belongs.
+ },
+ ],
+ "kind": "dfareporting#reportList", # The kind of list this is, in this case dfareporting#reportList.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ }
+
+
+
+ list_next(previous_request, previous_response)
+ Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ patch(profileId, reportId, body)
+ Updates a report. This method supports patch semantics.
+
+Args:
+ profileId: string, The DFA user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Report resource.
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ },
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+ "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
+ "name": "A String", # The name of the report.
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
+ # - DAY_OF_MONTH
+ # - WEEK_OF_MONTH
+ # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "repeats": "A String", # The interval for which the report is repeated, one of:
+ # - "DAILY", also requires field "every" to be set.
+ # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
+ # - "TWICE_A_MONTH"
+ # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
+ # - "QUARTERLY"
+ # - "YEARLY"
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ },
+ "format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "reportProperties": { # The properties of the report.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ },
+ },
+ "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "delivery": { # The report's email delivery settings.
+ "message": "A String", # The message to be sent with each email.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+ "deliveryType": "A String", # The delivery type for the recipient, one of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "email": "A String", # The email address of the recipient.
+ },
+ ],
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique ID identifying this report resource.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "fileName": "A String", # The file name used when generating report files for this report.
+ "type": "A String", # The type of the report, one of:
+ # - STANDARD
+ # - REACH
+ # - ACTIVE_GRP
+ # - PATH_TO_CONVERSION
+ # - FLOODLIGHT
+ # - CROSS_DIMENSION_REACH
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ "dimension": "A String", # The dimension option, one of:
+ # - "ADVERTISER"
+ # - "CAMPAIGN"
+ # - "SITE_BY_ADVERTISER"
+ # - "SITE_BY_CAMPAIGN"
+ },
+ "accountId": "A String", # The account ID to which this report belongs.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Represents a Report resource.
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ },
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+ "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
+ "name": "A String", # The name of the report.
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
+ # - DAY_OF_MONTH
+ # - WEEK_OF_MONTH
+ # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "repeats": "A String", # The interval for which the report is repeated, one of:
+ # - "DAILY", also requires field "every" to be set.
+ # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
+ # - "TWICE_A_MONTH"
+ # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
+ # - "QUARTERLY"
+ # - "YEARLY"
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ },
+ "format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "reportProperties": { # The properties of the report.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ },
+ },
+ "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "delivery": { # The report's email delivery settings.
+ "message": "A String", # The message to be sent with each email.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+ "deliveryType": "A String", # The delivery type for the recipient, one of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "email": "A String", # The email address of the recipient.
+ },
+ ],
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique ID identifying this report resource.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "fileName": "A String", # The file name used when generating report files for this report.
+ "type": "A String", # The type of the report, one of:
+ # - STANDARD
+ # - REACH
+ # - ACTIVE_GRP
+ # - PATH_TO_CONVERSION
+ # - FLOODLIGHT
+ # - CROSS_DIMENSION_REACH
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ "dimension": "A String", # The dimension option, one of:
+ # - "ADVERTISER"
+ # - "CAMPAIGN"
+ # - "SITE_BY_ADVERTISER"
+ # - "SITE_BY_CAMPAIGN"
+ },
+ "accountId": "A String", # The account ID to which this report belongs.
+ }
+
+
+
+ run(profileId, reportId, synchronous=None)
+ Runs a report.
+
+Args:
+ profileId: string, The DFA profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ synchronous: boolean, If set and true, tries to run the report synchronously.
+
+Returns:
+ An object of the form:
+
+ { # Represents a File resource. A File contains the meta-data for a report run. It shows the status of the run and holds the urls to the generated report data if the run is finished and the status is "REPORT_AVAILABLE".
+ "status": "A String", # The status of the report file, one of:
+ # - "PROCESSING"
+ # - "REPORT_AVAILABLE"
+ # - "FAILED"
+ # - "CANCELLED"
+ "kind": "dfareporting#file", # The kind of resource this is, in this case dfareporting#file.
+ "format": "A String", # The output format of the report. Only available once the file is available.
+ "dateRange": { # Represents a date range. # The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "fileName": "A String", # The file name of the file.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "reportId": "A String", # The ID of the report this file was generated from.
+ "urls": { # The urls where the completed report file can be downloaded.
+ "browserUrl": "A String", # The url for downloading the report data through a browser.
+ "apiUrl": "A String", # The url for downloading the report data through the API.
+ },
+ "lastModifiedTime": "A String", # The timestamp in milliseconds since epoch when this file was last modified.
+ "id": "A String", # The unique ID of this report file.
+ }
+
+
+
+ update(profileId, reportId, body)
+ Updates a report.
+
+Args:
+ profileId: string, The DFA user profile ID. (required)
+ reportId: string, The ID of the report. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Represents a Report resource.
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ },
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+ "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
+ "name": "A String", # The name of the report.
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
+ # - DAY_OF_MONTH
+ # - WEEK_OF_MONTH
+ # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "repeats": "A String", # The interval for which the report is repeated, one of:
+ # - "DAILY", also requires field "every" to be set.
+ # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
+ # - "TWICE_A_MONTH"
+ # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
+ # - "QUARTERLY"
+ # - "YEARLY"
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ },
+ "format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "reportProperties": { # The properties of the report.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ },
+ },
+ "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "delivery": { # The report's email delivery settings.
+ "message": "A String", # The message to be sent with each email.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+ "deliveryType": "A String", # The delivery type for the recipient, one of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "email": "A String", # The email address of the recipient.
+ },
+ ],
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique ID identifying this report resource.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "fileName": "A String", # The file name used when generating report files for this report.
+ "type": "A String", # The type of the report, one of:
+ # - STANDARD
+ # - REACH
+ # - ACTIVE_GRP
+ # - PATH_TO_CONVERSION
+ # - FLOODLIGHT
+ # - CROSS_DIMENSION_REACH
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ "dimension": "A String", # The dimension option, one of:
+ # - "ADVERTISER"
+ # - "CAMPAIGN"
+ # - "SITE_BY_ADVERTISER"
+ # - "SITE_BY_CAMPAIGN"
+ },
+ "accountId": "A String", # The account ID to which this report belongs.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # Represents a Report resource.
+ "pathToConversionCriteria": { # The report criteria for a report of type "PATH_TO_CONVERSION".
+ "conversionDimensions": [ # The list of conversion dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "reportProperties": { # The properties of the report.
+ "clicksLookbackWindow": 42, # DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "pivotOnInteractionPath": True or False, # Enable pivoting on interaction path.
+ "impressionsLookbackWindow": 42, # DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "maximumInteractionGap": 42, # The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ "maximumClickInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ "maximumImpressionInteractions": 42, # The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report.
+ },
+ "perInteractionDimensions": [ # The list of per interaction dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "activityFilters": [ # The list of 'dfa:activity' values to filter on.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "customFloodlightVariables": [ # The list of custom floodlight variables the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "kind": "dfareporting#report", # The kind of resource this is, in this case dfareporting#report.
+ "subAccountId": "A String", # The subbaccount ID to which this report belongs if applicable.
+ "name": "A String", # The name of the report.
+ "schedule": { # The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".
+ "startDate": "A String", # Start date of date range for which scheduled reports should be run.
+ "runsOnDayOfMonth": "A String", # Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Possible values are:
+ # - DAY_OF_MONTH
+ # - WEEK_OF_MONTH
+ # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
+ "every": 42, # Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
+ "expirationDate": "A String", # The expiration date when the scheduled report stops running.
+ "active": True or False, # Whether the schedule is active or not. Must be set to either true or false.
+ "repeats": "A String", # The interval for which the report is repeated, one of:
+ # - "DAILY", also requires field "every" to be set.
+ # - "WEEKLY", also requires fields "every" and "repeatsOnWeekDays" to be set.
+ # - "TWICE_A_MONTH"
+ # - "MONTHLY", also requires fields "every" and "runsOnDayOfMonth" to be set.
+ # - "QUARTERLY"
+ # - "YEARLY"
+ "repeatsOnWeekDays": [ # List of week days "WEEKLY" on which scheduled reports should run.
+ "A String",
+ ],
+ },
+ "format": "A String", # The output format of the report, currently only "CSV" is supported. If not specified, default format is "CSV". Note that the actual format in the completed report file might differ if for instance the report's size exceeds the format's capabilities. "CSV" will then be the fallback format.
+ "ownerProfileId": "A String", # The user profile id of the owner of this report.
+ "reachCriteria": { # The report criteria for a report of type "REACH".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "reachByFrequencyMetricNames": [ # The list of names of Reach By Frequency metrics the report should include.
+ "A String",
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "floodlightCriteria": { # The report criteria for a report of type "FLOODLIGHT".
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "floodlightConfigId": { # Represents a DimensionValue resource. # The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ "reportProperties": { # The properties of the report.
+ "includeUnattributedIPConversions": True or False, # Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion.
+ "includeUnattributedCookieConversions": True or False, # Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window.
+ "includeAttributedIPConversions": True or False, # Include conversions that have no cookie, but do have an exposure path.
+ },
+ },
+ "activeGrpCriteria": { # The report criteria for a report of type "ACTIVE_GRP".
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ # A valid active GRP report needs to have exactly one DimensionValue for the United States in addition to any advertiser or campaign dimension values.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "dimensions": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ },
+ "delivery": { # The report's email delivery settings.
+ "message": "A String", # The message to be sent with each email.
+ "emailOwnerDeliveryType": "A String", # The type of delivery for the owner to receive, if enabled. One of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "recipients": [ # The list of recipients to which to email the report.
+ { # Represents a recipient.
+ "kind": "dfareporting#recipient", # The kind of resource this is, in this case dfareporting#recipient.
+ "deliveryType": "A String", # The delivery type for the recipient, one of:
+ # - "ATTACHMENT" (support for additional options will be added later)
+ "email": "A String", # The email address of the recipient.
+ },
+ ],
+ "emailOwner": True or False, # Whether the report should be emailed to the report owner.
+ },
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "criteria": { # The report criteria for a report of type "STANDARD".
+ "activities": { # Represents an activity group. # Activity group.
+ "kind": "dfareporting#activities", # The kind of resource this is, in this case dfareporting#activities.
+ "filters": [ # List of activity filters. The dimension values need to be all either of type "dfa:activity" or "dfa:activityGroup".
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "metricNames": [ # List of names of floodlight activity metrics.
+ "A String",
+ ],
+ },
+ "dimensions": [ # The list of standard dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range for which this report should be run.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ # Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "customRichMediaEvents": { # Represents a Custom Rich Media Events group. # Custom Rich Media Events group.
+ "kind": "dfareporting#customRichMediaEvents", # The kind of resource this is, in this case dfareporting#customRichMediaEvents.
+ "filteredEventIds": [ # List of custom rich media event IDs. Dimension values must be all of type dfa:richMediaEventTypeIdAndName.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ },
+ },
+ "id": "A String", # The unique ID identifying this report resource.
+ "lastModifiedTime": "A String", # The timestamp (in milliseconds since epoch) of when this report was last modified.
+ "fileName": "A String", # The file name used when generating report files for this report.
+ "type": "A String", # The type of the report, one of:
+ # - STANDARD
+ # - REACH
+ # - ACTIVE_GRP
+ # - PATH_TO_CONVERSION
+ # - FLOODLIGHT
+ # - CROSS_DIMENSION_REACH
+ "crossDimensionReachCriteria": { # The report criteria for a report of type "CROSS_DIMENSION_REACH".
+ "breakdown": [ # The list of dimensions the report should include.
+ { # Represents a sorted dimension.
+ "kind": "dfareporting#sortedDimension", # The kind of resource this is, in this case dfareporting#sortedDimension.
+ "name": "A String", # The name of the dimension.
+ "sortOrder": "A String", # An optional sort order for the dimension column, one of:
+ # - "ASCENDING"
+ # - "DESCENDING"
+ },
+ ],
+ "overlapMetricNames": [ # The list of names of overlap metrics the report should include.
+ "A String",
+ ],
+ "metricNames": [ # The list of names of metrics the report should include.
+ "A String",
+ ],
+ "dateRange": { # Represents a date range. # The date range this report should be run for.
+ "startDate": "A String", # The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "kind": "dfareporting#dateRange", # The kind of resource this is, in this case dfareporting#dateRange.
+ "endDate": "A String", # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
+ "relativeDateRange": "A String", # The date range relative to the date of when the report is run, one of:
+ # - "TODAY"
+ # - "YESTERDAY"
+ # - "WEEK_TO_DATE"
+ # - "MONTH_TO_DATE"
+ # - "QUARTER_TO_DATE"
+ # - "YEAR_TO_DATE"
+ # - "PREVIOUS_WEEK"
+ # - "PREVIOUS_MONTH"
+ # - "PREVIOUS_QUARTER"
+ # - "PREVIOUS_YEAR"
+ # - "LAST_7_DAYS"
+ # - "LAST_30_DAYS"
+ # - "LAST_90_DAYS"
+ # - "LAST_365_DAYS"
+ # - "LAST_24_MONTHS"
+ },
+ "dimensionFilters": [ # The list of filters on which dimensions are filtered.
+ { # Represents a DimensionValue resource.
+ "dimensionName": "A String", # The name of the dimension.
+ "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
+ "etag": "A String", # The eTag of this response for caching purposes.
+ "id": "A String", # The ID associated with the value if available.
+ "value": "A String", # The value of the dimension.
+ },
+ ],
+ "pivoted": True or False, # Whether the report is pivoted or not. Defaults to true.
+ "dimension": "A String", # The dimension option, one of:
+ # - "ADVERTISER"
+ # - "CAMPAIGN"
+ # - "SITE_BY_ADVERTISER"
+ # - "SITE_BY_CAMPAIGN"
+ },
+ "accountId": "A String", # The account ID to which this report belongs.
+ }
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/dfareporting_v1.userProfiles.html b/docs/dyn/dfareporting_v1_1.userProfiles.html
similarity index 72%
rename from docs/dyn/dfareporting_v1.userProfiles.html
rename to docs/dyn/dfareporting_v1_1.userProfiles.html
index b339c72..141450f 100644
--- a/docs/dyn/dfareporting_v1.userProfiles.html
+++ b/docs/dyn/dfareporting_v1_1.userProfiles.html
@@ -72,34 +72,34 @@ h1, h2, h3 {
-DFA Reporting API . userProfiles
+DFA Reporting API . userProfiles
Instance Methods
-Gets one user profile by id.
+Gets one user profile by ID.
Retrieves list of user profiles for a user.
Method Details
get(profileId)
- Gets one user profile by id.
+ Gets one user profile by ID.
Args:
- profileId: string, The user profile id. (required)
+ profileId: string, The user profile ID. (required)
Returns:
An object of the form:
{ # Represents a UserProfile resource.
"userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # Kind of resource this is, in this case dfareporting#userProfile.
+ "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
"subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
"accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # ETag of this response for caching purposes.
+ "etag": "A String", # The eTag of this response for caching purposes.
"subAccountName": "A String", # The sub account name this profile belongs to if applicable.
"profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID this profile belongs to.
+ "accountId": "A String", # The account ID to which this profile belongs.
}
@@ -116,17 +116,17 @@ Returns:
"items": [ # The user profiles returned in this response.
{ # Represents a UserProfile resource.
"userName": "A String", # The user name.
- "kind": "dfareporting#userProfile", # Kind of resource this is, in this case dfareporting#userProfile.
+ "kind": "dfareporting#userProfile", # The kind of resource this is, in this case dfareporting#userProfile.
"subAccountId": "A String", # The sub account ID this profile belongs to if applicable.
"accountName": "A String", # The account name this profile belongs to.
- "etag": "A String", # ETag of this response for caching purposes.
+ "etag": "A String", # The eTag of this response for caching purposes.
"subAccountName": "A String", # The sub account name this profile belongs to if applicable.
"profileId": "A String", # The unique ID of the user profile.
- "accountId": "A String", # The account ID this profile belongs to.
+ "accountId": "A String", # The account ID to which this profile belongs.
},
],
- "kind": "dfareporting#userProfileList", # Kind of list this is, in this case dfareporting#userProfileList.
- "etag": "A String", # ETag of this response for caching purposes.
+ "kind": "dfareporting#userProfileList", # The kind of list this is, in this case dfareporting#userProfileList.
+ "etag": "A String", # The eTag of this response for caching purposes.
}
diff --git a/docs/dyn/discovery_v1.apis.html b/docs/dyn/discovery_v1.apis.html
index 21904fe..160f3bc 100644
--- a/docs/dyn/discovery_v1.apis.html
+++ b/docs/dyn/discovery_v1.apis.html
@@ -97,7 +97,7 @@ Returns:
"methods": { # API-level methods for this API.
"a_key": { # An individual method description.
"scopes": [ # OAuth 2.0 scopes applicable to this method.
- "",
+ "A String",
],
"description": "A String", # Description of this method.
"parameters": { # Details for all parameters in this method.
@@ -240,17 +240,18 @@ Returns:
"x16": "A String", # The url of the 16x16 icon.
},
"baseUrl": "A String", # [DEPRECATED] The base URL for REST requests.
- "version": "A String", # The version of this API.
+ "etag": "A String", # The etag for this response.
"features": [ # A list of supported features for this API.
"A String",
],
+ "version": "A String", # The version of this API.
"servicePath": "A String", # The base path for all REST requests.
"resources": { # The resources in this API.
"a_key": { # An individual resource description. Contains methods and sub-resources related to this resource.
"methods": { # Methods on this resource.
"a_key": { # Description for any methods on this resource.
"scopes": [ # OAuth 2.0 scopes applicable to this method.
- "",
+ "A String",
],
"description": "A String", # Description of this method.
"parameters": { # Details for all parameters in this method.
diff --git a/docs/dyn/drive_v2.about.html b/docs/dyn/drive_v2.about.html
index 168fad3..4349974 100644
--- a/docs/dyn/drive_v2.about.html
+++ b/docs/dyn/drive_v2.about.html
@@ -99,6 +99,14 @@ Returns:
},
],
"quotaBytesUsed": "A String", # The number of quota bytes used.
+ "user": { # The JSON template for a user. # The authenticated user.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
"permissionId": "A String", # The current user's ID as visible in the permissions collection.
"maxUploadSizes": [ # List of max upload sizes for each file type. The most specific type takes precedence.
{
@@ -142,6 +150,7 @@ Returns:
],
},
],
+ "quotaBytesUsedAggregate": "A String", # The number of quota bytes used by all Google apps (Drive, Picasa, etc.).
"domainSharingPolicy": "A String", # The domain sharing policy for the current user.
"selfLink": "A String", # A link back to this item.
"isCurrentAppInstalled": True or False, # A boolean indicating whether the authenticated app is installed by the authenticated user.
diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html
index 609d385..df48a0e 100644
--- a/docs/dyn/drive_v2.changes.html
+++ b/docs/dyn/drive_v2.changes.html
@@ -134,6 +134,10 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
+ "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
+ "mimeType": "A String", # The MIME type of the thumbnail.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ },
"originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
"description": "A String", # A short description of the file.
"webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
@@ -144,14 +148,22 @@ Returns:
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "width": 42, # The width of the image in pixels.
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "flashUsed": True or False, # Whether a flash was used to create the photo.
+ "exposureTime": 3.14, # The length of the exposure, in seconds.
+ "cameraMake": "A String", # The make of the camera used to create the photo.
+ "isoSpeed": 42, # The ISO speed used to create the photo.
+ "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+ "height": 42, # The height of the image in pixels.
+ "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
- "height": 42, # The height of the image in pixels.
+ "aperture": 3.14, # The aperture used to create the photo (f-number).
+ "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "width": 42, # The width of the image in pixels.
+ "cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
@@ -248,6 +260,10 @@ Returns:
"exportLinks": { # Links for exporting Google Docs to specific formats.
"a_key": "A String", # A mapping from export format to URL
},
+ "thumbnail": { # Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.
+ "mimeType": "A String", # The MIME type of the thumbnail.
+ "image": "A String", # The URL-safe Base64 encoded bytes of the thumbnail image.
+ },
"originalFilename": "A String", # The original filename if the file was uploaded manually, or the original title if the file was inserted through the API. Note that renames of the title will not change the original filename. This will only be populated on files with content stored in Drive.
"description": "A String", # A short description of the file.
"webContentLink": "A String", # A link for downloading the content of the file in a browser using cookie based authentication. In cases where the content is shared publicly, the content can be downloaded without any credentials.
@@ -258,14 +274,22 @@ Returns:
"createdDate": "A String", # Create time for this file (formatted ISO8601 timestamp).
"md5Checksum": "A String", # An MD5 checksum for the content of this file. This will only be populated on files with content stored in Drive.
"imageMediaMetadata": { # Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
- "width": 42, # The width of the image in pixels.
- "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "flashUsed": True or False, # Whether a flash was used to create the photo.
+ "exposureTime": 3.14, # The length of the exposure, in seconds.
+ "cameraMake": "A String", # The make of the camera used to create the photo.
+ "isoSpeed": 42, # The ISO speed used to create the photo.
+ "focalLength": 3.14, # The focal length used to create the photo, in millimeters.
+ "height": 42, # The height of the image in pixels.
+ "date": "A String", # The date and time the photo was taken (EXIF format timestamp).
"location": { # Geographic location information stored in the image.
"latitude": 3.14, # The latitude stored in the image.
"altitude": 3.14, # The altitude stored in the image.
"longitude": 3.14, # The longitude stored in the image.
},
- "height": 42, # The height of the image in pixels.
+ "aperture": 3.14, # The aperture used to create the photo (f-number).
+ "rotation": 42, # The rotation in clockwise degrees from the image's original orientation.
+ "width": 42, # The width of the image in pixels.
+ "cameraModel": "A String", # The model of the camera used to create the photo.
},
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in using a relevant Google editor or viewer.
diff --git a/docs/dyn/drive_v2.comments.html b/docs/dyn/drive_v2.comments.html
new file mode 100644
index 0000000..8db2aae
--- /dev/null
+++ b/docs/dyn/drive_v2.comments.html
@@ -0,0 +1,609 @@
+
+
+
+Deletes a comment.
+
+ get(fileId, commentId, includeDeleted=None)
Gets a comment by ID.
+ +Creates a new comment on the given file.
+
+ list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)
Lists a file's comments.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(fileId, commentId, body)
Updates an existing comment. This method supports patch semantics.
+
+ update(fileId, commentId, body)
Updates an existing comment.
+delete(fileId, commentId)
+ Deletes a comment. + +Args: + fileId: string, The ID of the file. (required) + commentId: string, The ID of the comment. (required) ++
get(fileId, commentId, includeDeleted=None)
+ Gets a comment by ID.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ commentId: string, The ID of the comment. (required)
+ includeDeleted: boolean, If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a comment on a file in Google Drive.
+ "status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+ # - "open" - The comment is still open.
+ # - "resolved" - The comment has been resolved by one of its replies.
+ "selfLink": "A String", # A link back to this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "author": { # The JSON template for a user. # The user who wrote this comment.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+ "replies": [ # Replies to this post.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "context": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "commentId": "A String", # The ID of the comment.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "fileId": "A String", # The file which this comment is addressing.
+ }
+insert(fileId, body)
+ Creates a new comment on the given file.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A JSON representation of a comment on a file in Google Drive.
+ "status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+ # - "open" - The comment is still open.
+ # - "resolved" - The comment has been resolved by one of its replies.
+ "selfLink": "A String", # A link back to this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "author": { # The JSON template for a user. # The user who wrote this comment.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+ "replies": [ # Replies to this post.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "context": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "commentId": "A String", # The ID of the comment.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "fileId": "A String", # The file which this comment is addressing.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a comment on a file in Google Drive.
+ "status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+ # - "open" - The comment is still open.
+ # - "resolved" - The comment has been resolved by one of its replies.
+ "selfLink": "A String", # A link back to this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "author": { # The JSON template for a user. # The user who wrote this comment.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+ "replies": [ # Replies to this post.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "context": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "commentId": "A String", # The ID of the comment.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "fileId": "A String", # The file which this comment is addressing.
+ }
+list(fileId, includeDeleted=None, pageToken=None, updatedMin=None, maxResults=None)
+ Lists a file's comments.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ includeDeleted: boolean, If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
+ pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ updatedMin: string, Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
+ maxResults: integer, The maximum number of discussions to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a list of comments on a file in Google Drive.
+ "nextPageToken": "A String", # The token to use to request the next page of results.
+ "items": [ # List of comments.
+ { # A JSON representation of a comment on a file in Google Drive.
+ "status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+ # - "open" - The comment is still open.
+ # - "resolved" - The comment has been resolved by one of its replies.
+ "selfLink": "A String", # A link back to this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "author": { # The JSON template for a user. # The user who wrote this comment.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+ "replies": [ # Replies to this post.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "context": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "commentId": "A String", # The ID of the comment.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "fileId": "A String", # The file which this comment is addressing.
+ },
+ ],
+ "kind": "drive#commentList", # This is always drive#commentList.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(fileId, commentId, body)
+ Updates an existing comment. This method supports patch semantics.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ commentId: string, The ID of the comment. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A JSON representation of a comment on a file in Google Drive.
+ "status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+ # - "open" - The comment is still open.
+ # - "resolved" - The comment has been resolved by one of its replies.
+ "selfLink": "A String", # A link back to this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "author": { # The JSON template for a user. # The user who wrote this comment.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+ "replies": [ # Replies to this post.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "context": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "commentId": "A String", # The ID of the comment.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "fileId": "A String", # The file which this comment is addressing.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a comment on a file in Google Drive.
+ "status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+ # - "open" - The comment is still open.
+ # - "resolved" - The comment has been resolved by one of its replies.
+ "selfLink": "A String", # A link back to this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "author": { # The JSON template for a user. # The user who wrote this comment.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+ "replies": [ # Replies to this post.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "context": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "commentId": "A String", # The ID of the comment.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "fileId": "A String", # The file which this comment is addressing.
+ }
+update(fileId, commentId, body)
+ Updates an existing comment.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ commentId: string, The ID of the comment. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A JSON representation of a comment on a file in Google Drive.
+ "status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+ # - "open" - The comment is still open.
+ # - "resolved" - The comment has been resolved by one of its replies.
+ "selfLink": "A String", # A link back to this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "author": { # The JSON template for a user. # The user who wrote this comment.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+ "replies": [ # Replies to this post.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "context": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "commentId": "A String", # The ID of the comment.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "fileId": "A String", # The file which this comment is addressing.
+ }
+
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a comment on a file in Google Drive.
+ "status": "", # The status of this comment. Status can be changed by posting a reply to a comment with the desired status.
+ # - "open" - The comment is still open.
+ # - "resolved" - The comment has been resolved by one of its replies.
+ "selfLink": "A String", # A link back to this comment.
+ "kind": "drive#comment", # This is always drive#comment.
+ "author": { # The JSON template for a user. # The user who wrote this comment.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this comment has been deleted. If a comment has been deleted the content will be cleared and this will only represent a comment that once existed.
+ "replies": [ # Replies to this post.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "htmlContent": "A String", # HTML formatted content for this comment.
+ "content": "A String", # The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content.
+ "modifiedDate": "A String", # The date when this comment or any of its replies were last modified.
+ "context": { # The context of the file which is being commented on.
+ "type": "A String", # The MIME type of the context snippet.
+ "value": "A String", # Data representation of the segment of the file being commented on. In the case of a text file for example, this would be the actual text that the comment is about.
+ },
+ "createdDate": "A String", # The date when this comment was first created.
+ "commentId": "A String", # The ID of the comment.
+ "anchor": "A String", # A region of the document represented as a JSON string. See anchor documentation for details on how to define and interpret anchor properties.
+ "fileTitle": "A String", # The title of the file which this comment is addressing.
+ "fileId": "A String", # The file which this comment is addressing.
+ }
+Returns the children Resource.
+
+ comments()
+
Returns the comments Resource.
+ @@ -109,6 +114,11 @@ h1, h2, h3 {Returns the permissions Resource.
+
+ replies()
+
Returns the replies Resource.
+ diff --git a/docs/dyn/drive_v2.replies.html b/docs/dyn/drive_v2.replies.html new file mode 100644 index 0000000..c4f3d4a --- /dev/null +++ b/docs/dyn/drive_v2.replies.html @@ -0,0 +1,374 @@ + + + +
+ delete(fileId, commentId, replyId)
Deletes a reply.
+
+ get(fileId, commentId, replyId, includeDeleted=None)
Gets a reply.
+
+ insert(fileId, commentId, body)
Creates a new reply to the given comment.
+
+ list(fileId, commentId, includeDeleted=None, pageToken=None, maxResults=None)
Lists all of the replies to a comment.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ patch(fileId, commentId, replyId, body)
Updates an existing reply. This method supports patch semantics.
+
+ update(fileId, commentId, replyId, body)
Updates an existing reply.
+delete(fileId, commentId, replyId)
+ Deletes a reply. + +Args: + fileId: string, The ID of the file. (required) + commentId: string, The ID of the comment. (required) + replyId: string, The ID of the reply. (required) ++
get(fileId, commentId, replyId, includeDeleted=None)
+ Gets a reply.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ commentId: string, The ID of the comment. (required)
+ replyId: string, The ID of the reply. (required)
+ includeDeleted: boolean, If set, this will succeed when retrieving a deleted reply.
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ }
+insert(fileId, commentId, body)
+ Creates a new reply to the given comment.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ commentId: string, The ID of the comment. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ }
+list(fileId, commentId, includeDeleted=None, pageToken=None, maxResults=None)
+ Lists all of the replies to a comment.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ commentId: string, The ID of the comment. (required)
+ includeDeleted: boolean, If set, all replies, including deleted replies (with content stripped) will be returned.
+ pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
+ maxResults: integer, The maximum number of replies to include in the response, used for paging.
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a list of replies to a comment on a file in Google Drive.
+ "nextPageToken": "A String", # The token to use to request the next page of results.
+ "items": [ # List of reply.
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ },
+ ],
+ "kind": "drive#commentReplyList", # This is always drive#commentReplyList.
+ }
+list_next(previous_request, previous_response)
+ Retrieves the next page of results. + +Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + +Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(fileId, commentId, replyId, body)
+ Updates an existing reply. This method supports patch semantics.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ commentId: string, The ID of the comment. (required)
+ replyId: string, The ID of the reply. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ }
+update(fileId, commentId, replyId, body)
+ Updates an existing reply.
+
+Args:
+ fileId: string, The ID of the file. (required)
+ commentId: string, The ID of the comment. (required)
+ replyId: string, The ID of the reply. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # A JSON representation of a reply to a comment on a file in Google Drive.
+ "kind": "drive#commentReply", # This is always drive#commentReply.
+ "author": { # The JSON template for a user. # The user who wrote this reply.
+ "picture": { # The user's profile picture.
+ "url": "A String", # A URL that points to a profile picture of this user.
+ },
+ "kind": "drive#user", # This is always drive#user.
+ "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user of which the request was made on behalf.
+ "displayName": "A String", # A plain text displayable name for this user.
+ },
+ "deleted": True or False, # Whether this reply has been deleted. If a reply has been deleted the content will be cleared and this will only represent a reply that once existed.
+ "htmlContent": "A String", # HTML formatted content for this reply.
+ "content": "A String", # The plain text content used to create this reply. This is not HTML safe and should only be used as a starting point to make edits to a reply's content. This field is required on inserts if no verb is specified (resolve/reopen).
+ "verb": "A String", # The action this reply performed to the parent comment. When creating a new reply this is the action to be perform to the parent comment. Possible values are:
+ # - "resolve" - To resolve a comment.
+ # - "reopen" - To reopen (un-resolve) a comment.
+ "replyId": "A String", # The ID of the reply.
+ "modifiedDate": "A String", # The date when this reply was last modified.
+ "createdDate": "A String", # The date when this reply was first created.
+ }
+Returns the text Resource.
+
+ topic()
+
Returns the topic Resource.
+
image(id, maxwidth=None, maxheight=None, fallbackid=None, pad=None, mode=None)
Returns the scaled/cropped image attached to a freebase node.
@@ -91,6 +96,12 @@ h1, h2, h3 {Performs MQL Queries.
+
+ mqlwrite(query, indent=None, callback=None, dateline=None, use_permission_of=None)
Performs MQL Write Operations.
+
+ mqlwrite_media(query, indent=None, callback=None, dateline=None, use_permission_of=None)
Performs MQL Write Operations.
image(id, maxwidth=None, maxheight=None, fallbackid=None, pad=None, mode=None)
@@ -172,4 +183,30 @@ Args:
mqlwrite(query, indent=None, callback=None, dateline=None, use_permission_of=None)
+ Performs MQL Write Operations. + +Args: + query: string, An MQL query with write directives. (required) + indent: integer, How many spaces to indent the json. + callback: string, JS method name for JSONP callbacks. + dateline: string, The dateline that you get in a mqlwrite response to ensure consistent results. + use_permission_of: string, Use the same permission node of the object with the specified id. ++
mqlwrite_media(query, indent=None, callback=None, dateline=None, use_permission_of=None)
+ Performs MQL Write Operations. + +Args: + query: string, An MQL query with write directives. (required) + indent: integer, How many spaces to indent the json. + callback: string, JS method name for JSONP callbacks. + dateline: string, The dateline that you get in a mqlwrite response to ensure consistent results. + use_permission_of: string, Use the same permission node of the object with the specified id. ++