Campaign Manager 360 API (dfareporting:v3.4)

2022-04-02

205 removed methods | Removed API

Deletions

    Methods
  • dfareporting.creativeGroups.list

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/creativeGroups

      Path: userprofiles/{profileId}/creativeGroups

      Description: Retrieves a list of creative groups, possibly filtered. This method supports paging.

      HTTP Method: GET

      Parameter Order: profileId

      Parameters:

        advertiserIds

          Repeated: Yes

          Format: int64

          Location: query

          Description: Select only creative groups that belong to these advertisers.

          Type: string

        groupNumber

          Description: Select only creative groups that belong to this subgroup.

          Type: integer

          Minimum: 1

          Maximum: 2

          Location: query

          Format: int32

        pageToken

          Type: string

          Location: query

          Description: Value of the nextPageToken from the previous result page.

        searchString

          Description: Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".

          Type: string

          Location: query

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

          Type: string

          Format: int64

        maxResults

          Location: query

          Description: Maximum number of results to return.

          Maximum: 1000

          Format: int32

          Type: integer

          Minimum: 0

          Default: 1000

        sortField

          Enum Descriptions:

        • Type: string

          Description: Field by which to sort the list.

          Default: ID

          Enum:

        • ID
        • NAME
        • Location: query

        ids

          Location: query

          Type: string

          Repeated: Yes

          Description: Select only creative groups with these IDs.

          Format: int64

        sortOrder

          Type: string

          Default: ASCENDING

          Location: query

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

  • dfareporting.creativeGroups.update

      Parameter Order: profileId

      Description: Updates an existing creative group.

      Path: userprofiles/{profileId}/creativeGroups

      HTTP Method: PUT

      Flat Path: userprofiles/{profileId}/creativeGroups

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

  • dfareporting.creativeGroups.insert

      HTTP Method: POST

      Path: userprofiles/{profileId}/creativeGroups

      Description: Inserts a new creative group.

      Flat Path: userprofiles/{profileId}/creativeGroups

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Parameters:

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

          Format: int64

  • dfareporting.creativeGroups.patch

      HTTP Method: PATCH

      Description: Updates an existing creative group. This method supports patch semantics.

      Parameter Order:

    • profileId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

        id

          Required: Yes

          Location: query

          Description: CreativeGroup ID.

          Type: string

          Format: int64

      Flat Path: userprofiles/{profileId}/creativeGroups

      Path: userprofiles/{profileId}/creativeGroups

  • dfareporting.creativeGroups.get

      Parameters:

        id

          Format: int64

          Location: path

          Type: string

          Description: Creative group ID.

          Required: Yes

        profileId

          Format: int64

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

          Location: path

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Gets one creative group by ID.

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/creativeGroups/{id}

      Flat Path: userprofiles/{profileId}/creativeGroups/{id}

  • dfareporting.cities.list

      Path: userprofiles/{profileId}/cities

      Parameters:

        regionDartIds

          Description: Select only cities from these regions.

          Format: int64

          Location: query

          Type: string

          Repeated: Yes

        namePrefix

          Type: string

          Description: Select only cities with names starting with this prefix.

          Location: query

        countryDartIds

          Description: Select only cities from these countries.

          Location: query

          Type: string

          Format: int64

          Repeated: Yes

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

          Type: string

        dartIds

          Description: Select only cities with these DART IDs.

          Type: string

          Location: query

          Repeated: Yes

          Format: int64

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/cities

      Parameter Order: profileId

      HTTP Method: GET

      Description: Retrieves a list of cities, possibly filtered.

  • dfareporting.campaignCreativeAssociations.insert

      Flat Path: userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations

      Description: Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations

      Parameter Order:

    • profileId
    • campaignId
    • HTTP Method: POST

      Parameters:

        campaignId

          Type: string

          Description: Campaign ID in this association.

          Location: path

          Required: Yes

          Format: int64

        profileId

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

  • dfareporting.campaignCreativeAssociations.list

      Parameters:

        pageToken

          Description: Value of the nextPageToken from the previous result page.

          Location: query

          Type: string

        sortOrder

          Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

          Type: string

          Enum Descriptions:

        • Location: query

          Default: ASCENDING

        maxResults

          Location: query

          Format: int32

          Description: Maximum number of results to return.

          Type: integer

          Maximum: 1000

          Default: 1000

          Minimum: 0

        campaignId

          Required: Yes

          Format: int64

          Description: Campaign ID in this association.

          Location: path

          Type: string

        profileId

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

      Description: Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.

      Parameter Order:

    • profileId
    • campaignId
    • HTTP Method: GET

      Path: userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations

  • dfareporting.regions.list

      Parameters:

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

          Location: path

      Path: userprofiles/{profileId}/regions

      Description: Retrieves a list of regions.

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/regions

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

  • dfareporting.remarketingLists.insert

      Path: userprofiles/{profileId}/remarketingLists

      Description: Inserts a new remarketing list.

      HTTP Method: POST

      Flat Path: userprofiles/{profileId}/remarketingLists

      Parameter Order: profileId

      Parameters:

        profileId

          Type: string

          Format: int64

          Required: Yes

          Description: User profile ID associated with this request.

          Location: path

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.remarketingLists.list

      Flat Path: userprofiles/{profileId}/remarketingLists

      HTTP Method: GET

      Description: Retrieves a list of remarketing lists, possibly filtered. This method supports paging.

      Parameters:

        pageToken

          Location: query

          Description: Value of the nextPageToken from the previous result page.

          Type: string

        sortField

          Enum Descriptions:

        • Location: query

          Enum:

        • ID
        • NAME
        • Default: ID

          Type: string

          Description: Field by which to sort the list.

        advertiserId

          Type: string

          Required: Yes

          Location: query

          Description: Select only remarketing lists owned by this advertiser.

          Format: int64

        name

          Type: string

          Location: query

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".

        sortOrder

          Enum Descriptions:

        • Location: query

          Default: ASCENDING

          Type: string

          Description: Order of sorted results.

          Enum:

        • ASCENDING
        • DESCENDING

        floodlightActivityId

          Type: string

          Description: Select only remarketing lists that have this floodlight activity ID.

          Format: int64

          Location: query

        active

          Type: boolean

          Location: query

          Description: Select only active or only inactive remarketing lists.

        maxResults

          Minimum: 0

          Location: query

          Format: int32

          Type: integer

          Maximum: 1000

          Default: 1000

          Description: Maximum number of results to return.

        profileId

          Location: path

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

      Path: userprofiles/{profileId}/remarketingLists

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • advertiserId
  • dfareporting.remarketingLists.patch

      Description: Updates an existing remarketing list. This method supports patch semantics.

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/remarketingLists

      Path: userprofiles/{profileId}/remarketingLists

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: PATCH

      Parameters:

        profileId

          Location: path

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

        id

          Location: query

          Required: Yes

          Format: int64

          Description: RemarketingList ID.

          Type: string

  • dfareporting.remarketingLists.get

      Flat Path: userprofiles/{profileId}/remarketingLists/{id}

      Parameters:

        id

          Required: Yes

          Description: Remarketing list ID.

          Location: path

          Format: int64

          Type: string

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

          Required: Yes

          Location: path

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

      Description: Gets one remarketing list by ID.

      Path: userprofiles/{profileId}/remarketingLists/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.remarketingLists.update

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/remarketingLists

      Path: userprofiles/{profileId}/remarketingLists

      HTTP Method: PUT

      Parameters:

        profileId

          Location: path

          Type: string

          Format: int64

          Required: Yes

          Description: User profile ID associated with this request.

      Description: Updates an existing remarketing list.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.floodlightActivityGroups.list

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/floodlightActivityGroups

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/floodlightActivityGroups

      Description: Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.

      Parameters:

        ids

          Type: string

          Description: Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.

          Repeated: Yes

          Location: query

          Format: int64

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

        sortOrder

          Enum Descriptions:

        • Default: ASCENDING

          Type: string

          Location: query

          Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

        searchString

          Location: query

          Type: string

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".

        advertiserId

          Format: int64

          Type: string

          Location: query

          Description: Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.

        profileId

          Location: path

          Type: string

          Format: int64

          Required: Yes

          Description: User profile ID associated with this request.

        floodlightConfigurationId

          Type: string

          Format: int64

          Description: Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.

          Location: query

        type

          Type: string

          Enum:

        • COUNTER
        • SALE
        • Enum Descriptions:

        • Description: Select only floodlight activity groups with the specified floodlight activity group type.

          Location: query

        sortField

          Location: query

          Enum:

        • ID
        • NAME
        • Default: ID

          Description: Field by which to sort the list.

          Enum Descriptions:

        • Type: string

        maxResults

          Description: Maximum number of results to return.

          Maximum: 1000

          Format: int32

          Minimum: 0

          Default: 1000

          Location: query

          Type: integer

      HTTP Method: GET

  • dfareporting.floodlightActivityGroups.patch

      HTTP Method: PATCH

      Path: userprofiles/{profileId}/floodlightActivityGroups

      Description: Updates an existing floodlight activity group. This method supports patch semantics.

      Parameter Order:

    • profileId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

          Format: int64

        id

          Type: string

          Location: query

          Description: FloodlightActivityGroup ID.

          Format: int64

          Required: Yes

      Flat Path: userprofiles/{profileId}/floodlightActivityGroups

  • dfareporting.floodlightActivityGroups.update

      Path: userprofiles/{profileId}/floodlightActivityGroups

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/floodlightActivityGroups

      HTTP Method: PUT

      Parameter Order: profileId

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

          Type: string

          Location: path

      Description: Updates an existing floodlight activity group.

  • dfareporting.floodlightActivityGroups.get

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/floodlightActivityGroups/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/floodlightActivityGroups/{id}

      Description: Gets one floodlight activity group by ID.

      Parameters:

        profileId

          Required: Yes

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

          Type: string

        id

          Required: Yes

          Description: Floodlight activity Group ID.

          Format: int64

          Location: path

          Type: string

  • dfareporting.floodlightActivityGroups.insert

      Flat Path: userprofiles/{profileId}/floodlightActivityGroups

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Inserts a new floodlight activity group.

      HTTP Method: POST

      Parameters:

        profileId

          Required: Yes

          Description: User profile ID associated with this request.

          Location: path

          Type: string

          Format: int64

      Path: userprofiles/{profileId}/floodlightActivityGroups

      Parameter Order: profileId

  • dfareporting.accountActiveAdSummaries.get

      Path: userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}

      Flat Path: userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • summaryAccountId
    • HTTP Method: GET

      Parameters:

        summaryAccountId

          Type: string

          Description: Account ID.

          Location: path

          Required: Yes

          Format: int64

        profileId

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

          Type: string

          Required: Yes

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

  • dfareporting.creativeFieldValues.insert

      Description: Inserts a new creative field value.

      Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: POST

      Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

      Parameters:

        creativeFieldId

          Required: Yes

          Type: string

          Location: path

          Description: Creative field ID for this creative field value.

          Format: int64

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Location: path

          Required: Yes

          Type: string

      Parameter Order:

    • profileId
    • creativeFieldId
  • dfareporting.creativeFieldValues.patch

      Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

      Parameters:

        profileId

          Required: Yes

          Description: User profile ID associated with this request.

          Format: int64

          Type: string

          Location: path

        id

          Required: Yes

          Format: int64

          Description: CreativeFieldValue ID.

          Type: string

          Location: query

        creativeFieldId

          Type: string

          Description: CreativeField ID.

          Location: path

          Required: Yes

          Format: int64

      Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

      Description: Updates an existing creative field value. This method supports patch semantics.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • creativeFieldId
    • id
    • HTTP Method: PATCH

  • dfareporting.creativeFieldValues.update

      Parameters:

        creativeFieldId

          Description: Creative field ID for this creative field value.

          Location: path

          Required: Yes

          Format: int64

          Type: string

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Required: Yes

          Type: string

          Location: path

      Parameter Order:

    • profileId
    • creativeFieldId
    • Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Updates an existing creative field value.

      HTTP Method: PUT

      Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

  • dfareporting.creativeFieldValues.delete

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}

      Parameter Order:

    • profileId
    • creativeFieldId
    • id
    • Description: Deletes an existing creative field value.

      HTTP Method: DELETE

      Parameters:

        profileId

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

        id

          Location: path

          Description: Creative Field Value ID

          Type: string

          Required: Yes

          Format: int64

        creativeFieldId

          Required: Yes

          Type: string

          Format: int64

          Location: path

          Description: Creative field ID for this creative field value.

      Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}

  • dfareporting.creativeFieldValues.get

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}

      Description: Gets one creative field value by ID.

      Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}

      Parameters:

        profileId

          Format: int64

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

          Type: string

        creativeFieldId

          Format: int64

          Description: Creative field ID for this creative field value.

          Location: path

          Required: Yes

          Type: string

        id

          Type: string

          Required: Yes

          Format: int64

          Description: Creative Field Value ID

          Location: path

      Parameter Order:

    • profileId
    • creativeFieldId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.creativeFieldValues.list

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • creativeFieldId
    • Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

      Description: Retrieves a list of creative field values, possibly filtered. This method supports paging.

      Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues

      Parameters:

        sortOrder

          Default: ASCENDING

          Description: Order of sorted results.

          Type: string

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING
        • Location: query

        maxResults

          Format: int32

          Default: 1000

          Type: integer

          Location: query

          Maximum: 1000

          Description: Maximum number of results to return.

          Minimum: 0

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

        creativeFieldId

          Description: Creative field ID for this creative field value.

          Required: Yes

          Format: int64

          Type: string

          Location: path

        ids

          Format: int64

          Description: Select only creative field values with these IDs.

          Location: query

          Type: string

          Repeated: Yes

        sortField

          Default: ID

          Enum:

        • ID
        • VALUE
        • Type: string

          Description: Field by which to sort the list.

          Enum Descriptions:

        • Location: query

        profileId

          Type: string

          Location: path

          Format: int64

          Required: Yes

          Description: User profile ID associated with this request.

        searchString

          Type: string

          Description: Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.

          Location: query

      HTTP Method: GET

  • dfareporting.customEvents.batchinsert

      Scopes: https://www.googleapis.com/auth/ddmconversions

      Parameter Order: profileId

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

          Location: path

          Required: Yes

      Description: Inserts custom events.

      Path: userprofiles/{profileId}/customEvents/batchinsert

      HTTP Method: POST

      Flat Path: userprofiles/{profileId}/customEvents/batchinsert

  • dfareporting.userRoles.get

      Path: userprofiles/{profileId}/userRoles/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Gets one user role by ID.

      Parameters:

        id

          Location: path

          Type: string

          Description: User role ID.

          Required: Yes

          Format: int64

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Location: path

          Type: string

          Required: Yes

      Flat Path: userprofiles/{profileId}/userRoles/{id}

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

  • dfareporting.userRoles.update

      Description: Updates an existing user role.

      HTTP Method: PUT

      Path: userprofiles/{profileId}/userRoles

      Parameters:

        profileId

          Type: string

          Format: int64

          Location: path

          Description: User profile ID associated with this request.

          Required: Yes

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/userRoles

  • dfareporting.userRoles.patch

      Path: userprofiles/{profileId}/userRoles

      Flat Path: userprofiles/{profileId}/userRoles

      HTTP Method: PATCH

      Description: Updates an existing user role. This method supports patch semantics.

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Type: string

          Location: path

          Description: User profile ID associated with this request.

        id

          Description: UserRole ID.

          Location: query

          Required: Yes

          Type: string

          Format: int64

      Parameter Order:

    • profileId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.userRoles.insert

      Path: userprofiles/{profileId}/userRoles

      Parameters:

        profileId

          Location: path

          Required: Yes

          Description: User profile ID associated with this request.

          Format: int64

          Type: string

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/userRoles

      HTTP Method: POST

      Description: Inserts a new user role.

  • dfareporting.userRoles.delete

      Parameters:

        profileId

          Format: int64

          Location: path

          Description: User profile ID associated with this request.

          Type: string

          Required: Yes

        id

          Format: int64

          Description: User role ID.

          Required: Yes

          Type: string

          Location: path

      HTTP Method: DELETE

      Flat Path: userprofiles/{profileId}/userRoles/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/userRoles/{id}

      Description: Deletes an existing user role.

      Parameter Order:

    • profileId
    • id
  • dfareporting.userRoles.list

      Flat Path: userprofiles/{profileId}/userRoles

      HTTP Method: GET

      Description: Retrieves a list of user roles, possibly filtered. This method supports paging.

      Parameter Order: profileId

      Parameters:

        subaccountId

          Location: query

          Format: int64

          Type: string

          Description: Select only user roles that belong to this subaccount.

        searchString

          Type: string

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".

          Location: query

        ids

          Repeated: Yes

          Type: string

          Description: Select only user roles with the specified IDs.

          Format: int64

          Location: query

        pageToken

          Description: Value of the nextPageToken from the previous result page.

          Location: query

          Type: string

        maxResults

          Default: 1000

          Maximum: 1000

          Location: query

          Type: integer

          Description: Maximum number of results to return.

          Minimum: 0

          Format: int32

        sortOrder

          Location: query

          Enum:

        • ASCENDING
        • DESCENDING
        • Default: ASCENDING

          Enum Descriptions:

        • Description: Order of sorted results.

          Type: string

        sortField

          Default: ID

          Description: Field by which to sort the list.

          Enum:

        • ID
        • NAME
        • Location: query

          Type: string

          Enum Descriptions:

        accountUserRoleOnly

          Location: query

          Type: boolean

          Description: Select only account level user roles not associated with any specific subaccount.

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

          Location: path

          Type: string

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/userRoles

  • dfareporting.sites.list

      Parameter Order: profileId

      Path: userprofiles/{profileId}/sites

      HTTP Method: GET

      Parameters:

        campaignIds

          Location: query

          Format: int64

          Repeated: Yes

          Type: string

          Description: Select only sites with these campaign IDs.

        directorySiteIds

          Repeated: Yes

          Description: Select only sites with these directory site IDs.

          Location: query

          Type: string

          Format: int64

        unmappedSite

          Location: query

          Type: boolean

          Description: Select only sites that have not been mapped to a directory site.

        acceptsPublisherPaidPlacements

          Description: Select only sites that accept publisher paid placements.

          Type: boolean

          Location: query

        maxResults

          Maximum: 1000

          Default: 1000

          Minimum: 0

          Type: integer

          Format: int32

          Description: Maximum number of results to return.

          Location: query

        profileId

          Type: string

          Format: int64

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

        acceptsInterstitialPlacements

          Description: This search filter is no longer supported and will have no effect on the results returned.

          Type: boolean

          Location: query

        sortField

          Enum:

        • ID
        • NAME
        • Enum Descriptions:

        • Description: Field by which to sort the list.

          Type: string

          Default: ID

          Location: query

        approved

          Description: Select only approved sites.

          Type: boolean

          Location: query

        sortOrder

          Description: Order of sorted results.

          Default: ASCENDING

          Enum Descriptions:

        • Type: string

          Enum:

        • ASCENDING
        • DESCENDING
        • Location: query

        searchString

          Location: query

          Description: Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".

          Type: string

        adWordsSite

          Description: Select only AdWords sites.

          Location: query

          Type: boolean

        acceptsInStreamVideoPlacements

          Type: boolean

          Description: This search filter is no longer supported and will have no effect on the results returned.

          Location: query

        ids

          Location: query

          Type: string

          Repeated: Yes

          Format: int64

          Description: Select only sites with these IDs.

        subaccountId

          Type: string

          Format: int64

          Location: query

          Description: Select only sites with this subaccount ID.

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

      Flat Path: userprofiles/{profileId}/sites

      Description: Retrieves a list of sites, possibly filtered. This method supports paging.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.sites.get

      Description: Gets one site by ID.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        id

          Location: path

          Format: int64

          Required: Yes

          Description: Site ID.

          Type: string

        profileId

          Required: Yes

          Type: string

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

      Flat Path: userprofiles/{profileId}/sites/{id}

      Path: userprofiles/{profileId}/sites/{id}

      HTTP Method: GET

      Parameter Order:

    • profileId
    • id
  • dfareporting.sites.insert

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/sites

      Path: userprofiles/{profileId}/sites

      Parameters:

        profileId

          Type: string

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

      HTTP Method: POST

      Parameter Order: profileId

      Description: Inserts a new site.

  • dfareporting.sites.patch

      Flat Path: userprofiles/{profileId}/sites

      Parameter Order:

    • profileId
    • id
    • HTTP Method: PATCH

      Description: Updates an existing site. This method supports patch semantics.

      Path: userprofiles/{profileId}/sites

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Required: Yes

          Location: path

          Type: string

        id

          Description: Site ID.

          Required: Yes

          Type: string

          Location: query

          Format: int64

  • dfareporting.sites.update

      Parameter Order: profileId

      Path: userprofiles/{profileId}/sites

      HTTP Method: PUT

      Description: Updates an existing site.

      Parameters:

        profileId

          Type: string

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

          Required: Yes

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/sites

  • dfareporting.subaccounts.get

      HTTP Method: GET

      Description: Gets one subaccount by ID.

      Parameter Order:

    • profileId
    • id
    • Parameters:

        id

          Location: path

          Required: Yes

          Description: Subaccount ID.

          Format: int64

          Type: string

        profileId

          Type: string

          Required: Yes

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

      Path: userprofiles/{profileId}/subaccounts/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/subaccounts/{id}

  • dfareporting.subaccounts.update

      Flat Path: userprofiles/{profileId}/subaccounts

      Description: Updates an existing subaccount.

      HTTP Method: PUT

      Parameter Order: profileId

      Parameters:

        profileId

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

          Location: path

          Format: int64

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/subaccounts

  • dfareporting.subaccounts.patch

      Flat Path: userprofiles/{profileId}/subaccounts

      HTTP Method: PATCH

      Path: userprofiles/{profileId}/subaccounts

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Location: path

          Required: Yes

          Format: int64

        id

          Type: string

          Format: int64

          Required: Yes

          Description: Subaccount ID.

          Location: query

      Parameter Order:

    • profileId
    • id
    • Description: Updates an existing subaccount. This method supports patch semantics.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.subaccounts.list

      Description: Gets a list of subaccounts, possibly filtered. This method supports paging.

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Location: path

          Type: string

          Description: User profile ID associated with this request.

        sortOrder

          Description: Order of sorted results.

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING
        • Type: string

          Default: ASCENDING

          Location: query

        searchString

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" .

          Location: query

          Type: string

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

        ids

          Type: string

          Description: Select only subaccounts with these IDs.

          Format: int64

          Repeated: Yes

          Location: query

        maxResults

          Description: Maximum number of results to return.

          Maximum: 1000

          Minimum: 0

          Type: integer

          Location: query

          Format: int32

          Default: 1000

        sortField

          Location: query

          Enum Descriptions:

        • Enum:

        • ID
        • NAME
        • Type: string

          Description: Field by which to sort the list.

          Default: ID

      Flat Path: userprofiles/{profileId}/subaccounts

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/subaccounts

      HTTP Method: GET

  • dfareporting.subaccounts.insert

      Parameter Order: profileId

      Description: Inserts a new subaccount.

      Parameters:

        profileId

          Type: string

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

      Flat Path: userprofiles/{profileId}/subaccounts

      Path: userprofiles/{profileId}/subaccounts

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: POST

  • dfareporting.remarketingListShares.get

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Gets one remarketing list share by remarketing list ID.

      Flat Path: userprofiles/{profileId}/remarketingListShares/{remarketingListId}

      Path: userprofiles/{profileId}/remarketingListShares/{remarketingListId}

      Parameter Order:

    • profileId
    • remarketingListId
    • HTTP Method: GET

      Parameters:

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

          Required: Yes

        remarketingListId

          Required: Yes

          Description: Remarketing list ID.

          Format: int64

          Type: string

          Location: path

  • dfareporting.remarketingListShares.patch

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        id

          Required: Yes

          Type: string

          Format: int64

          Location: query

          Description: RemarketingList ID.

        profileId

          Required: Yes

          Description: User profile ID associated with this request.

          Format: int64

          Type: string

          Location: path

      Flat Path: userprofiles/{profileId}/remarketingListShares

      Parameter Order:

    • profileId
    • id
    • HTTP Method: PATCH

      Path: userprofiles/{profileId}/remarketingListShares

      Description: Updates an existing remarketing list share. This method supports patch semantics.

  • dfareporting.remarketingListShares.update

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      HTTP Method: PUT

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

          Format: int64

          Type: string

      Flat Path: userprofiles/{profileId}/remarketingListShares

      Path: userprofiles/{profileId}/remarketingListShares

      Description: Updates an existing remarketing list share.

  • dfareporting.advertiserLandingPages.update

      HTTP Method: PUT

      Parameter Order: profileId

      Parameters:

        profileId

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

      Path: userprofiles/{profileId}/advertiserLandingPages

      Flat Path: userprofiles/{profileId}/advertiserLandingPages

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Updates an existing landing page.

  • dfareporting.advertiserLandingPages.list

      Path: userprofiles/{profileId}/advertiserLandingPages

      Flat Path: userprofiles/{profileId}/advertiserLandingPages

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Retrieves a list of landing pages.

      HTTP Method: GET

      Parameters:

        maxResults

          Minimum: 0

          Format: int32

          Description: Maximum number of results to return.

          Location: query

          Default: 1000

          Type: integer

          Maximum: 1000

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

          Type: string

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

        searchString

          Location: query

          Description: Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".

          Type: string

        archived

          Type: boolean

          Description: Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.

          Location: query

        sortField

          Location: query

          Type: string

          Description: Field by which to sort the list.

          Default: ID

          Enum:

        • ID
        • NAME
        • Enum Descriptions:

        sortOrder

          Location: query

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING
        • Type: string

          Default: ASCENDING

          Description: Order of sorted results.

        ids

          Description: Select only landing pages with these IDs.

          Repeated: Yes

          Type: string

          Format: int64

          Location: query

        advertiserIds

          Type: string

          Format: int64

          Location: query

          Description: Select only landing pages that belong to these advertisers.

          Repeated: Yes

        campaignIds

          Type: string

          Format: int64

          Repeated: Yes

          Location: query

          Description: Select only landing pages that are associated with these campaigns.

        subaccountId

          Format: int64

          Type: string

          Location: query

          Description: Select only landing pages that belong to this subaccount.

      Parameter Order: profileId

  • dfareporting.advertiserLandingPages.get

      Flat Path: userprofiles/{profileId}/advertiserLandingPages/{id}

      HTTP Method: GET

      Parameter Order:

    • profileId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/advertiserLandingPages/{id}

      Parameters:

        id

          Format: int64

          Description: Landing page ID.

          Location: path

          Type: string

          Required: Yes

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Location: path

          Type: string

          Required: Yes

      Description: Gets one landing page by ID.

  • dfareporting.advertiserLandingPages.insert

      Parameters:

        profileId

          Type: string

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

      Flat Path: userprofiles/{profileId}/advertiserLandingPages

      Parameter Order: profileId

      Description: Inserts a new landing page.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/advertiserLandingPages

      HTTP Method: POST

  • dfareporting.advertiserLandingPages.patch

      Parameters:

        profileId

          Format: int64

          Location: path

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

        id

          Type: string

          Location: query

          Required: Yes

          Description: LandingPage ID.

          Format: int64

      Path: userprofiles/{profileId}/advertiserLandingPages

      Parameter Order:

    • profileId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

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

      Flat Path: userprofiles/{profileId}/advertiserLandingPages

      HTTP Method: PATCH

  • dfareporting.userProfiles.get

  • dfareporting.userProfiles.list

  • dfareporting.connectionTypes.list

      Flat Path: userprofiles/{profileId}/connectionTypes

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

      Description: Retrieves a list of connection types.

      Path: userprofiles/{profileId}/connectionTypes

      HTTP Method: GET

  • dfareporting.connectionTypes.get

      HTTP Method: GET

      Description: Gets one connection type by ID.

      Flat Path: userprofiles/{profileId}/connectionTypes/{id}

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

          Location: path

          Type: string

        id

          Format: int64

          Location: path

          Description: Connection type ID.

          Required: Yes

          Type: string

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/connectionTypes/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.countries.list

      Flat Path: userprofiles/{profileId}/countries

      Parameter Order: profileId

      HTTP Method: GET

      Path: userprofiles/{profileId}/countries

      Parameters:

        profileId

          Type: string

          Format: int64

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

      Description: Retrieves a list of countries.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.countries.get

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Gets one country by ID.

      Path: userprofiles/{profileId}/countries/{dartId}

      Parameters:

        dartId

          Format: int64

          Description: Country DART ID.

          Location: path

          Required: Yes

          Type: string

        profileId

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

      Flat Path: userprofiles/{profileId}/countries/{dartId}

      HTTP Method: GET

      Parameter Order:

    • profileId
    • dartId
  • dfareporting.dimensionValues.query

      HTTP Method: POST

      Description: Retrieves list of report dimension values for a list of filters.

      Path: userprofiles/{profileId}/dimensionvalues/query

      Parameters:

        pageToken

          Location: query

          Description: The value of the nextToken from the previous result page.

          Type: string

        maxResults

          Description: Maximum number of results to return.

          Minimum: 0

          Format: int32

          Type: integer

          Location: query

          Maximum: 100

          Default: 100

        profileId

          Description: The Campaign Manager 360 user profile ID.

          Type: string

          Location: path

          Required: Yes

          Format: int64

      Flat Path: userprofiles/{profileId}/dimensionvalues/query

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfareporting

  • dfareporting.advertisers.insert

      Description: Inserts a new advertiser.

      Parameters:

        profileId

          Location: path

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

      Path: userprofiles/{profileId}/advertisers

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/advertisers

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: POST

  • dfareporting.advertisers.get

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/advertisers/{id}

      Path: userprofiles/{profileId}/advertisers/{id}

      Parameters:

        profileId

          Format: int64

          Type: string

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

        id

          Description: Advertiser ID.

          Type: string

          Format: int64

          Location: path

          Required: Yes

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Gets one advertiser by ID.

      HTTP Method: GET

  • dfareporting.advertisers.patch

      Parameters:

        id

          Description: Advertiser ID.

          Type: string

          Required: Yes

          Format: int64

          Location: query

        profileId

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

      Path: userprofiles/{profileId}/advertisers

      Description: Updates an existing advertiser. This method supports patch semantics.

      HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/advertisers

  • dfareporting.advertisers.update

      Description: Updates an existing advertiser.

      HTTP Method: PUT

      Path: userprofiles/{profileId}/advertisers

      Parameters:

        profileId

          Format: int64

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

          Type: string

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/advertisers

  • dfareporting.advertisers.list

      Path: userprofiles/{profileId}/advertisers

      Parameters:

        floodlightConfigurationIds

          Repeated: Yes

          Format: int64

          Location: query

          Type: string

          Description: Select only advertisers with these floodlight configuration IDs.

        onlyParent

          Type: boolean

          Location: query

          Description: Select only advertisers which use another advertiser's floodlight configuration.

        maxResults

          Type: integer

          Minimum: 0

          Default: 1000

          Format: int32

          Maximum: 1000

          Description: Maximum number of results to return.

          Location: query

        profileId

          Location: path

          Format: int64

          Type: string

          Required: Yes

          Description: User profile ID associated with this request.

        subaccountId

          Format: int64

          Type: string

          Location: query

          Description: Select only advertisers with these subaccount IDs.

        pageToken

          Location: query

          Type: string

          Description: Value of the nextPageToken from the previous result page.

        searchString

          Location: query

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" .

          Type: string

        sortField

          Location: query

          Type: string

          Enum:

        • ID
        • NAME
        • Default: ID

          Description: Field by which to sort the list.

          Enum Descriptions:

        status

          Description: Select only advertisers with the specified status.

          Enum:

        • APPROVED
        • ON_HOLD
        • Location: query

          Enum Descriptions:

        • Type: string

        ids

          Description: Select only advertisers with these IDs.

          Repeated: Yes

          Format: int64

          Type: string

          Location: query

        includeAdvertisersWithoutGroupsOnly

          Description: Select only advertisers which do not belong to any advertiser group.

          Location: query

          Type: boolean

        advertiserGroupIds

          Repeated: Yes

          Location: query

          Format: int64

          Description: Select only advertisers with these advertiser group IDs.

          Type: string

        sortOrder

          Default: ASCENDING

          Enum Descriptions:

        • Description: Order of sorted results.

          Type: string

          Location: query

          Enum:

        • ASCENDING
        • DESCENDING

      HTTP Method: GET

      Parameter Order: profileId

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

      Flat Path: userprofiles/{profileId}/advertisers

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.platformTypes.get

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

      Flat Path: userprofiles/{profileId}/platformTypes/{id}

      Parameters:

        id

          Location: path

          Required: Yes

          Format: int64

          Description: Platform type ID.

          Type: string

        profileId

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

          Location: path

      Path: userprofiles/{profileId}/platformTypes/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Gets one platform type by ID.

  • dfareporting.platformTypes.list

      Path: userprofiles/{profileId}/platformTypes

      Flat Path: userprofiles/{profileId}/platformTypes

      HTTP Method: GET

      Description: Retrieves a list of platform types.

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Format: int64

          Type: string

          Required: Yes

          Description: User profile ID associated with this request.

          Location: path

  • dfareporting.videoFormats.get

      Description: Gets one video format by ID.

      Path: userprofiles/{profileId}/videoFormats/{id}

      Flat Path: userprofiles/{profileId}/videoFormats/{id}

      Parameters:

        id

          Location: path

          Description: Video format ID.

          Format: int32

          Type: integer

          Required: Yes

        profileId

          Location: path

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

          Type: string

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.videoFormats.list

      Path: userprofiles/{profileId}/videoFormats

      HTTP Method: GET

      Parameters:

        profileId

          Location: path

          Description: User profile ID associated with this request.

          Type: string

          Required: Yes

          Format: int64

      Description: Lists available video formats.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/videoFormats

  • dfareporting.placementGroups.insert

      Flat Path: userprofiles/{profileId}/placementGroups

      Description: Inserts a new placement group.

      Path: userprofiles/{profileId}/placementGroups

      Parameters:

        profileId

          Required: Yes

          Type: string

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

      Parameter Order: profileId

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.placementGroups.get

      Description: Gets one placement group by ID.

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/placementGroups/{id}

      Flat Path: userprofiles/{profileId}/placementGroups/{id}

      Parameters:

        profileId

          Location: path

          Description: User profile ID associated with this request.

          Type: string

          Required: Yes

          Format: int64

        id

          Type: string

          Format: int64

          Required: Yes

          Location: path

          Description: Placement group ID.

  • dfareporting.placementGroups.list

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Description: Retrieves a list of placement groups, possibly filtered. This method supports paging.

      Parameters:

        campaignIds

          Repeated: Yes

          Description: Select only placement groups that belong to these campaigns.

          Location: query

          Format: int64

          Type: string

        maxStartDate

          Description: Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

          Location: query

          Type: string

        sortField

          Enum Descriptions:

        • Type: string

          Enum:

        • ID
        • NAME
        • Description: Field by which to sort the list.

          Location: query

          Default: ID

        pageToken

          Location: query

          Description: Value of the nextPageToken from the previous result page.

          Type: string

        archived

          Description: Select only archived placements. Don't set this field to select both archived and non-archived placements.

          Type: boolean

          Location: query

        minEndDate

          Description: Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

          Location: query

          Type: string

        contentCategoryIds

          Location: query

          Type: string

          Repeated: Yes

          Format: int64

          Description: Select only placement groups that are associated with these content categories.

        placementStrategyIds

          Location: query

          Type: string

          Repeated: Yes

          Format: int64

          Description: Select only placement groups that are associated with these placement strategies.

        placementGroupType

          Description: Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.

          Location: query

          Enum Descriptions:

        • Type: string

          Enum:

        • PLACEMENT_PACKAGE
        • PLACEMENT_ROADBLOCK

        searchString

          Type: string

          Location: query

          Description: Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".

        directorySiteIds

          Location: query

          Type: string

          Repeated: Yes

          Format: int64

          Description: Select only placement groups that are associated with these directory sites.

        maxResults

          Type: integer

          Description: Maximum number of results to return.

          Format: int32

          Minimum: 0

          Location: query

          Default: 800

          Maximum: 800

        pricingTypes

          Enum Descriptions:

        • Repeated: Yes

          Type: string

          Enum:

        • PRICING_TYPE_CPM
        • PRICING_TYPE_CPC
        • PRICING_TYPE_CPA
        • PRICING_TYPE_FLAT_RATE_IMPRESSIONS
        • PRICING_TYPE_FLAT_RATE_CLICKS
        • PRICING_TYPE_CPM_ACTIVEVIEW
        • Location: query

          Description: Select only placement groups with these pricing types.

        maxEndDate

          Description: Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

          Location: query

          Type: string

        minStartDate

          Description: Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

          Type: string

          Location: query

        siteIds

          Type: string

          Description: Select only placement groups that are associated with these sites.

          Repeated: Yes

          Location: query

          Format: int64

        profileId

          Format: int64

          Location: path

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

        ids

          Format: int64

          Location: query

          Type: string

          Repeated: Yes

          Description: Select only placement groups with these IDs.

        advertiserIds

          Description: Select only placement groups that belong to these advertisers.

          Repeated: Yes

          Location: query

          Type: string

          Format: int64

        sortOrder

          Default: ASCENDING

          Enum:

        • ASCENDING
        • DESCENDING
        • Type: string

          Enum Descriptions:

        • Location: query

          Description: Order of sorted results.

      Path: userprofiles/{profileId}/placementGroups

      Flat Path: userprofiles/{profileId}/placementGroups

      HTTP Method: GET

  • dfareporting.placementGroups.patch

      Flat Path: userprofiles/{profileId}/placementGroups

      Path: userprofiles/{profileId}/placementGroups

      HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • id
    • Parameters:

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Format: int64

          Location: path

          Required: Yes

        id

          Required: Yes

          Format: int64

          Location: query

          Description: PlacementGroup ID.

          Type: string

      Description: Updates an existing placement group. This method supports patch semantics.

  • dfareporting.placementGroups.update

      Description: Updates an existing placement group.

      Parameters:

        profileId

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Format: int64

          Location: path

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/placementGroups

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/placementGroups

      HTTP Method: PUT

  • dfareporting.floodlightActivities.generatetag

      Description: Generates a tag for a floodlight activity.

      Flat Path: userprofiles/{profileId}/floodlightActivities/generatetag

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/floodlightActivities/generatetag

      Parameter Order: profileId

      Parameters:

        profileId

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

        floodlightActivityId

          Location: query

          Description: Floodlight activity ID for which we want to generate a tag.

          Format: int64

          Type: string

  • dfareporting.floodlightActivities.list

      Path: userprofiles/{profileId}/floodlightActivities

      Description: Retrieves a list of floodlight activities, possibly filtered. This method supports paging.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/floodlightActivities

      Parameters:

        advertiserId

          Description: Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

          Type: string

          Format: int64

          Location: query

        floodlightActivityGroupIds

          Location: query

          Type: string

          Description: Select only floodlight activities with the specified floodlight activity group IDs.

          Format: int64

          Repeated: Yes

        maxResults

          Description: Maximum number of results to return.

          Format: int32

          Location: query

          Maximum: 1000

          Minimum: 0

          Default: 1000

          Type: integer

        floodlightActivityGroupName

          Location: query

          Type: string

          Description: Select only floodlight activities with the specified floodlight activity group name.

        floodlightConfigurationId

          Format: int64

          Type: string

          Location: query

          Description: Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

        sortOrder

          Default: ASCENDING

          Enum Descriptions:

        • Description: Order of sorted results.

          Location: query

          Type: string

          Enum:

        • ASCENDING
        • DESCENDING

        searchString

          Type: string

          Location: query

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".

        sortField

          Enum:

        • ID
        • NAME
        • Type: string

          Default: ID

          Location: query

          Enum Descriptions:

        • Description: Field by which to sort the list.

        ids

          Location: query

          Type: string

          Description: Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.

          Repeated: Yes

          Format: int64

        floodlightActivityGroupTagString

          Location: query

          Type: string

          Description: Select only floodlight activities with the specified floodlight activity group tag string.

        pageToken

          Type: string

          Location: query

          Description: Value of the nextPageToken from the previous result page.

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

          Location: path

          Required: Yes

        floodlightActivityGroupType

          Location: query

          Enum Descriptions:

        • Type: string

          Description: Select only floodlight activities with the specified floodlight activity group type.

          Enum:

        • COUNTER
        • SALE

        tagString

          Description: Select only floodlight activities with the specified tag string.

          Location: query

          Type: string

  • dfareporting.floodlightActivities.patch

      Parameter Order:

    • profileId
    • id
    • HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/floodlightActivities

      Description: Updates an existing floodlight activity. This method supports patch semantics.

      Parameters:

        profileId

          Format: int64

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Location: path

        id

          Type: string

          Location: query

          Description: FloodlightActivity ID.

          Required: Yes

          Format: int64

      Flat Path: userprofiles/{profileId}/floodlightActivities

  • dfareporting.floodlightActivities.get

      Path: userprofiles/{profileId}/floodlightActivities/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/floodlightActivities/{id}

      Parameters:

        profileId

          Format: int64

          Type: string

          Location: path

          Description: User profile ID associated with this request.

          Required: Yes

        id

          Type: string

          Description: Floodlight activity ID.

          Location: path

          Required: Yes

          Format: int64

      HTTP Method: GET

      Description: Gets one floodlight activity by ID.

  • dfareporting.floodlightActivities.delete

      Path: userprofiles/{profileId}/floodlightActivities/{id}

      Flat Path: userprofiles/{profileId}/floodlightActivities/{id}

      Description: Deletes an existing floodlight activity.

      Parameters:

        id

          Description: Floodlight activity ID.

          Format: int64

          Location: path

          Type: string

          Required: Yes

        profileId

          Required: Yes

          Location: path

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

      Parameter Order:

    • profileId
    • id
    • HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.floodlightActivities.update

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Description: User profile ID associated with this request.

          Location: path

          Type: string

      Path: userprofiles/{profileId}/floodlightActivities

      HTTP Method: PUT

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/floodlightActivities

      Description: Updates an existing floodlight activity.

  • dfareporting.floodlightActivities.insert

      HTTP Method: POST

      Flat Path: userprofiles/{profileId}/floodlightActivities

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Location: path

          Required: Yes

          Type: string

      Description: Inserts a new floodlight activity.

      Path: userprofiles/{profileId}/floodlightActivities

  • dfareporting.languages.list

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Retrieves a list of languages.

      Path: userprofiles/{profileId}/languages

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/languages

      HTTP Method: GET

      Parameters:

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

          Location: path

  • dfareporting.contentCategories.patch

      Path: userprofiles/{profileId}/contentCategories

      Flat Path: userprofiles/{profileId}/contentCategories

      HTTP Method: PATCH

      Parameters:

        profileId

          Format: int64

          Location: path

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

        id

          Description: ContentCategory ID.

          Required: Yes

          Format: int64

          Location: query

          Type: string

      Description: Updates an existing content category. This method supports patch semantics.

      Parameter Order:

    • profileId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.contentCategories.get

      Parameters:

        profileId

          Location: path

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

        id

          Format: int64

          Description: Content category ID.

          Type: string

          Required: Yes

          Location: path

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/contentCategories/{id}

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

      Path: userprofiles/{profileId}/contentCategories/{id}

      Description: Gets one content category by ID.

  • dfareporting.contentCategories.update

      Parameter Order: profileId

      Parameters:

        profileId

          Format: int64

          Required: Yes

          Location: path

          Type: string

          Description: User profile ID associated with this request.

      HTTP Method: PUT

      Description: Updates an existing content category.

      Path: userprofiles/{profileId}/contentCategories

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/contentCategories

  • dfareporting.contentCategories.insert

      Flat Path: userprofiles/{profileId}/contentCategories

      Description: Inserts a new content category.

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

          Location: path

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: POST

      Parameter Order: profileId

      Path: userprofiles/{profileId}/contentCategories

  • dfareporting.contentCategories.list

      Parameters:

        maxResults

          Default: 1000

          Location: query

          Type: integer

          Maximum: 1000

          Format: int32

          Description: Maximum number of results to return.

          Minimum: 0

        sortField

          Description: Field by which to sort the list.

          Default: ID

          Type: string

          Enum Descriptions:

        • Location: query

          Enum:

        • ID
        • NAME

        profileId

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

        pageToken

          Description: Value of the nextPageToken from the previous result page.

          Location: query

          Type: string

        searchString

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".

          Type: string

          Location: query

        sortOrder

          Default: ASCENDING

          Description: Order of sorted results.

          Enum:

        • ASCENDING
        • DESCENDING
        • Type: string

          Enum Descriptions:

        • Location: query

        ids

          Description: Select only content categories with these IDs.

          Location: query

          Repeated: Yes

          Type: string

          Format: int64

      Description: Retrieves a list of content categories, possibly filtered. This method supports paging.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Path: userprofiles/{profileId}/contentCategories

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/contentCategories

  • dfareporting.contentCategories.delete

      HTTP Method: DELETE

      Parameters:

        id

          Location: path

          Required: Yes

          Description: Content category ID.

          Type: string

          Format: int64

        profileId

          Location: path

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Format: int64

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/contentCategories/{id}

      Description: Deletes an existing content category.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/contentCategories/{id}

  • dfareporting.targetingTemplates.patch

      Parameters:

        id

          Description: TargetingTemplate ID.

          Format: int64

          Location: query

          Required: Yes

          Type: string

        profileId

          Required: Yes

          Format: int64

          Location: path

          Type: string

          Description: User profile ID associated with this request.

      Path: userprofiles/{profileId}/targetingTemplates

      Parameter Order:

    • profileId
    • id
    • HTTP Method: PATCH

      Description: Updates an existing targeting template. This method supports patch semantics.

      Flat Path: userprofiles/{profileId}/targetingTemplates

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.targetingTemplates.list

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/targetingTemplates

      Parameters:

        sortOrder

          Type: string

          Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

          Default: ASCENDING

          Location: query

          Enum Descriptions:

        searchString

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template".

          Location: query

          Type: string

        advertiserId

          Format: int64

          Description: Select only targeting templates with this advertiser ID.

          Type: string

          Location: query

        sortField

          Location: query

          Type: string

          Enum Descriptions:

        • Default: ID

          Description: Field by which to sort the list.

          Enum:

        • ID
        • NAME

        ids

          Type: string

          Format: int64

          Description: Select only targeting templates with these IDs.

          Location: query

          Repeated: Yes

        pageToken

          Description: Value of the nextPageToken from the previous result page.

          Type: string

          Location: query

        maxResults

          Default: 1000

          Format: int32

          Maximum: 1000

          Location: query

          Description: Maximum number of results to return.

          Type: integer

          Minimum: 0

        profileId

          Format: int64

          Location: path

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

      Description: Retrieves a list of targeting templates, optionally filtered. This method supports paging.

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/targetingTemplates

  • dfareporting.targetingTemplates.get

      Description: Gets one targeting template by ID.

      HTTP Method: GET

      Parameters:

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

          Type: string

        id

          Required: Yes

          Location: path

          Format: int64

          Description: Targeting template ID.

          Type: string

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/targetingTemplates/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/targetingTemplates/{id}

  • dfareporting.targetingTemplates.insert

      Flat Path: userprofiles/{profileId}/targetingTemplates

      Path: userprofiles/{profileId}/targetingTemplates

      Description: Inserts a new targeting template.

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

          Location: path

      Parameter Order: profileId

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.targetingTemplates.update

      Description: Updates an existing targeting template.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: PUT

      Parameters:

        profileId

          Format: int64

          Required: Yes

          Description: User profile ID associated with this request.

          Location: path

          Type: string

      Flat Path: userprofiles/{profileId}/targetingTemplates

      Parameter Order: profileId

      Path: userprofiles/{profileId}/targetingTemplates

  • dfareporting.inventoryItems.list

      Parameters:

        maxResults

          Maximum: 1000

          Type: integer

          Minimum: 0

          Default: 1000

          Location: query

          Description: Maximum number of results to return.

          Format: int32

        sortOrder

          Location: query

          Description: Order of sorted results.

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING
        • Type: string

          Default: ASCENDING

        ids

          Location: query

          Description: Select only inventory items with these IDs.

          Repeated: Yes

          Type: string

          Format: int64

        profileId

          Required: Yes

          Format: int64

          Location: path

          Description: User profile ID associated with this request.

          Type: string

        projectId

          Location: path

          Description: Project ID for order documents.

          Type: string

          Required: Yes

          Format: int64

        type

          Location: query

          Type: string

          Enum:

        • PLANNING_PLACEMENT_TYPE_REGULAR
        • PLANNING_PLACEMENT_TYPE_CREDIT
        • Description: Select only inventory items with this type.

          Enum Descriptions:

        inPlan

          Type: boolean

          Description: Select only inventory items that are in plan.

          Location: query

        pageToken

          Type: string

          Location: query

          Description: Value of the nextPageToken from the previous result page.

        sortField

          Location: query

          Description: Field by which to sort the list.

          Default: ID

          Enum:

        • ID
        • NAME
        • Enum Descriptions:

        • Type: string

        siteId

          Description: Select only inventory items that are associated with these sites.

          Location: query

          Format: int64

          Repeated: Yes

          Type: string

        orderId

          Description: Select only inventory items that belong to specified orders.

          Location: query

          Type: string

          Repeated: Yes

          Format: int64

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/projects/{projectId}/inventoryItems

      Description: Retrieves a list of inventory items, possibly filtered. This method supports paging.

      Path: userprofiles/{profileId}/projects/{projectId}/inventoryItems

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • projectId
  • dfareporting.inventoryItems.get

      HTTP Method: GET

      Parameters:

        projectId

          Location: path

          Description: Project ID for order documents.

          Required: Yes

          Format: int64

          Type: string

        id

          Format: int64

          Required: Yes

          Description: Inventory item ID.

          Location: path

          Type: string

        profileId

          Format: int64

          Required: Yes

          Location: path

          Type: string

          Description: User profile ID associated with this request.

      Path: userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}

      Description: Gets one inventory item by ID.

      Parameter Order:

    • profileId
    • projectId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}

  • dfareporting.placementStrategies.update

      Description: Updates an existing placement strategy.

      Parameter Order: profileId

      HTTP Method: PUT

      Path: userprofiles/{profileId}/placementStrategies

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Type: string

          Required: Yes

          Location: path

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/placementStrategies

  • dfareporting.placementStrategies.get

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/placementStrategies/{id}

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/placementStrategies/{id}

      Description: Gets one placement strategy by ID.

      Parameters:

        id

          Required: Yes

          Location: path

          Description: Placement strategy ID.

          Type: string

          Format: int64

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Location: path

          Format: int64

          Required: Yes

  • dfareporting.placementStrategies.delete

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/placementStrategies/{id}

      Path: userprofiles/{profileId}/placementStrategies/{id}

      Parameters:

        id

          Type: string

          Description: Placement strategy ID.

          Format: int64

          Location: path

          Required: Yes

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Type: string

          Required: Yes

          Format: int64

      HTTP Method: DELETE

      Parameter Order:

    • profileId
    • id
    • Description: Deletes an existing placement strategy.

  • dfareporting.placementStrategies.patch

      Parameter Order:

    • profileId
    • id
    • HTTP Method: PATCH

      Parameters:

        id

          Location: query

          Description: PlacementStrategy ID.

          Format: int64

          Type: string

          Required: Yes

        profileId

          Location: path

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/placementStrategies

      Flat Path: userprofiles/{profileId}/placementStrategies

      Description: Updates an existing placement strategy. This method supports patch semantics.

  • dfareporting.placementStrategies.insert

      Parameter Order: profileId

      Parameters:

        profileId

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Format: int64

          Location: path

      Description: Inserts a new placement strategy.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/placementStrategies

      Path: userprofiles/{profileId}/placementStrategies

      HTTP Method: POST

  • dfareporting.placementStrategies.list

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        maxResults

          Maximum: 1000

          Minimum: 0

          Description: Maximum number of results to return.

          Location: query

          Type: integer

          Format: int32

          Default: 1000

        profileId

          Required: Yes

          Format: int64

          Type: string

          Location: path

          Description: User profile ID associated with this request.

        sortField

          Type: string

          Description: Field by which to sort the list.

          Default: ID

          Enum:

        • ID
        • NAME
        • Enum Descriptions:

        • Location: query

        sortOrder

          Enum:

        • ASCENDING
        • DESCENDING
        • Location: query

          Default: ASCENDING

          Type: string

          Description: Order of sorted results.

          Enum Descriptions:

        searchString

          Location: query

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".

          Type: string

        ids

          Location: query

          Format: int64

          Description: Select only placement strategies with these IDs.

          Type: string

          Repeated: Yes

        pageToken

          Location: query

          Type: string

          Description: Value of the nextPageToken from the previous result page.

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/placementStrategies

      Path: userprofiles/{profileId}/placementStrategies

      Description: Retrieves a list of placement strategies, possibly filtered. This method supports paging.

  • dfareporting.directorySites.insert

      Parameter Order: profileId

      Parameters:

        profileId

          Location: path

          Type: string

          Description: User profile ID associated with this request.

          Format: int64

          Required: Yes

      Path: userprofiles/{profileId}/directorySites

      Flat Path: userprofiles/{profileId}/directorySites

      Description: Inserts a new directory site.

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.directorySites.get

      Flat Path: userprofiles/{profileId}/directorySites/{id}

      Parameter Order:

    • profileId
    • id
    • Parameters:

        profileId

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

          Location: path

          Format: int64

        id

          Required: Yes

          Description: Directory site ID.

          Location: path

          Format: int64

          Type: string

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: GET

      Description: Gets one directory site by ID.

      Path: userprofiles/{profileId}/directorySites/{id}

  • dfareporting.directorySites.list

      Parameter Order: profileId

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Retrieves a list of directory sites, possibly filtered. This method supports paging.

      Path: userprofiles/{profileId}/directorySites

      Flat Path: userprofiles/{profileId}/directorySites

      Parameters:

        acceptsInterstitialPlacements

          Location: query

          Description: This search filter is no longer supported and will have no effect on the results returned.

          Type: boolean

        searchString

          Location: query

          Description: Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".

          Type: string

        sortField

          Location: query

          Description: Field by which to sort the list.

          Default: ID

          Enum:

        • ID
        • NAME
        • Enum Descriptions:

        • Type: string

        maxResults

          Description: Maximum number of results to return.

          Default: 1000

          Location: query

          Type: integer

          Format: int32

          Maximum: 1000

          Minimum: 0

        acceptsInStreamVideoPlacements

          Location: query

          Description: This search filter is no longer supported and will have no effect on the results returned.

          Type: boolean

        ids

          Type: string

          Format: int64

          Repeated: Yes

          Description: Select only directory sites with these IDs.

          Location: query

        dfpNetworkCode

          Description: Select only directory sites with this Ad Manager network code.

          Type: string

          Location: query

        pageToken

          Type: string

          Location: query

          Description: Value of the nextPageToken from the previous result page.

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

          Type: string

          Location: path

        active

          Description: Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.

          Location: query

          Type: boolean

        acceptsPublisherPaidPlacements

          Type: boolean

          Location: query

          Description: Select only directory sites that accept publisher paid placements. This field can be left blank.

        sortOrder

          Type: string

          Enum Descriptions:

        • Location: query

          Description: Order of sorted results.

          Default: ASCENDING

          Enum:

        • ASCENDING
        • DESCENDING

  • dfareporting.projects.list

      Path: userprofiles/{profileId}/projects

      Flat Path: userprofiles/{profileId}/projects

      Description: Retrieves a list of projects, possibly filtered. This method supports paging .

      HTTP Method: GET

      Parameters:

        searchString

          Description: Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".

          Location: query

          Type: string

        sortField

          Location: query

          Enum Descriptions:

        • Type: string

          Default: ID

          Description: Field by which to sort the list.

          Enum:

        • ID
        • NAME

        sortOrder

          Description: Order of sorted results.

          Location: query

          Enum:

        • ASCENDING
        • DESCENDING
        • Default: ASCENDING

          Enum Descriptions:

        • Type: string

        profileId

          Format: int64

          Location: path

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

        pageToken

          Description: Value of the nextPageToken from the previous result page.

          Location: query

          Type: string

        ids

          Description: Select only projects with these IDs.

          Repeated: Yes

          Format: int64

          Type: string

          Location: query

        maxResults

          Minimum: 0

          Location: query

          Maximum: 1000

          Description: Maximum number of results to return.

          Format: int32

          Default: 1000

          Type: integer

        advertiserIds

          Type: string

          Description: Select only projects with these advertiser IDs.

          Repeated: Yes

          Location: query

          Format: int64

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.projects.get

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

          Type: string

          Required: Yes

        id

          Format: int64

          Type: string

          Required: Yes

          Location: path

          Description: Project ID.

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/projects/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/projects/{id}

      Description: Gets one project by ID.

      HTTP Method: GET

  • dfareporting.orderDocuments.list

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Retrieves a list of order documents, possibly filtered. This method supports paging.

      Path: userprofiles/{profileId}/projects/{projectId}/orderDocuments

      HTTP Method: GET

      Parameter Order:

    • profileId
    • projectId
    • Flat Path: userprofiles/{profileId}/projects/{projectId}/orderDocuments

      Parameters:

        siteId

          Format: int64

          Repeated: Yes

          Description: Select only order documents that are associated with these sites.

          Location: query

          Type: string

        maxResults

          Type: integer

          Location: query

          Description: Maximum number of results to return.

          Format: int32

          Maximum: 1000

          Minimum: 0

          Default: 1000

        sortOrder

          Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

          Default: ASCENDING

          Location: query

          Type: string

          Enum Descriptions:

        approved

          Location: query

          Type: boolean

          Description: Select only order documents that have been approved by at least one user.

        profileId

          Location: path

          Format: int64

          Type: string

          Required: Yes

          Description: User profile ID associated with this request.

        projectId

          Location: path

          Type: string

          Required: Yes

          Format: int64

          Description: Project ID for order documents.

        pageToken

          Description: Value of the nextPageToken from the previous result page.

          Type: string

          Location: query

        sortField

          Default: ID

          Type: string

          Description: Field by which to sort the list.

          Enum:

        • ID
        • NAME
        • Location: query

          Enum Descriptions:

        ids

          Location: query

          Description: Select only order documents with these IDs.

          Type: string

          Repeated: Yes

          Format: int64

        orderId

          Description: Select only order documents for specified orders.

          Repeated: Yes

          Location: query

          Type: string

          Format: int64

        searchString

          Location: query

          Description: Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".

          Type: string

  • dfareporting.orderDocuments.get

      Parameter Order:

    • profileId
    • projectId
    • id
    • Description: Gets one order document by ID.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        projectId

          Type: string

          Description: Project ID for order documents.

          Location: path

          Required: Yes

          Format: int64

        id

          Location: path

          Description: Order document ID.

          Format: int64

          Type: string

          Required: Yes

        profileId

          Location: path

          Required: Yes

          Format: int64

          Description: User profile ID associated with this request.

          Type: string

      Path: userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}

  • dfareporting.metros.list

      Parameters:

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Format: int64

          Required: Yes

          Location: path

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/metros

      Path: userprofiles/{profileId}/metros

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Description: Retrieves a list of metros.

  • dfareporting.orders.list

      Flat Path: userprofiles/{profileId}/projects/{projectId}/orders

      Parameters:

        searchString

          Location: query

          Type: string

          Description: Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".

        sortOrder

          Type: string

          Location: query

          Default: ASCENDING

          Description: Order of sorted results.

          Enum:

        • ASCENDING
        • DESCENDING
        • Enum Descriptions:

        sortField

          Description: Field by which to sort the list.

          Default: ID

          Enum:

        • ID
        • NAME
        • Enum Descriptions:

        • Location: query

          Type: string

        maxResults

          Default: 1000

          Maximum: 1000

          Location: query

          Minimum: 0

          Format: int32

          Type: integer

          Description: Maximum number of results to return.

        ids

          Description: Select only orders with these IDs.

          Location: query

          Format: int64

          Type: string

          Repeated: Yes

        projectId

          Location: path

          Required: Yes

          Type: string

          Format: int64

          Description: Project ID for orders.

        siteId

          Type: string

          Format: int64

          Description: Select only orders that are associated with these site IDs.

          Location: query

          Repeated: Yes

        profileId

          Type: string

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

        pageToken

          Location: query

          Description: Value of the nextPageToken from the previous result page.

          Type: string

      Parameter Order:

    • profileId
    • projectId
    • HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Retrieves a list of orders, possibly filtered. This method supports paging.

      Path: userprofiles/{profileId}/projects/{projectId}/orders

  • dfareporting.orders.get

      Parameter Order:

    • profileId
    • projectId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: GET

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

          Type: string

          Location: path

        projectId

          Required: Yes

          Type: string

          Location: path

          Format: int64

          Description: Project ID for orders.

        id

          Type: string

          Location: path

          Required: Yes

          Description: Order ID.

          Format: int64

      Flat Path: userprofiles/{profileId}/projects/{projectId}/orders/{id}

      Path: userprofiles/{profileId}/projects/{projectId}/orders/{id}

      Description: Gets one order by ID.

  • dfareporting.placements.generatetags

      Parameter Order: profileId

      Description: Generates tags for a placement.

      Path: userprofiles/{profileId}/placements/generatetags

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/placements/generatetags

      HTTP Method: POST

      Parameters:

        campaignId

          Type: string

          Format: int64

          Description: Generate placements belonging to this campaign. This is a required field.

          Location: query

        placementIds

          Location: query

          Format: int64

          Type: string

          Repeated: Yes

          Description: Generate tags for these placements.

        tagFormats

          Enum:

        • PLACEMENT_TAG_STANDARD
        • PLACEMENT_TAG_IFRAME_JAVASCRIPT
        • PLACEMENT_TAG_IFRAME_ILAYER
        • PLACEMENT_TAG_INTERNAL_REDIRECT
        • PLACEMENT_TAG_JAVASCRIPT
        • PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT
        • PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT
        • PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT
        • PLACEMENT_TAG_CLICK_COMMANDS
        • PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH
        • PLACEMENT_TAG_TRACKING
        • PLACEMENT_TAG_TRACKING_IFRAME
        • PLACEMENT_TAG_TRACKING_JAVASCRIPT
        • PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3
        • PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY
        • PLACEMENT_TAG_JAVASCRIPT_LEGACY
        • PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY
        • PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY
        • PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4
        • PLACEMENT_TAG_TRACKING_THIRD_PARTY_MEASUREMENT
        • Repeated: Yes

          Description: Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.

          Enum Descriptions:

        • Type: string

          Location: query

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Type: string

          Required: Yes

          Location: path

  • dfareporting.placements.patch

      Parameter Order:

    • profileId
    • id
    • Description: Updates an existing placement. This method supports patch semantics.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/placements

      Parameters:

        id

          Location: query

          Description: Placement ID.

          Type: string

          Required: Yes

          Format: int64

        profileId

          Type: string

          Required: Yes

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

      HTTP Method: PATCH

      Path: userprofiles/{profileId}/placements

  • dfareporting.placements.get

      HTTP Method: GET

      Path: userprofiles/{profileId}/placements/{id}

      Parameter Order:

    • profileId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/placements/{id}

      Description: Gets one placement by ID.

      Parameters:

        profileId

          Location: path

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

        id

          Required: Yes

          Type: string

          Format: int64

          Description: Placement ID.

          Location: path

  • dfareporting.placements.insert

      Flat Path: userprofiles/{profileId}/placements

      HTTP Method: POST

      Parameter Order: profileId

      Description: Inserts a new placement.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/placements

      Parameters:

        profileId

          Format: int64

          Required: Yes

          Type: string

          Location: path

          Description: User profile ID associated with this request.

  • dfareporting.placements.update

      Path: userprofiles/{profileId}/placements

      Flat Path: userprofiles/{profileId}/placements

      HTTP Method: PUT

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Required: Yes

          Format: int64

          Location: path

      Description: Updates an existing placement.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

  • dfareporting.placements.list

      Path: userprofiles/{profileId}/placements

      Flat Path: userprofiles/{profileId}/placements

      Parameters:

        minEndDate

          Location: query

          Description: Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

          Type: string

        archived

          Location: query

          Description: Select only archived placements. Don't set this field to select both archived and non-archived placements.

          Type: boolean

        advertiserIds

          Format: int64

          Type: string

          Description: Select only placements that belong to these advertisers.

          Location: query

          Repeated: Yes

        ids

          Type: string

          Repeated: Yes

          Format: int64

          Description: Select only placements with these IDs.

          Location: query

        campaignIds

          Type: string

          Location: query

          Description: Select only placements that belong to these campaigns.

          Format: int64

          Repeated: Yes

        directorySiteIds

          Type: string

          Description: Select only placements that are associated with these directory sites.

          Location: query

          Format: int64

          Repeated: Yes

        compatibilities

          Description: Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.

          Location: query

          Enum:

        • DISPLAY
        • DISPLAY_INTERSTITIAL
        • APP
        • APP_INTERSTITIAL
        • IN_STREAM_VIDEO
        • IN_STREAM_AUDIO
        • Enum Descriptions:

        • Repeated: Yes

          Type: string

        siteIds

          Repeated: Yes

          Type: string

          Location: query

          Format: int64

          Description: Select only placements that are associated with these sites.

        placementStrategyIds

          Description: Select only placements that are associated with these placement strategies.

          Repeated: Yes

          Location: query

          Format: int64

          Type: string

        sortField

          Default: ID

          Description: Field by which to sort the list.

          Enum:

        • ID
        • NAME
        • Enum Descriptions:

        • Location: query

          Type: string

        contentCategoryIds

          Repeated: Yes

          Description: Select only placements that are associated with these content categories.

          Type: string

          Location: query

          Format: int64

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

        maxStartDate

          Description: Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

          Location: query

          Type: string

        maxResults

          Minimum: 0

          Maximum: 1000

          Location: query

          Type: integer

          Default: 1000

          Format: int32

          Description: Maximum number of results to return.

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

          Type: string

          Format: int64

        minStartDate

          Type: string

          Location: query

          Description: Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

        maxEndDate

          Location: query

          Description: Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

          Type: string

        sizeIds

          Repeated: Yes

          Format: int64

          Type: string

          Location: query

          Description: Select only placements that are associated with these sizes.

        groupIds

          Location: query

          Format: int64

          Description: Select only placements that belong to these placement groups.

          Repeated: Yes

          Type: string

        searchString

          Type: string

          Location: query

          Description: Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement" .

        pricingTypes

          Repeated: Yes

          Location: query

          Enum:

        • PRICING_TYPE_CPM
        • PRICING_TYPE_CPC
        • PRICING_TYPE_CPA
        • PRICING_TYPE_FLAT_RATE_IMPRESSIONS
        • PRICING_TYPE_FLAT_RATE_CLICKS
        • PRICING_TYPE_CPM_ACTIVEVIEW
        • Enum Descriptions:

        • Type: string

          Description: Select only placements with these pricing types.

        paymentSource

          Enum:

        • PLACEMENT_AGENCY_PAID
        • PLACEMENT_PUBLISHER_PAID
        • Location: query

          Description: Select only placements with this payment source.

          Enum Descriptions:

        • Type: string

        sortOrder

          Location: query

          Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

          Enum Descriptions:

        • Default: ASCENDING

          Type: string

      Parameter Order: profileId

      Description: Retrieves a list of placements, possibly filtered. This method supports paging.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: GET

  • dfareporting.operatingSystems.get

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • dartId
    • Description: Gets one operating system by DART ID.

      Parameters:

        dartId

          Format: int64

          Required: Yes

          Location: path

          Description: Operating system DART ID.

          Type: string

        profileId

          Required: Yes

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

          Type: string

      Flat Path: userprofiles/{profileId}/operatingSystems/{dartId}

      Path: userprofiles/{profileId}/operatingSystems/{dartId}

      HTTP Method: GET

  • dfareporting.operatingSystems.list

      Path: userprofiles/{profileId}/operatingSystems

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/operatingSystems

      HTTP Method: GET

      Description: Retrieves a list of operating systems.

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Required: Yes

          Location: path

          Type: string

      Parameter Order: profileId

  • dfareporting.conversions.batchinsert

      Flat Path: userprofiles/{profileId}/conversions/batchinsert

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Location: path

          Format: int64

          Required: Yes

      Scopes: https://www.googleapis.com/auth/ddmconversions

      Description: Inserts conversions.

      Parameter Order: profileId

      HTTP Method: POST

      Path: userprofiles/{profileId}/conversions/batchinsert

  • dfareporting.conversions.batchupdate

      Parameter Order: profileId

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/ddmconversions

      Path: userprofiles/{profileId}/conversions/batchupdate

      Description: Updates existing conversions.

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Description: User profile ID associated with this request.

          Location: path

          Type: string

      Flat Path: userprofiles/{profileId}/conversions/batchupdate

  • dfareporting.mobileApps.list

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/mobileApps

      Description: Retrieves list of available mobile apps.

      Path: userprofiles/{profileId}/mobileApps

      HTTP Method: GET

      Parameters:

        pageToken

          Location: query

          Description: Value of the nextPageToken from the previous result page.

          Type: string

        ids

          Type: string

          Description: Select only apps with these IDs.

          Location: query

          Repeated: Yes

        searchString

          Type: string

          Location: query

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app".

        profileId

          Location: path

          Required: Yes

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

        directories

          Location: query

          Repeated: Yes

          Description: Select only apps from these directories.

          Type: string

          Enum Descriptions:

        • Enum:

        • UNKNOWN
        • APPLE_APP_STORE
        • GOOGLE_PLAY_STORE

        maxResults

          Format: int32

          Description: Maximum number of results to return.

          Minimum: 0

          Default: 1000

          Type: integer

          Maximum: 1000

          Location: query

  • dfareporting.mobileApps.get

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/mobileApps/{id}

      Description: Gets one mobile app by ID.

      Flat Path: userprofiles/{profileId}/mobileApps/{id}

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Location: path

          Required: Yes

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

        id

          Location: path

          Type: string

          Required: Yes

          Description: Mobile app ID.

  • dfareporting.accountPermissionGroups.list

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      HTTP Method: GET

      Parameters:

        profileId

          Format: int64

          Type: string

          Required: Yes

          Description: User profile ID associated with this request.

          Location: path

      Description: Retrieves the list of account permission groups.

      Path: userprofiles/{profileId}/accountPermissionGroups

      Flat Path: userprofiles/{profileId}/accountPermissionGroups

  • dfareporting.accountPermissionGroups.get

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Type: string

          Location: path

          Required: Yes

        id

          Description: Account permission group ID.

          Format: int64

          Type: string

          Required: Yes

          Location: path

      Flat Path: userprofiles/{profileId}/accountPermissionGroups/{id}

      HTTP Method: GET

      Description: Gets one account permission group by ID.

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/accountPermissionGroups/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.dynamicTargetingKeys.insert

      Path: userprofiles/{profileId}/dynamicTargetingKeys

      Flat Path: userprofiles/{profileId}/dynamicTargetingKeys

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      HTTP Method: POST

      Description: Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

      Parameters:

        profileId

          Type: string

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

          Required: Yes

  • dfareporting.dynamicTargetingKeys.list

      Path: userprofiles/{profileId}/dynamicTargetingKeys

      HTTP Method: GET

      Description: Retrieves a list of dynamic targeting keys.

      Flat Path: userprofiles/{profileId}/dynamicTargetingKeys

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Type: string

          Format: int64

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

        objectId

          Description: Select only dynamic targeting keys with this object ID.

          Type: string

          Format: int64

          Location: query

        objectType

          Description: Select only dynamic targeting keys with this object type.

          Enum:

        • OBJECT_ADVERTISER
        • OBJECT_AD
        • OBJECT_CREATIVE
        • OBJECT_PLACEMENT
        • Enum Descriptions:

        • Type: string

          Location: query

        names

          Location: query

          Repeated: Yes

          Description: Select only dynamic targeting keys exactly matching these names.

          Type: string

        advertiserId

          Type: string

          Location: query

          Format: int64

          Description: Select only dynamic targeting keys whose object has this advertiser ID.

  • dfareporting.dynamicTargetingKeys.delete

      Parameter Order:

    • profileId
    • objectId
    • name
    • objectType
    • Parameters:

        objectType

          Enum:

        • OBJECT_ADVERTISER
        • OBJECT_AD
        • OBJECT_CREATIVE
        • OBJECT_PLACEMENT
        • Required: Yes

          Description: Type of the object of this dynamic targeting key. This is a required field.

          Location: query

          Enum Descriptions:

        • Type: string

        name

          Required: Yes

          Description: Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.

          Location: query

          Type: string

        profileId

          Type: string

          Location: path

          Format: int64

          Required: Yes

          Description: User profile ID associated with this request.

        objectId

          Location: path

          Format: int64

          Type: string

          Description: ID of the object of this dynamic targeting key. This is a required field.

          Required: Yes

      Path: userprofiles/{profileId}/dynamicTargetingKeys/{objectId}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Deletes an existing dynamic targeting key.

      Flat Path: userprofiles/{profileId}/dynamicTargetingKeys/{objectId}

      HTTP Method: DELETE

  • dfareporting.eventTags.get

      Path: userprofiles/{profileId}/eventTags/{id}

      Flat Path: userprofiles/{profileId}/eventTags/{id}

      Description: Gets one event tag by ID.

      Parameter Order:

    • profileId
    • id
    • Parameters:

        id

          Type: string

          Description: Event tag ID.

          Required: Yes

          Location: path

          Format: int64

        profileId

          Location: path

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Format: int64

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: GET

  • dfareporting.eventTags.delete

      Flat Path: userprofiles/{profileId}/eventTags/{id}

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Description: User profile ID associated with this request.

          Type: string

          Location: path

        id

          Location: path

          Format: int64

          Description: Event tag ID.

          Required: Yes

          Type: string

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/eventTags/{id}

      Description: Deletes an existing event tag.

      HTTP Method: DELETE

      Parameter Order:

    • profileId
    • id
  • dfareporting.eventTags.update

      Parameters:

        profileId

          Required: Yes

          Location: path

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

      HTTP Method: PUT

      Description: Updates an existing event tag.

      Parameter Order: profileId

      Path: userprofiles/{profileId}/eventTags

      Flat Path: userprofiles/{profileId}/eventTags

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.eventTags.insert

      Flat Path: userprofiles/{profileId}/eventTags

      Parameter Order: profileId

      Parameters:

        profileId

          Required: Yes

          Description: User profile ID associated with this request.

          Format: int64

          Location: path

          Type: string

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/eventTags

      Description: Inserts a new event tag.

      HTTP Method: POST

  • dfareporting.eventTags.list

      Path: userprofiles/{profileId}/eventTags

      Parameters:

        adId

          Type: string

          Location: query

          Format: int64

          Description: Select only event tags that belong to this ad.

        searchString

          Type: string

          Location: query

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".

        eventTagTypes

          Repeated: Yes

          Description: Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.

          Enum Descriptions:

        • Location: query

          Type: string

          Enum:

        • IMPRESSION_IMAGE_EVENT_TAG
        • IMPRESSION_JAVASCRIPT_EVENT_TAG
        • CLICK_THROUGH_EVENT_TAG

        profileId

          Location: path

          Required: Yes

          Format: int64

          Description: User profile ID associated with this request.

          Type: string

        sortOrder

          Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

          Enum Descriptions:

        • Location: query

          Type: string

          Default: ASCENDING

        enabled

          Type: boolean

          Location: query

          Description: Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.

        sortField

          Default: ID

          Type: string

          Location: query

          Enum:

        • ID
        • NAME
        • Description: Field by which to sort the list.

          Enum Descriptions:

        advertiserId

          Description: Select only event tags that belong to this advertiser.

          Location: query

          Type: string

          Format: int64

        ids

          Type: string

          Location: query

          Format: int64

          Description: Select only event tags with these IDs.

          Repeated: Yes

        campaignId

          Format: int64

          Location: query

          Description: Select only event tags that belong to this campaign.

          Type: string

        definitionsOnly

          Location: query

          Type: boolean

          Description: Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.

      Parameter Order: profileId

      HTTP Method: GET

      Description: Retrieves a list of event tags, possibly filtered.

      Flat Path: userprofiles/{profileId}/eventTags

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.eventTags.patch

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Updates an existing event tag. This method supports patch semantics.

      HTTP Method: PATCH

      Parameter Order:

    • profileId
    • id
    • Parameters:

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Type: string

          Format: int64

          Required: Yes

        id

          Required: Yes

          Location: query

          Description: EventTag ID.

          Type: string

          Format: int64

      Flat Path: userprofiles/{profileId}/eventTags

      Path: userprofiles/{profileId}/eventTags

  • dfareporting.floodlightConfigurations.update

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

          Type: string

          Format: int64

      Flat Path: userprofiles/{profileId}/floodlightConfigurations

      Path: userprofiles/{profileId}/floodlightConfigurations

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: PUT

      Description: Updates an existing floodlight configuration.

  • dfareporting.floodlightConfigurations.list

      HTTP Method: GET

      Parameter Order: profileId

      Path: userprofiles/{profileId}/floodlightConfigurations

      Description: Retrieves a list of floodlight configurations, possibly filtered.

      Flat Path: userprofiles/{profileId}/floodlightConfigurations

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        ids

          Type: string

          Location: query

          Description: Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.

          Format: int64

          Repeated: Yes

        profileId

          Type: string

          Required: Yes

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

  • dfareporting.floodlightConfigurations.patch

      Parameters:

        profileId

          Location: path

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

        id

          Description: FloodlightConfiguration ID.

          Location: query

          Required: Yes

          Format: int64

          Type: string

      Flat Path: userprofiles/{profileId}/floodlightConfigurations

      Description: Updates an existing floodlight configuration. This method supports patch semantics.

      HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/floodlightConfigurations

  • dfareporting.floodlightConfigurations.get

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/floodlightConfigurations/{id}

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Gets one floodlight configuration by ID.

      Path: userprofiles/{profileId}/floodlightConfigurations/{id}

      Parameters:

        profileId

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

        id

          Location: path

          Format: int64

          Type: string

          Required: Yes

          Description: Floodlight configuration ID.

  • dfareporting.files.get

      Supportsmediadownload: Yes

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

      HTTP Method: GET

      Parameter Order:

    • reportId
    • fileId
    • Flat Path: reports/{reportId}/files/{fileId}

      Scopes: https://www.googleapis.com/auth/dfareporting

      Path: reports/{reportId}/files/{fileId}

      Parameters:

        fileId

          Format: int64

          Type: string

          Required: Yes

          Description: The ID of the report file.

          Location: path

        reportId

          Description: The ID of the report.

          Required: Yes

          Type: string

          Location: path

          Format: int64

  • dfareporting.files.list

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfareporting

      HTTP Method: GET

      Description: Lists files for a user profile.

      Parameters:

        sortField

          Default: LAST_MODIFIED_TIME

          Enum:

        • ID
        • LAST_MODIFIED_TIME
        • Description: The field by which to sort the list.

          Location: query

          Type: string

          Enum Descriptions:

        • Sort by file ID.
        • Sort by 'lastmodifiedAt' field.

        profileId

          Location: path

          Description: The Campaign Manager 360 user profile ID.

          Type: string

          Required: Yes

          Format: int64

        maxResults

          Minimum: 0

          Location: query

          Format: int32

          Type: integer

          Description: Maximum number of results to return.

          Default: 10

          Maximum: 10

        sortOrder

          Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

          Enum Descriptions:

        • Ascending order.
        • Descending order.
        • Location: query

          Default: DESCENDING

          Type: string

        pageToken

          Type: string

          Description: The value of the nextToken from the previous result page.

          Location: query

        scope

          Description: The scope that defines which results are returned.

          Location: query

          Type: string

          Enum:

        • ALL
        • MINE
        • SHARED_WITH_ME
        • Default: MINE

          Enum Descriptions:

        • All files in account.
        • My files.
        • Files shared with me.

      Flat Path: userprofiles/{profileId}/files

      Path: userprofiles/{profileId}/files

  • dfareporting.browsers.list

      Parameter Order: profileId

      Description: Retrieves a list of browsers.

      Path: userprofiles/{profileId}/browsers

      Flat Path: userprofiles/{profileId}/browsers

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

  • dfareporting.creativeFields.get

      Path: userprofiles/{profileId}/creativeFields/{id}

      HTTP Method: GET

      Parameter Order:

    • profileId
    • id
    • Description: Gets one creative field by ID.

      Flat Path: userprofiles/{profileId}/creativeFields/{id}

      Parameters:

        id

          Type: string

          Required: Yes

          Format: int64

          Description: Creative Field ID

          Location: path

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

          Format: int64

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.creativeFields.update

      HTTP Method: PUT

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Parameters:

        profileId

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

      Path: userprofiles/{profileId}/creativeFields

      Description: Updates an existing creative field.

      Flat Path: userprofiles/{profileId}/creativeFields

  • dfareporting.creativeFields.delete

      Flat Path: userprofiles/{profileId}/creativeFields/{id}

      HTTP Method: DELETE

      Path: userprofiles/{profileId}/creativeFields/{id}

      Parameter Order:

    • profileId
    • id
    • Parameters:

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Type: string

          Location: path

          Required: Yes

        id

          Location: path

          Description: Creative Field ID

          Required: Yes

          Format: int64

          Type: string

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Deletes an existing creative field.

  • dfareporting.creativeFields.list

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        maxResults

          Type: integer

          Maximum: 1000

          Format: int32

          Location: query

          Minimum: 0

          Default: 1000

          Description: Maximum number of results to return.

        searchString

          Location: query

          Description: Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".

          Type: string

        sortOrder

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING
        • Location: query

          Default: ASCENDING

          Description: Order of sorted results.

          Type: string

        advertiserIds

          Repeated: Yes

          Location: query

          Type: string

          Format: int64

          Description: Select only creative fields that belong to these advertisers.

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

        profileId

          Required: Yes

          Location: path

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

        ids

          Description: Select only creative fields with these IDs.

          Format: int64

          Repeated: Yes

          Type: string

          Location: query

        sortField

          Location: query

          Default: ID

          Enum Descriptions:

        • Description: Field by which to sort the list.

          Enum:

        • ID
        • NAME
        • Type: string

      HTTP Method: GET

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/creativeFields

      Path: userprofiles/{profileId}/creativeFields

      Description: Retrieves a list of creative fields, possibly filtered. This method supports paging.

  • dfareporting.creativeFields.insert

      Flat Path: userprofiles/{profileId}/creativeFields

      Parameter Order: profileId

      Parameters:

        profileId

          Required: Yes

          Type: string

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

      Description: Inserts a new creative field.

      HTTP Method: POST

      Path: userprofiles/{profileId}/creativeFields

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.creativeFields.patch

      Path: userprofiles/{profileId}/creativeFields

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        id

          Format: int64

          Location: query

          Type: string

          Required: Yes

          Description: CreativeField ID.

        profileId

          Required: Yes

          Type: string

          Format: int64

          Location: path

          Description: User profile ID associated with this request.

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/creativeFields

      Description: Updates an existing creative field. This method supports patch semantics.

      HTTP Method: PATCH

  • dfareporting.accountUserProfiles.update

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Description: Updates an existing account user profile.

      Flat Path: userprofiles/{profileId}/accountUserProfiles

      Path: userprofiles/{profileId}/accountUserProfiles

      HTTP Method: PUT

      Parameters:

        profileId

          Type: string

          Format: int64

          Required: Yes

          Description: User profile ID associated with this request.

          Location: path

  • dfareporting.accountUserProfiles.get

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/accountUserProfiles/{id}

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Type: string

          Required: Yes

          Format: int64

        id

          Format: int64

          Type: string

          Description: User profile ID.

          Location: path

          Required: Yes

      Parameter Order:

    • profileId
    • id
    • Description: Gets one account user profile by ID.

      Flat Path: userprofiles/{profileId}/accountUserProfiles/{id}

  • dfareporting.accountUserProfiles.patch

      Flat Path: userprofiles/{profileId}/accountUserProfiles

      Path: userprofiles/{profileId}/accountUserProfiles

      HTTP Method: PATCH

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

          Format: int64

          Type: string

        id

          Description: AccountUserProfile ID.

          Format: int64

          Location: query

          Type: string

          Required: Yes

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

      Parameter Order:

    • profileId
    • id
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.accountUserProfiles.insert

      Description: Inserts a new account user profile.

      Flat Path: userprofiles/{profileId}/accountUserProfiles

      Path: userprofiles/{profileId}/accountUserProfiles

      Parameters:

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Type: string

          Location: path

          Required: Yes

      Parameter Order: profileId

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: POST

  • dfareporting.accountUserProfiles.list

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/accountUserProfiles

      Flat Path: userprofiles/{profileId}/accountUserProfiles

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

      Parameters:

        userRoleId

          Location: query

          Description: Select only user profiles with the specified user role ID.

          Format: int64

          Type: string

        active

          Location: query

          Type: boolean

          Description: Select only active user profiles.

        ids

          Repeated: Yes

          Location: query

          Type: string

          Description: Select only user profiles with these IDs.

          Format: int64

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Location: path

          Type: string

          Required: Yes

        sortField

          Location: query

          Type: string

          Enum Descriptions:

        • Default: ID

          Description: Field by which to sort the list.

          Enum:

        • ID
        • NAME

        pageToken

          Location: query

          Type: string

          Description: Value of the nextPageToken from the previous result page.

        maxResults

          Maximum: 1000

          Default: 1000

          Type: integer

          Description: Maximum number of results to return.

          Format: int32

          Minimum: 0

          Location: query

        sortOrder

          Enum Descriptions:

        • Type: string

          Description: Order of sorted results.

          Location: query

          Default: ASCENDING

          Enum:

        • ASCENDING
        • DESCENDING

        subaccountId

          Type: string

          Location: query

          Format: int64

          Description: Select only user profiles with the specified subaccount ID.

        searchString

          Location: query

          Description: Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".

          Type: string

      HTTP Method: GET

      Parameter Order: profileId

  • dfareporting.changeLogs.list

      Flat Path: userprofiles/{profileId}/changeLogs

      Description: Retrieves a list of change logs. This method supports paging.

      Parameter Order: profileId

      Parameters:

        ids

          Format: int64

          Repeated: Yes

          Type: string

          Location: query

          Description: Select only change logs with these IDs.

        pageToken

          Location: query

          Type: string

          Description: Value of the nextPageToken from the previous result page.

        profileId

          Format: int64

          Type: string

          Location: path

          Required: Yes

          Description: User profile ID associated with this request.

        action

          Type: string

          Location: query

          Enum Descriptions:

        • Description: Select only change logs with the specified action.

          Enum:

        • ACTION_CREATE
        • ACTION_UPDATE
        • ACTION_DELETE
        • ACTION_ENABLE
        • ACTION_DISABLE
        • ACTION_ADD
        • ACTION_REMOVE
        • ACTION_MARK_AS_DEFAULT
        • ACTION_ASSOCIATE
        • ACTION_ASSIGN
        • ACTION_UNASSIGN
        • ACTION_SEND
        • ACTION_LINK
        • ACTION_UNLINK
        • ACTION_PUSH
        • ACTION_EMAIL_TAGS
        • ACTION_SHARE

        userProfileIds

          Format: int64

          Type: string

          Location: query

          Description: Select only change logs with these user profile IDs.

          Repeated: Yes

        objectIds

          Format: int64

          Description: Select only change logs with these object IDs.

          Location: query

          Repeated: Yes

          Type: string

        maxChangeTime

          Description: Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.

          Location: query

          Type: string

        minChangeTime

          Type: string

          Description: Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.

          Location: query

        objectType

          Description: Select only change logs with the specified object type.

          Location: query

          Type: string

          Enum:

        • OBJECT_ADVERTISER
        • OBJECT_FLOODLIGHT_CONFIGURATION
        • OBJECT_AD
        • OBJECT_FLOODLIGHT_ACTVITY
        • OBJECT_CAMPAIGN
        • OBJECT_FLOODLIGHT_ACTIVITY_GROUP
        • OBJECT_CREATIVE
        • OBJECT_PLACEMENT
        • OBJECT_DFA_SITE
        • OBJECT_USER_ROLE
        • OBJECT_USER_PROFILE
        • OBJECT_ADVERTISER_GROUP
        • OBJECT_ACCOUNT
        • OBJECT_SUBACCOUNT
        • OBJECT_RICHMEDIA_CREATIVE
        • OBJECT_INSTREAM_CREATIVE
        • OBJECT_MEDIA_ORDER
        • OBJECT_CONTENT_CATEGORY
        • OBJECT_PLACEMENT_STRATEGY
        • OBJECT_SD_SITE
        • OBJECT_SIZE
        • OBJECT_CREATIVE_GROUP
        • OBJECT_CREATIVE_ASSET
        • OBJECT_USER_PROFILE_FILTER
        • OBJECT_LANDING_PAGE
        • OBJECT_CREATIVE_FIELD
        • OBJECT_REMARKETING_LIST
        • OBJECT_PROVIDED_LIST_CLIENT
        • OBJECT_EVENT_TAG
        • OBJECT_CREATIVE_BUNDLE
        • OBJECT_BILLING_ACCOUNT_GROUP
        • OBJECT_BILLING_FEATURE
        • OBJECT_RATE_CARD
        • OBJECT_ACCOUNT_BILLING_FEATURE
        • OBJECT_BILLING_MINIMUM_FEE
        • OBJECT_BILLING_PROFILE
        • OBJECT_PLAYSTORE_LINK
        • OBJECT_TARGETING_TEMPLATE
        • OBJECT_SEARCH_LIFT_STUDY
        • OBJECT_FLOODLIGHT_DV360_LINK
        • Enum Descriptions:

        maxResults

          Location: query

          Type: integer

          Default: 1000

          Description: Maximum number of results to return.

          Format: int32

          Minimum: 0

          Maximum: 1000

        searchString

          Type: string

          Location: query

          Description: Select only change logs whose object ID, user name, old or new values match the search string.

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/changeLogs

  • dfareporting.changeLogs.get

      Path: userprofiles/{profileId}/changeLogs/{id}

      Parameters:

        id

          Location: path

          Required: Yes

          Description: Change log ID.

          Type: string

          Format: int64

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

          Required: Yes

      Description: Gets one change log by ID.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/changeLogs/{id}

      Parameter Order:

    • profileId
    • id
  • dfareporting.ads.patch

      HTTP Method: PATCH

      Parameter Order:

    • profileId
    • id
    • Parameters:

        id

          Required: Yes

          Type: string

          Description: Ad ID.

          Location: query

          Format: int64

        profileId

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

      Description: Updates an existing ad. This method supports patch semantics.

      Flat Path: userprofiles/{profileId}/ads

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/ads

  • dfareporting.ads.list

      Flat Path: userprofiles/{profileId}/ads

      Path: userprofiles/{profileId}/ads

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

      Parameter Order: profileId

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: Value of the nextPageToken from the previous result page.

        overriddenEventTagId

          Location: query

          Description: Select only ads with this event tag override ID.

          Format: int64

          Type: string

        audienceSegmentIds

          Format: int64

          Type: string

          Repeated: Yes

          Location: query

          Description: Select only ads with these audience segment IDs.

        remarketingListIds

          Description: Select only ads whose list targeting expression use these remarketing list IDs.

          Location: query

          Repeated: Yes

          Type: string

          Format: int64

        ids

          Location: query

          Description: Select only ads with these IDs.

          Type: string

          Repeated: Yes

          Format: int64

        compatibility

          Type: string

          Description: Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.

          Enum Descriptions:

        • Location: query

          Enum:

        • DISPLAY
        • DISPLAY_INTERSTITIAL
        • APP
        • APP_INTERSTITIAL
        • IN_STREAM_VIDEO
        • IN_STREAM_AUDIO

        sortOrder

          Default: ASCENDING

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING
        • Description: Order of sorted results.

          Type: string

          Location: query

        creativeIds

          Format: int64

          Type: string

          Description: Select only ads with these creative IDs assigned.

          Location: query

          Repeated: Yes

        creativeOptimizationConfigurationIds

          Type: string

          Repeated: Yes

          Location: query

          Description: Select only ads with these creative optimization configuration IDs.

          Format: int64

        placementIds

          Location: query

          Description: Select only ads with these placement IDs assigned.

          Repeated: Yes

          Format: int64

          Type: string

        landingPageIds

          Repeated: Yes

          Description: Select only ads with these landing page IDs.

          Location: query

          Format: int64

          Type: string

        campaignIds

          Location: query

          Format: int64

          Type: string

          Repeated: Yes

          Description: Select only ads with these campaign IDs.

        sslCompliant

          Description: Select only ads that are SSL-compliant.

          Location: query

          Type: boolean

        type

          Description: Select only ads with these types.

          Enum Descriptions:

        • Repeated: Yes

          Location: query

          Enum:

        • AD_SERVING_STANDARD_AD
        • AD_SERVING_DEFAULT_AD
        • AD_SERVING_CLICK_TRACKER
        • AD_SERVING_TRACKING
        • AD_SERVING_BRAND_SAFE_AD
        • Type: string

        sizeIds

          Type: string

          Repeated: Yes

          Location: query

          Description: Select only ads with these size IDs.

          Format: int64

        maxResults

          Format: int32

          Type: integer

          Description: Maximum number of results to return.

          Minimum: 0

          Default: 1000

          Maximum: 1000

          Location: query

        advertiserId

          Description: Select only ads with this advertiser ID.

          Type: string

          Format: int64

          Location: query

        dynamicClickTracker

          Type: boolean

          Description: Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

          Location: query

        sslRequired

          Description: Select only ads that require SSL.

          Location: query

          Type: boolean

        archived

          Type: boolean

          Location: query

          Description: Select only archived ads.

        sortField

          Enum Descriptions:

        • Default: ID

          Description: Field by which to sort the list.

          Type: string

          Location: query

          Enum:

        • ID
        • NAME

        searchString

          Location: query

          Type: string

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".

        profileId

          Format: int64

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

          Location: path

        active

          Type: boolean

          Description: Select only active ads.

          Location: query

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.ads.update

      Path: userprofiles/{profileId}/ads

      Description: Updates an existing ad.

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Location: path

          Description: User profile ID associated with this request.

          Type: string

      HTTP Method: PUT

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Flat Path: userprofiles/{profileId}/ads

  • dfareporting.ads.insert

      Path: userprofiles/{profileId}/ads

      Parameters:

        profileId

          Required: Yes

          Type: string

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

      Parameter Order: profileId

      Description: Inserts a new ad.

      Flat Path: userprofiles/{profileId}/ads

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.ads.get

      Description: Gets one ad by ID.

      Path: userprofiles/{profileId}/ads/{id}

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/ads/{id}

      Parameters:

        profileId

          Format: int64

          Location: path

          Description: User profile ID associated with this request.

          Type: string

          Required: Yes

        id

          Required: Yes

          Type: string

          Location: path

          Description: Ad ID.

          Format: int64

  • dfareporting.advertiserGroups.delete

      Parameters:

        id

          Description: Advertiser group ID.

          Format: int64

          Required: Yes

          Location: path

          Type: string

        profileId

          Format: int64

          Required: Yes

          Location: path

          Type: string

          Description: User profile ID associated with this request.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/advertiserGroups/{id}

      HTTP Method: DELETE

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/advertiserGroups/{id}

      Description: Deletes an existing advertiser group.

  • dfareporting.advertiserGroups.get

      Parameter Order:

    • profileId
    • id
    • Description: Gets one advertiser group by ID.

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/advertiserGroups/{id}

      Parameters:

        id

          Required: Yes

          Location: path

          Type: string

          Format: int64

          Description: Advertiser group ID.

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Format: int64

          Type: string

          Required: Yes

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/advertiserGroups/{id}

  • dfareporting.advertiserGroups.update

      HTTP Method: PUT

      Parameter Order: profileId

      Description: Updates an existing advertiser group.

      Parameters:

        profileId

          Location: path

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

      Flat Path: userprofiles/{profileId}/advertiserGroups

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/advertiserGroups

  • dfareporting.advertiserGroups.list

      Path: userprofiles/{profileId}/advertiserGroups

      Parameters:

        sortField

          Location: query

          Description: Field by which to sort the list.

          Enum Descriptions:

        • Enum:

        • ID
        • NAME
        • Default: ID

          Type: string

        sortOrder

          Description: Order of sorted results.

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING
        • Type: string

          Location: query

          Default: ASCENDING

        maxResults

          Description: Maximum number of results to return.

          Type: integer

          Location: query

          Maximum: 1000

          Minimum: 0

          Default: 1000

          Format: int32

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

          Format: int64

          Location: path

        pageToken

          Description: Value of the nextPageToken from the previous result page.

          Location: query

          Type: string

        searchString

          Location: query

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".

          Type: string

        ids

          Location: query

          Repeated: Yes

          Type: string

          Format: int64

          Description: Select only advertiser groups with these IDs.

      Flat Path: userprofiles/{profileId}/advertiserGroups

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

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: GET

      Parameter Order: profileId

  • dfareporting.advertiserGroups.patch

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/advertiserGroups

      Parameters:

        profileId

          Required: Yes

          Format: int64

          Type: string

          Location: path

          Description: User profile ID associated with this request.

        id

          Type: string

          Required: Yes

          Location: query

          Description: AdvertiserGroup ID.

          Format: int64

      Parameter Order:

    • profileId
    • id
    • HTTP Method: PATCH

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

      Flat Path: userprofiles/{profileId}/advertiserGroups

  • dfareporting.advertiserGroups.insert

      Flat Path: userprofiles/{profileId}/advertiserGroups

      Parameters:

        profileId

          Location: path

          Description: User profile ID associated with this request.

          Type: string

          Required: Yes

          Format: int64

      Parameter Order: profileId

      Path: userprofiles/{profileId}/advertiserGroups

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Description: Inserts a new advertiser group.

  • dfareporting.userRolePermissionGroups.list

      Parameters:

        profileId

          Location: path

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

          Required: Yes

      Parameter Order: profileId

      Description: Gets a list of all supported user role permission groups.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/userRolePermissionGroups

      Path: userprofiles/{profileId}/userRolePermissionGroups

  • dfareporting.userRolePermissionGroups.get

      Path: userprofiles/{profileId}/userRolePermissionGroups/{id}

      Description: Gets one user role permission group by ID.

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/userRolePermissionGroups/{id}

      HTTP Method: GET

      Parameters:

        profileId

          Format: int64

          Location: path

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

        id

          Required: Yes

          Type: string

          Location: path

          Description: User role permission group ID.

          Format: int64

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.targetableRemarketingLists.get

      Description: Gets one remarketing list by ID.

      Path: userprofiles/{profileId}/targetableRemarketingLists/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        id

          Format: int64

          Description: Remarketing list ID.

          Type: string

          Location: path

          Required: Yes

        profileId

          Type: string

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

      Flat Path: userprofiles/{profileId}/targetableRemarketingLists/{id}

  • dfareporting.targetableRemarketingLists.list

      Parameter Order:

    • profileId
    • advertiserId
    • Path: userprofiles/{profileId}/targetableRemarketingLists

      HTTP Method: GET

      Parameters:

        maxResults

          Type: integer

          Format: int32

          Location: query

          Maximum: 1000

          Default: 1000

          Description: Maximum number of results to return.

          Minimum: 0

        advertiserId

          Type: string

          Format: int64

          Location: query

          Required: Yes

          Description: Select only targetable remarketing lists targetable by these advertisers.

        name

          Location: query

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".

          Type: string

        active

          Type: boolean

          Location: query

          Description: Select only active or only inactive targetable remarketing lists.

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Format: int64

          Type: string

          Location: path

        sortOrder

          Enum Descriptions:

        • Type: string

          Default: ASCENDING

          Location: query

          Description: Order of sorted results.

          Enum:

        • ASCENDING
        • DESCENDING

        sortField

          Enum Descriptions:

        • Type: string

          Description: Field by which to sort the list.

          Default: ID

          Location: query

          Enum:

        • ID
        • NAME

      Description: Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/targetableRemarketingLists

  • dfareporting.postalCodes.list

      Path: userprofiles/{profileId}/postalCodes

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Flat Path: userprofiles/{profileId}/postalCodes

      Parameter Order: profileId

      HTTP Method: GET

      Description: Retrieves a list of postal codes.

      Parameters:

        profileId

          Type: string

          Required: Yes

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

  • dfareporting.postalCodes.get

      Flat Path: userprofiles/{profileId}/postalCodes/{code}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • code
    • Parameters:

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Location: path

          Required: Yes

          Format: int64

        code

          Location: path

          Type: string

          Required: Yes

          Description: Postal code ID.

      HTTP Method: GET

      Description: Gets one postal code by ID.

      Path: userprofiles/{profileId}/postalCodes/{code}

  • dfareporting.operatingSystemVersions.get

      Parameters:

        profileId

          Location: path

          Required: Yes

          Format: int64

          Type: string

          Description: User profile ID associated with this request.

        id

          Required: Yes

          Format: int64

          Description: Operating system version ID.

          Location: path

          Type: string

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/operatingSystemVersions/{id}

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

      Description: Gets one operating system version by ID.

      Flat Path: userprofiles/{profileId}/operatingSystemVersions/{id}

  • dfareporting.operatingSystemVersions.list

      Flat Path: userprofiles/{profileId}/operatingSystemVersions

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/operatingSystemVersions

      Parameter Order: profileId

      Description: Retrieves a list of operating system versions.

      HTTP Method: GET

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Type: string

          Format: int64

          Location: path

          Required: Yes

  • dfareporting.creativeAssets.insert

      Parameters:

        advertiserId

          Location: path

          Required: Yes

          Format: int64

          Type: string

          Description: Advertiser ID of this creative. This is a required field.

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Type: string

          Required: Yes

          Location: path

      Parameter Order:

    • profileId
    • advertiserId
    • Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: POST

      Supportsmediaupload: Yes

      Mediaupload:

        Accept: */*

        Protocols:

          Simple:

            Path: /upload/dfareporting/v3.4/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets

            Multipart: Yes

        Maxsize: 1073741824

      Path: userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets

      Description: Inserts a new creative asset.

      Flat Path: userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets

  • dfareporting.accounts.list

      Flat Path: userprofiles/{profileId}/accounts

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

      Parameters:

        sortField

          Type: string

          Enum Descriptions:

        • Description: Field by which to sort the list.

          Location: query

          Default: ID

          Enum:

        • ID
        • NAME

        searchString

          Type: string

          Description: Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".

          Location: query

        profileId

          Required: Yes

          Location: path

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

        sortOrder

          Default: ASCENDING

          Location: query

          Enum:

        • ASCENDING
        • DESCENDING
        • Type: string

          Description: Order of sorted results.

          Enum Descriptions:

        maxResults

          Description: Maximum number of results to return.

          Default: 1000

          Location: query

          Minimum: 0

          Maximum: 1000

          Format: int32

          Type: integer

        ids

          Repeated: Yes

          Location: query

          Format: int64

          Type: string

          Description: Select only accounts with these IDs.

        pageToken

          Location: query

          Description: Value of the nextPageToken from the previous result page.

          Type: string

        active

          Type: boolean

          Description: Select only active accounts. Don't set this field to select both active and non-active accounts.

          Location: query

      Path: userprofiles/{profileId}/accounts

      Parameter Order: profileId

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.accounts.patch

      Parameters:

        id

          Type: string

          Format: int64

          Required: Yes

          Description: Account ID.

          Location: query

        profileId

          Type: string

          Required: Yes

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

      Description: Updates an existing account. This method supports patch semantics.

      HTTP Method: PATCH

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/accounts

      Flat Path: userprofiles/{profileId}/accounts

      Scopes: https://www.googleapis.com/auth/dfatrafficking

  • dfareporting.accounts.get

      Path: userprofiles/{profileId}/accounts/{id}

      Description: Gets one account by ID.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Format: int64

          Required: Yes

          Type: string

          Location: path

        id

          Format: int64

          Required: Yes

          Type: string

          Location: path

          Description: Account ID.

      Flat Path: userprofiles/{profileId}/accounts/{id}

      Parameter Order:

    • profileId
    • id
    • HTTP Method: GET

  • dfareporting.accounts.update

      Parameter Order: profileId

      Description: Updates an existing account.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/accounts

      Parameters:

        profileId

          Type: string

          Description: User profile ID associated with this request.

          Required: Yes

          Location: path

          Format: int64

      Flat Path: userprofiles/{profileId}/accounts

      HTTP Method: PUT

  • dfareporting.campaigns.insert

      Parameter Order: profileId

      Description: Inserts a new campaign.

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Path: userprofiles/{profileId}/campaigns

      HTTP Method: POST

      Flat Path: userprofiles/{profileId}/campaigns

      Parameters:

        profileId

          Location: path

          Format: int64

          Description: User profile ID associated with this request.

          Type: string

          Required: Yes

  • dfareporting.campaigns.update

      Flat Path: userprofiles/{profileId}/campaigns

      Parameters:

        profileId

          Description: User profile ID associated with this request.

          Required: Yes

          Type: string

          Format: int64

          Location: path

      Parameter Order: profileId

      Path: userprofiles/{profileId}/campaigns

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: PUT

      Description: Updates an existing campaign.

  • dfareporting.campaigns.patch

      Description: Updates an existing campaign. This method supports patch semantics.

      Parameter Order:

    • profileId
    • id
    • Path: userprofiles/{profileId}/campaigns

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameters:

        id

          Type: string

          Description: Campaign ID.

          Format: int64

          Required: Yes

          Location: query

        profileId

          Description: User profile ID associated with this request.

          Location: path

          Required: Yes

          Type: string

          Format: int64

      Flat Path: userprofiles/{profileId}/campaigns

      HTTP Method: PATCH

  • dfareporting.campaigns.list

      Path: userprofiles/{profileId}/campaigns

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order: profileId

      Parameters:

        subaccountId

          Description: Select only campaigns that belong to this subaccount.

          Location: query

          Format: int64

          Type: string

        advertiserGroupIds

          Repeated: Yes

          Description: Select only campaigns whose advertisers belong to these advertiser groups.

          Format: int64

          Type: string

          Location: query

        searchString

          Location: query

          Type: string

          Description: Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".

        maxResults

          Format: int32

          Description: Maximum number of results to return.

          Default: 1000

          Location: query

          Maximum: 1000

          Minimum: 0

          Type: integer

        sortOrder

          Description: Order of sorted results.

          Type: string

          Default: ASCENDING

          Location: query

          Enum Descriptions:

        • Enum:

        • ASCENDING
        • DESCENDING

        archived

          Type: boolean

          Location: query

          Description: Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.

        overriddenEventTagId

          Location: query

          Description: Select only campaigns that have overridden this event tag ID.

          Type: string

          Format: int64

        profileId

          Required: Yes

          Location: path

          Type: string

          Format: int64

          Description: User profile ID associated with this request.

        ids

          Location: query

          Format: int64

          Type: string

          Repeated: Yes

          Description: Select only campaigns with these IDs.

        atLeastOneOptimizationActivity

          Description: Select only campaigns that have at least one optimization activity.

          Location: query

          Type: boolean

        excludedIds

          Type: string

          Format: int64

          Location: query

          Repeated: Yes

          Description: Exclude campaigns with these IDs.

        sortField

          Enum Descriptions:

        • Description: Field by which to sort the list.

          Location: query

          Default: ID

          Enum:

        • ID
        • NAME
        • Type: string

        advertiserIds

          Type: string

          Repeated: Yes

          Format: int64

          Description: Select only campaigns that belong to these advertisers.

          Location: query

        pageToken

          Type: string

          Description: Value of the nextPageToken from the previous result page.

          Location: query

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

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/campaigns

  • dfareporting.campaigns.get

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      HTTP Method: GET

      Description: Gets one campaign by ID.

      Parameters:

        id

          Format: int64

          Description: Campaign ID.

          Location: path

          Required: Yes

          Type: string

        profileId

          Required: Yes

          Type: string

          Location: path

          Description: User profile ID associated with this request.

          Format: int64

      Path: userprofiles/{profileId}/campaigns/{id}

      Parameter Order:

    • profileId
    • id
    • Flat Path: userprofiles/{profileId}/campaigns/{id}

  • dfareporting.accountPermissions.get

      HTTP Method: GET

      Flat Path: userprofiles/{profileId}/accountPermissions/{id}

      Path: userprofiles/{profileId}/accountPermissions/{id}

      Scopes: https://www.googleapis.com/auth/dfatrafficking

      Parameter Order:

    • profileId
    • id
    • Description: Gets one account permission by ID.

      Parameters:

        profileId

          Format: int64

          Type: string

          Location: path

          Description: User profile ID associated with this request.

          Required: Yes

        id

          Format: int64

          Description: Account permission ID.

          Type: string

          Required: Yes

          Location: path

  • dfareporting.accountPermissions.list

      HTTP Method: GET

      Path: userprofiles/{profileId}/accountPermissions

      Parameter Order: